Skip to content

list_namespaces

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

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to list.

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

    A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

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

    The maximum number of results to return.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_namespaces(
    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_namespaces_response.ListNamespacesResponse":
    """<p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>

    Args:
        aws_account_id: <p>The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to list.</p>
        next_token: <p>A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
        max_results: <p>The maximum number of results to return.</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.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.resource_unavailable_exception.ResourceUnavailableException: <p>This resource is currently unavailable.</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_namespaces_request.ListNamespacesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_namespaces_response.ListNamespacesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_namespaces

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNamespaces")
    )
    input_: capo_quicksight.types.list_namespaces_request.ListNamespacesRequest = {
        "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