AgentsforBedrock / Client / prepare_agent

prepare_agent#

AgentsforBedrock.Client.prepare_agent(**kwargs)#

Creates a DRAFT version of the agent that can be used for internal testing.

See also: AWS API Documentation

Request Syntax

response = client.prepare_agent(
    agentId='string'
)
Parameters:

agentId (string) –

[REQUIRED]

The unique identifier of the agent for which to create a DRAFT version.

Return type:

dict

Returns:

Response Syntax

{
    'agentId': 'string',
    'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING',
    'agentVersion': 'string',
    'preparedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • agentId (string) –

      The unique identifier of the agent for which the DRAFT version was created.

    • agentStatus (string) –

      The status of the DRAFT version and whether it is ready for use.

    • agentVersion (string) –

      The version of the agent.

    • preparedAt (datetime) –

      The time at which the DRAFT version of the agent was last prepared.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException

  • AgentsforBedrock.Client.exceptions.ResourceNotFoundException

  • AgentsforBedrock.Client.exceptions.ConflictException

  • AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException