Skip to content

delete_gateway_target

Operation

delete_gateway_target

delete_gateway_target(request: DeleteGatewayTargetInput | DeleteGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayTargetInputDict]) -> DeleteGatewayTargetOutput

Deletes a gateway target.

You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.

Parameters:

Name Type Description Default
request DeleteGatewayTargetInput | DeleteGatewayTargetInputDict | 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[DeleteGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayTargetOutput

An instance of DeleteGatewayTargetOutput.

delete_gateway_target async

delete_gateway_target(request: DeleteGatewayTargetInput | DeleteGatewayTargetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayTargetInputDict]) -> DeleteGatewayTargetOutput

Deletes a gateway target.

You cannot delete a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before deleting the target.

Parameters:

Name Type Description Default
request DeleteGatewayTargetInput | DeleteGatewayTargetInputDict | 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[DeleteGatewayTargetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayTargetOutput

An instance of DeleteGatewayTargetOutput.

Input

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

DeleteGatewayTargetInputDict

Bases: TypedDict

Dictionary form of DeleteGatewayTargetInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The unique identifier of the gateway associated with the target.

target_id instance-attribute
target_id: Required[str]

The unique identifier of the gateway target to delete.

DeleteGatewayTargetInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayTargetInput structure.

Attributes

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

The unique identifier of the gateway associated with the target.

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

The unique identifier of the gateway target to delete.

Output

DeleteGatewayTargetOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayTargetOutput structure.

Attributes

gateway_arn instance-attribute
gateway_arn: str

The Amazon Resource Name (ARN) of the gateway.

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.

status instance-attribute
status: str

The current status of the gateway target deletion.

status_reasons class-attribute instance-attribute
status_reasons: list[str] | None = ...

The reasons for the current status of the gateway target deletion.

target_id instance-attribute
target_id: str

The unique identifier of the deleted gateway target.