Skip to content

list_custom_permissions async

list_custom_permissions(
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
) -> ListCustomPermissionsResponse

Returns a list of all the custom permissions profiles.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

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

    The maximum number of results to return.

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

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

Raises:

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
async def list_custom_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
) -> "capo_quicksight.types.list_custom_permissions_response.ListCustomPermissionsResponse":
    """<p>Returns a list of all the custom permissions profiles.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.</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_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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.list_custom_permissions_request.ListCustomPermissionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.list_custom_permissions_response.ListCustomPermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_custom_permissions

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

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