Skip to content

update_publishing_destination

Operation

update_publishing_destination

update_publishing_destination(request: UpdatePublishingDestinationInput | UpdatePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePublishingDestinationInputDict]) -> UpdatePublishingDestinationOutput

Updates information about the publishing destination specified by the destinationId.

Parameters:

Name Type Description Default
request UpdatePublishingDestinationInput | UpdatePublishingDestinationInputDict | 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[UpdatePublishingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePublishingDestinationOutput

An instance of UpdatePublishingDestinationOutput.

update_publishing_destination async

update_publishing_destination(request: UpdatePublishingDestinationInput | UpdatePublishingDestinationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdatePublishingDestinationInputDict]) -> UpdatePublishingDestinationOutput

Updates information about the publishing destination specified by the destinationId.

Parameters:

Name Type Description Default
request UpdatePublishingDestinationInput | UpdatePublishingDestinationInputDict | 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[UpdatePublishingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdatePublishingDestinationOutput

An instance of UpdatePublishingDestinationOutput.

Input

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

UpdatePublishingDestinationInputDict

Bases: TypedDict

Dictionary form of UpdatePublishingDestinationInput.

Attributes

destination_id instance-attribute
destination_id: Required[str]

The ID of the publishing destination to update.

destination_properties instance-attribute
destination_properties: DestinationProperties | DestinationPropertiesDict | None

A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

detector_id instance-attribute
detector_id: Required[str]

The ID of the detector associated with the publishing destinations to update.

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

UpdatePublishingDestinationInput dataclass

Bases: _SerdeShape

Dataclass for UpdatePublishingDestinationInput structure.

Attributes

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

The ID of the publishing destination to update.

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

A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

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

The ID of the detector associated with the publishing destinations to update.

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

Output

UpdatePublishingDestinationOutput dataclass

Bases: _SerdeShape

Dataclass for UpdatePublishingDestinationOutput structure.

Attributes

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.