Skip to content

create_publishing_destination

Operation

create_publishing_destination

create_publishing_destination(request: CreatePublishingDestinationInput | CreatePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePublishingDestinationInputDict]) -> CreatePublishingDestinationOutput

Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.

Parameters:

Name Type Description Default
request CreatePublishingDestinationInput | CreatePublishingDestinationInputDict | 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[CreatePublishingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePublishingDestinationOutput

An instance of CreatePublishingDestinationOutput.

create_publishing_destination async

create_publishing_destination(request: CreatePublishingDestinationInput | CreatePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreatePublishingDestinationInputDict]) -> CreatePublishingDestinationOutput

Creates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.

Parameters:

Name Type Description Default
request CreatePublishingDestinationInput | CreatePublishingDestinationInputDict | 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[CreatePublishingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreatePublishingDestinationOutput

An instance of CreatePublishingDestinationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreatePublishingDestinationInputDict

Bases: TypedDict

Dictionary form of CreatePublishingDestinationInput.

Attributes

client_token instance-attribute
client_token: str | None

The idempotency token for the request.

This field is autopopulated if not provided.

destination_properties instance-attribute

The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

destination_type instance-attribute
destination_type: Required[str]

The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

detector_id instance-attribute
detector_id: Required[str]

The ID of the GuardDuty detector associated with the publishing destination.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

tags instance-attribute
tags: Mapping[str, str] | None

The tags to be added to a new publishing destination resource.

CreatePublishingDestinationInput dataclass

Bases: _SerdeShape

Dataclass for CreatePublishingDestinationInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

The idempotency token for the request.

This field is autopopulated if not provided.

destination_properties class-attribute instance-attribute
destination_properties: DestinationProperties | None = ...

The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

destination_type class-attribute instance-attribute
destination_type: str | None = ...

The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

detector_id class-attribute instance-attribute
detector_id: str | None = ...

The ID of the GuardDuty detector associated with the publishing destination.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The tags to be added to a new publishing destination resource.

Output

CreatePublishingDestinationOutput dataclass

Bases: _SerdeShape

Dataclass for CreatePublishingDestinationOutput structure.

Attributes

destination_id class-attribute instance-attribute
destination_id: str | None = ...

The ID of the publishing destination that is created.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.