list_publishing_destinations¶
Operation¶
list_publishing_destinations
¶
list_publishing_destinations(request: ListPublishingDestinationsInput | ListPublishingDestinationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPublishingDestinationsInputDict]) -> ListPublishingDestinationsOutput
Returns a list of publishing destinations associated with the specified
detectorId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListPublishingDestinationsInput | ListPublishingDestinationsInputDict | 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[ListPublishingDestinationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPublishingDestinationsOutput
|
An instance of |
list_publishing_destinations
async
¶
list_publishing_destinations(request: ListPublishingDestinationsInput | ListPublishingDestinationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPublishingDestinationsInputDict]) -> ListPublishingDestinationsOutput
Returns a list of publishing destinations associated with the specified
detectorId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListPublishingDestinationsInput | ListPublishingDestinationsInputDict | 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[ListPublishingDestinationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPublishingDestinationsOutput
|
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.
ListPublishingDestinationsInputDict
¶
Bases: TypedDict
Dictionary form of ListPublishingDestinationsInput.
Attributes¶
detector_id
instance-attribute
¶
The detector ID for which you want to retrieve the publishing destination.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in the response.
next_token
instance-attribute
¶
next_token: str | None
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from
the previous request to continue listing results after the first page.
ListPublishingDestinationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListPublishingDestinationsInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = ...
The detector ID for which you want to retrieve the publishing destination.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in the response.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from
the previous request to continue listing results after the first page.
Output¶
ListPublishingDestinationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListPublishingDestinationsOutput structure.
Attributes¶
destinations
class-attribute
instance-attribute
¶
destinations: list[Destination] | None = ...
A Destinations object that includes information about each publishing
destination returned.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from
the previous request to continue listing results after the first page.
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.