describe_folder `async` ¶

describe_folder(
    aws_account_id: AwsAccountId,
    folder_id: RestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DescribeFolderResponse

Describes 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.

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.
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(
    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,
) -> "capo_quicksight.types.describe_folder_response.DescribeFolderResponse":
    """<p>Describes 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>

    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.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_request.DescribeFolderRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_folder_response.DescribeFolderResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_folder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFolder")
    )
    input_: capo_quicksight.types.describe_folder_request.DescribeFolderRequest = {
        "aws_account_id": aws_account_id,
        "folder_id": folder_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_folder async ¶

describe_folder `async` ¶