AgentsforBedrock / Client / prepare_agent

prepare_agent#

AgentsforBedrock.Client.prepare_agent(**kwargs)#

Prepares an existing Amazon Bedrock Agent to receive runtime requests

Request Syntax

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

Parameters:

agentId (string) –

[REQUIRED]

Id generated at the server side when an Agent is created

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) –

PrepareAgent Response
- agentId (string) –
  
  Identifier for a resource.
- agentStatus (string) –
  
  Schema Type for Action APIs.
- agentVersion (string) –
  
  Agent Version.
- preparedAt (datetime) –
  
  Time Stamp.

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