AgentsforBedrock / Client / delete_agent_alias

delete_agent_alias#

AgentsforBedrock.Client.delete_agent_alias(**kwargs)#

Deletes an Alias for a Amazon Bedrock Agent

See also: AWS API Documentation

Request Syntax

response = client.delete_agent_alias(
    agentId='string',
    agentAliasId='string'
)
Parameters:
  • agentId (string) –

    [REQUIRED]

    Id generated at the server side when an Agent is created

  • agentAliasId (string) –

    [REQUIRED]

    Id generated at the server side when an Agent Alias is created

Return type:

dict

Returns:

Response Syntax

{
    'agentId': 'string',
    'agentAliasId': 'string',
    'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING'
}

Response Structure

  • (dict) –

    Delete Agent Alias Response

    • agentId (string) –

      Identifier for a resource.

    • agentAliasId (string) –

      Id for an Agent Alias generated at the server side.

    • agentAliasStatus (string) –

      The statuses an Agent Alias can be in.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException

  • AgentsforBedrock.Client.exceptions.ResourceNotFoundException