list_agents `async` ¶

list_agents(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional[ListAgentsRequestMaxResultsInteger] = None,
    next_token: Optional[str] = None,
) -> ListAgentsResponse

Lists all agents in an Amazon QuickSight account.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the agents.
max_results (Optional[ListAgentsRequestMaxResultsInteger], default: None ) –

The maximum number of results to return.
next_token (Optional[str], default: None ) –

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

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
InternalFailureException –

An internal failure occurred.
InvalidNextTokenException –

The NextToken value isn't valid.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
PreconditionNotMetException –

One or more preconditions aren't met.
ThrottlingException –

Access is throttled.
UnsupportedUserEditionException –

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def list_agents(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional[
        "capo_quicksight.types.list_agents_request_max_results_integer.ListAgentsRequestMaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_quicksight.types.list_agents_response.ListAgentsResponse":
    """<p>Lists all agents in an Amazon QuickSight account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the agents.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.list_agents_request.ListAgentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_agents_response.ListAgentsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_agents

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.list_agents.async_list_agents(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAgents")
    )
    input_: capo_quicksight.types.list_agents_request.ListAgentsRequest = {
        "aws_account_id": aws_account_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_agents async ¶

list_agents `async` ¶