Skip to content

describe_template_permissions

describe_template_permissions(
    aws_account_id: AwsAccountId,
    template_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeTemplatePermissionsResponse

Describes read and write permissions on a template.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the template that you're describing.

  • template_id (ShortRestrictiveResourceId) –

    The ID for the template.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def describe_template_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    template_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_template_permissions_response.DescribeTemplatePermissionsResponse":
    """<p>Describes read and write permissions on a template.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
        template_id: <p>The ID for the template.</p>

    Raises:
        capo_quicksight.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</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.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_template_permissions_request.DescribeTemplatePermissionsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_template_permissions_response.DescribeTemplatePermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_template_permissions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTemplatePermissions")
    )
    input_: capo_quicksight.types.describe_template_permissions_request.DescribeTemplatePermissionsRequest = {
        "aws_account_id": aws_account_id,
        "template_id": template_id,
    }

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