describe_publishing_destination¶
Operation¶
describe_publishing_destination
¶
describe_publishing_destination(request: DescribePublishingDestinationInput | DescribePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePublishingDestinationInputDict]) -> DescribePublishingDestinationOutput
Returns information about the publishing destination specified by the
provided destinationId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribePublishingDestinationInput | DescribePublishingDestinationInputDict | 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[DescribePublishingDestinationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribePublishingDestinationOutput
|
An instance of |
describe_publishing_destination
async
¶
describe_publishing_destination(request: DescribePublishingDestinationInput | DescribePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePublishingDestinationInputDict]) -> DescribePublishingDestinationOutput
Returns information about the publishing destination specified by the
provided destinationId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribePublishingDestinationInput | DescribePublishingDestinationInputDict | 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[DescribePublishingDestinationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribePublishingDestinationOutput
|
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.
DescribePublishingDestinationInputDict
¶
Bases: TypedDict
Dictionary form of DescribePublishingDestinationInput.
Attributes¶
destination_id
instance-attribute
¶
The ID of the publishing destination to retrieve.
detector_id
instance-attribute
¶
The unique ID of the detector associated with the publishing destination to retrieve.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
DescribePublishingDestinationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribePublishingDestinationInput structure.
Attributes¶
destination_id
class-attribute
instance-attribute
¶
destination_id: str | None = ...
The ID of the publishing destination to retrieve.
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = ...
The unique ID of the detector associated with the publishing destination to retrieve.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
Output¶
DescribePublishingDestinationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribePublishingDestinationOutput structure.
Attributes¶
destination_id
class-attribute
instance-attribute
¶
destination_id: str | None = ...
The ID of the publishing destination.
destination_properties
class-attribute
instance-attribute
¶
destination_properties: DestinationProperties | None = ...
A DestinationProperties object that includes the DestinationArn and
KmsKeyArn of the publishing destination.
destination_type
class-attribute
instance-attribute
¶
destination_type: str | None = ...
The type of publishing destination. Currently, only Amazon S3 buckets are supported.
publishing_failure_start_timestamp
class-attribute
instance-attribute
¶
publishing_failure_start_timestamp: int | None = ...
The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
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.