BedrockAgentCoreControl / Client / delete_gateway

delete_gateway¶

BedrockAgentCoreControl.Client.delete_gateway(**kwargs)¶

Deletes a gateway.

Request Syntax

response = client.delete_gateway(
    gatewayIdentifier='string'
)

Parameters:

gatewayIdentifier (string) –

[REQUIRED]

The identifier of the gateway to delete.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'status': 'CREATING'|'UPDATING'|'UPDATE_UNSUCCESSFUL'|'DELETING'|'READY'|'FAILED',
    'statusReasons': [
        'string',
    ]
}

Response Structure

(dict) –
- gatewayId (string) –
  
  The unique identifier of the deleted gateway.
- status (string) –
  
  The current status of the gateway deletion.
- statusReasons (list) –
  
  The reasons for the current status of the gateway deletion.
  - (string) –

Exceptions

BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException