BedrockAgentCoreControl / Client / list_agent_runtimes

list_agent_runtimes

BedrockAgentCoreControl.Client.list_agent_runtimes(**kwargs)

Lists all Amazon Secure Agents in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_agent_runtimes(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – The maximum number of results to return in the response.

  • nextToken (string) – A token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'agentRuntimes': [
        {
            'agentRuntimeArn': 'string',
            'agentRuntimeId': 'string',
            'agentRuntimeVersion': 'string',
            'agentRuntimeName': 'string',
            'description': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • agentRuntimes (list) –

      The list of AgentCore Runtime resources.

      • (dict) –

        Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

        • agentRuntimeArn (string) –

          The Amazon Resource Name (ARN) of the agent runtime.

        • agentRuntimeId (string) –

          The unique identifier of the agent runtime.

        • agentRuntimeVersion (string) –

          The version of the agent runtime.

        • agentRuntimeName (string) –

          The name of the agent runtime.

        • description (string) –

          The description of the agent runtime.

        • lastUpdatedAt (datetime) –

          The timestamp when the agent runtime was last updated.

        • status (string) –

          The current status of the agent runtime.

    • nextToken (string) –

      A token to retrieve the next page of results.

Exceptions

  • BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

  • BedrockAgentCoreControl.Client.exceptions.ValidationException

  • BedrockAgentCoreControl.Client.exceptions.ThrottlingException

  • BedrockAgentCoreControl.Client.exceptions.InternalServerException