Skip to content

Bedrock AgentCore Control  >  Operations  >  delete_gateway_target

delete_gateway_target

Operation

delete_gateway_target async 

delete_gateway_target(input: DeleteGatewayTargetInput, plugins: list[Plugin] | None = None) -> 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
input DeleteGatewayTargetInput

An instance of DeleteGatewayTargetInput.

 required
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

Returns:

Type Description
DeleteGatewayTargetOutput

An instance of DeleteGatewayTargetOutput.

Input

DeleteGatewayTargetInput dataclass

Dataclass for DeleteGatewayTargetInput structure.

Attributes

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

The unique identifier of the gateway associated with the target.

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

The unique identifier of the gateway target to delete.

Output

DeleteGatewayTargetOutput dataclass

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 = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 = 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.