AgentsforBedrock / Client / list_agent_action_groups

list_agent_action_groups#

AgentsforBedrock.Client.list_agent_action_groups(**kwargs)#

Lists the action groups for an agent and information about each one.

See also: AWS API Documentation

Request Syntax

response = client.list_agent_action_groups(
    agentId='string',
    agentVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • agentId (string) –

    [REQUIRED]

    The unique identifier of the agent.

  • agentVersion (string) –

    [REQUIRED]

    The version of the agent.

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'actionGroupSummaries': [
        {
            'actionGroupId': 'string',
            'actionGroupName': 'string',
            'actionGroupState': 'ENABLED'|'DISABLED',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • actionGroupSummaries (list) –

      A list of objects, each of which contains information about an action group.

      • (dict) –

        Contains details about an action group.

        • actionGroupId (string) –

          The unique identifier of the action group.

        • actionGroupName (string) –

          The name of the action group.

        • actionGroupState (string) –

          Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

        • description (string) –

          The description of the action group.

        • updatedAt (datetime) –

          The time at which the action group was last updated.

    • nextToken (string) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException

  • AgentsforBedrock.Client.exceptions.ResourceNotFoundException