Skip to content

describe_dashboard_permissions async

describe_dashboard_permissions(
    aws_account_id: AwsAccountId,
    dashboard_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DescribeDashboardPermissionsResponse

Describes read and write permissions for a dashboard.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.

  • dashboard_id (ShortRestrictiveResourceId) –

    The ID for the dashboard, also added to the IAM policy.

Raises:

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
async def describe_dashboard_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    dashboard_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_dashboard_permissions_response.DescribeDashboardPermissionsResponse":
    """<p>Describes read and write permissions for a dashboard.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.</p>
        dashboard_id: <p>The ID for the dashboard, also added to the IAM policy.</p>

    Raises:
        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_dashboard_permissions_request.DescribeDashboardPermissionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_dashboard_permissions_response.DescribeDashboardPermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_dashboard_permissions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDashboardPermissions")
    )
    input_: capo_quicksight.types.describe_dashboard_permissions_request.DescribeDashboardPermissionsRequest = {
        "aws_account_id": aws_account_id,
        "dashboard_id": dashboard_id,
    }

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