QuickSight / Client / search_agents

search_agents

QuickSight.Client.search_agents(**kwargs)

Searches for agents based on specified filters.

See also: AWS API Documentation

Request Syntax

response = client.search_agents(
    AwsAccountId='string',
    Filters=[
        {
            'Name': 'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'AGENT_NAME',
            'Operator': 'StringEquals'|'StringLike',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • Filters (list) –

    [REQUIRED]

    The filters to apply when searching agents.

    • (dict) –

      A filter to apply when searching agents.

      • Name (string) –

        The name of the field to filter on.

      • Operator (string) –

        The comparison operator to use for the filter.

      • Value (string) –

        The value to filter on.

  • 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

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

Response Structure

  • (dict) –

    • 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.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions