Skip to content

describe_analysis_permissions

describe_analysis_permissions(
    aws_account_id: AwsAccountId,
    analysis_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeAnalysisPermissionsResponse

Provides the read and write permissions for an analysis.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.

  • analysis_id (ShortRestrictiveResourceId) –

    The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def describe_analysis_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    analysis_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_analysis_permissions_response.DescribeAnalysisPermissionsResponse":
    """<p>Provides the read and write permissions for an analysis.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.</p>
        analysis_id: <p>The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.</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.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_analysis_permissions_request.DescribeAnalysisPermissionsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_analysis_permissions_response.DescribeAnalysisPermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_analysis_permissions

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_analysis_permissions.describe_analysis_permissions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAnalysisPermissions")
    )
    input_: capo_quicksight.types.describe_analysis_permissions_request.DescribeAnalysisPermissionsRequest = {
        "aws_account_id": aws_account_id,
        "analysis_id": analysis_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output