QuickSight / Client / list_agents

list_agents

QuickSight.Client.list_agents(**kwargs)

Lists all agents in an Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

response = client.list_agents(
    AwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the agents.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'AgentSummaries': [
        {
            'Arn': 'string',
            'AgentId': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'IconId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • AgentSummaries (list) –

      A list of agent summaries.

      • (dict) –

        A summary of an agent, including its identifier, name, and metadata.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the agent.

        • AgentId (string) –

          The unique identifier for the agent.

        • Name (string) –

          The name of the agent.

        • Description (string) –

          A description of the agent.

        • CreatedAt (datetime) –

          The date and time that the agent was created.

        • UpdatedAt (datetime) –

          The date and time that the agent was last updated.

        • IconId (string) –

          The icon identifier for the agent.

    • NextToken (string) –

      The token for the next set of results, or null if there are no more results.

Exceptions