Skip to content

batch_describe_user_limits

batch_describe_user_limits(
    account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    users: Optional[BatchDescribeUserLimitsRequestUsersList] = None,
    resource_types: Optional[ResourceTypeList] = None,
) -> BatchDescribeUserLimitsResponse

Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.

Parameters:

  • account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the users.

  • users (Optional[BatchDescribeUserLimitsRequestUsersList], default: None ) –

    A list of users to describe limits for. Each entry contains a user name and namespace.

  • resource_types (Optional[ResourceTypeList], default: None ) –

    An optional filter that limits the results to specific resource types. If you don't specify a value, the operation returns limits for all resource types.

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.

  • ThrottlingException –

    Access is throttled.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def batch_describe_user_limits(
    self,
    account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    users: Optional[
        "capo_quicksight.types.batch_describe_user_limits_request_users_list.BatchDescribeUserLimitsRequestUsersList"
    ] = None,
    resource_types: Optional[
        "capo_quicksight.types.resource_type_list.ResourceTypeList"
    ] = None,
) -> "capo_quicksight.types.batch_describe_user_limits_response.BatchDescribeUserLimitsResponse":
    """<p>Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.</p>

    Args:
        account_id: <p>The ID of the Amazon Web Services account that contains the users.</p>
        users: <p>A list of users to describe limits for. Each entry contains a user name and namespace.</p>
        resource_types: <p>An optional filter that limits the results to specific resource types. If you don't specify a value, the operation returns limits for all resource types.</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.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.batch_describe_user_limits_request.BatchDescribeUserLimitsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.batch_describe_user_limits_response.BatchDescribeUserLimitsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.batch_describe_user_limits

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDescribeUserLimits")
    )
    input_: capo_quicksight.types.batch_describe_user_limits_request.BatchDescribeUserLimitsRequest = {
        "account_id": account_id
    }
    if users is not None:
        input_["users"] = users
    if resource_types is not None:
        input_["resource_types"] = resource_types

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