list_spaces `async` ¶

list_spaces(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[SpacesMaxResults] = None,
) -> ListSpacesResponse

Lists all Amazon QuickSight spaces in an Amazon Web Services account.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that contains the spaces.
next_token (Optional[NextToken], default: None ) –

The token for the next set of results, or null if there are no more results.
max_results (Optional[SpacesMaxResults], default: None ) –

The maximum number of results to return.

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.
InvalidParameterValueException –

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

One or more resources can't be found.
ThrottlingException –

Access is throttled.
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_spaces(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_quicksight.types.spaces_max_results.SpacesMaxResults"
    ] = None,
) -> "capo_quicksight.types.list_spaces_response.ListSpacesResponse":
    """<p>Lists all Amazon QuickSight spaces in an Amazon Web Services account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the spaces.</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 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_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.list_spaces_request.ListSpacesRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_spaces_response.ListSpacesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_spaces

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

    def _redact_output(
        output: "capo_quicksight.types.list_spaces_response.ListSpacesResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.list_spaces_response

        return capo_quicksight.types.list_spaces_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListSpaces", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.list_spaces_request.ListSpacesRequest = {
        "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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_spaces async ¶

list_spaces `async` ¶