AgentsforBedrock / Client / delete_agent_alias

delete_agent_alias#

AgentsforBedrock.Client.delete_agent_alias(**kwargs)#

Deletes an alias of an agent.

See also: AWS API Documentation

Request Syntax

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

  • agentAliasId (string) –

    [REQUIRED]

    The unique identifier of the alias to delete.

  • agentId (string) –

    [REQUIRED]

    The unique identifier of the agent that the alias belongs to.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • agentAliasId (string) –

      The unique identifier of the alias that was deleted.

    • agentAliasStatus (string) –

      The status of the alias.

    • agentId (string) –

      The unique identifier of the agent that the alias belongs to.

Exceptions