describe_folder_permissions `async` ¶

describe_folder_permissions(
    aws_account_id: AwsAccountId,
    folder_id: RestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    namespace: Optional[Namespace] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
) -> DescribeFolderPermissionsResponse

Describes permissions for a folder.

Parameters:

aws_account_id (AwsAccountId) –

The ID for the Amazon Web Services account that contains the folder.
folder_id (RestrictiveResourceId) –

The ID of the folder.
namespace (Optional[Namespace], default: None ) –

The namespace of the folder whose permissions you want described.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to be returned per request.
next_token (Optional[String], default: None ) –

A pagination token for the next set of 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.
ResourceNotFoundException –

One or more resources can't be found.
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 describe_folder_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    folder_id: "capo_quicksight.types.restrictive_resource_id.RestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    namespace: Optional["capo_quicksight.types.namespace.Namespace"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
) -> "capo_quicksight.types.describe_folder_permissions_response.DescribeFolderPermissionsResponse":
    """<p>Describes permissions for a folder.</p>

    Args:
        aws_account_id: <p>The ID for the Amazon Web Services account that contains the folder.</p>
        folder_id: <p>The ID of the folder.</p>
        namespace: <p>The namespace of the folder whose permissions you want described.</p>
        max_results: <p>The maximum number of results to be returned per request.</p>
        next_token: <p>A pagination token for the next set of 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.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.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.describe_folder_permissions_request.DescribeFolderPermissionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_folder_permissions_response.DescribeFolderPermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_folder_permissions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFolderPermissions")
    )
    input_: capo_quicksight.types.describe_folder_permissions_request.DescribeFolderPermissionsRequest = {
        "aws_account_id": aws_account_id,
        "folder_id": folder_id,
    }
    if namespace is not None:
        input_["namespace"] = namespace
    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

describe_folder_permissions async ¶

describe_folder_permissions `async` ¶