Skip to content

Bedrock AgentCore Control  >  Operations  >  delete_gateway

delete_gateway

Operation

delete_gateway async 

delete_gateway(input: DeleteGatewayInput, plugins: list[Plugin] | None = None) -> DeleteGatewayOutput

Deletes a gateway.

Parameters:

Name Type Description Default
input DeleteGatewayInput

An instance of DeleteGatewayInput.

 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
DeleteGatewayOutput

An instance of DeleteGatewayOutput.

Input

DeleteGatewayInput dataclass

Dataclass for DeleteGatewayInput structure.

Attributes

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

The identifier of the gateway to delete.

Output

DeleteGatewayOutput dataclass

Dataclass for DeleteGatewayOutput structure.

Attributes

gateway_id instance-attribute 
gateway_id: str

The unique identifier of the deleted 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 deletion.

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

The reasons for the current status of the gateway deletion.