QuickSight / Client / batch_describe_user_limits

batch_describe_user_limits

QuickSight.Client.batch_describe_user_limits(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_describe_user_limits(
    accountId='string',
    users=[
        {
            'userName': 'string',
            'namespace': 'string'
        },
    ],
    resourceTypes=[
        'INDEX_STORAGE'|'AGENT_HOURS',
    ]
)

Parameters:

• accountId (string) –

  [REQUIRED]

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

• users (list) –

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

  • (dict) –

    Identifies a user for the BatchDescribeUserLimits operation.

    • userName (string) – [REQUIRED]

      The name of the user.

    • namespace (string) – [REQUIRED]

      The namespace of the user.

• resourceTypes (list) –

  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.

  • (string) –

    The type of resource that a limit applies to.

Return type:

dict

Returns:

Response Syntax

{
    'userLimits': [
        {
            'userName': 'string',
            'namespace': 'string',
            'effectiveLimits': [
                {
                    'resourceType': 'INDEX_STORAGE'|'AGENT_HOURS',
                    'limitValue': 123,
                    'limitUnit': 'MB'|'GB'|'HOURS'|'DAYS',
                    'source': 'DIRECT_USER'|'GROUP'|'ROLE'|'ACCOUNT'|'SYSTEM_DEFAULT',
                    'profileId': 'string'
                },
            ]
        },
    ],
    'errors': [
        {
            'userName': 'string',
            'namespace': 'string',
            'userArn': 'string',
            'errorCode': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • userLimits (list) –

    A list of user limits results. Each entry contains the effective limits for a user.

    • (dict) –

      The effective limits for an Amazon Quick Sight user.

      • userName (string) –

        The name of the user.

      • namespace (string) –

        The namespace of the user.

      • effectiveLimits (list) –

        A list of effective limits for the user.

        • (dict) –

          The effective limit for a resource type that applies to a user, considering all applicable profile assignments and inheritance rules.

          • resourceType (string) –

            The type of resource that the limit applies to.

          • limitValue (integer) –

            The maximum allowed value for the resource.

          • limitUnit (string) –

            The unit of measurement for the limit.

          • source (string) –

            The source from which this limit was inherited. Possible values:

            • DIRECT_USER – The limit comes from a profile directly assigned to the user.

            • GROUP – The limit comes from a profile assigned to a group the user belongs to.

            • ROLE – The limit comes from a profile assigned to a role the user has.

            • ACCOUNT – The limit comes from the account-level default profile.

            • SYSTEM_DEFAULT – The limit comes from the built-in system default.

          • profileId (string) –

            The identifier of the limits profile that defines this limit.

  • errors (list) –

    A list of errors for users whose limits could not be described.

    • (dict) –

      Information about a user whose limits could not be described in a batch operation.

      • userName (string) –

        The name of the user that failed.

      • namespace (string) –

        The namespace of the user that failed.

      • userArn (string) –

        The ARN of the user that failed.

      • errorCode (string) –

        The error code for the failure.

      • message (string) –

        The error message for the failure.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.AccessDeniedException