Skip to content

list_topics

list_topics(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> ListTopicsResponse

Lists all of the topics within an account.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the topics that you want to list.

  • next_token (Optional[String], default: None ) –

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

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to be returned per request.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_topics(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
) -> "capo_quicksight.types.list_topics_response.ListTopicsResponse":
    """<p>Lists all of the topics within an account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the topics that you want to list.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>
        max_results: <p>The maximum number of results to be returned per request.</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.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.list_topics_request.ListTopicsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_topics_response.ListTopicsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_topics

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.list_topics.list_topics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output