QuickSight / Client / list_limits_profiles

list_limits_profiles

QuickSight.Client.list_limits_profiles(**kwargs)

Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page of results.

See also: AWS API Documentation

Request Syntax

response = client.list_limits_profiles(
    accountId='string',
    resourceType='INDEX_STORAGE'|'AGENT_HOURS',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • accountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the limits profiles.

  • resourceType (string) – An optional filter that limits the results to profiles that contain the specified resource type. If you don’t specify a value, the operation returns all profiles.

  • maxResults (integer) – The maximum number of results to return in a single call. If you don’t specify a value, the service uses the default maximum.

  • nextToken (string) – The token for the next set of results, or null if there are no more results.

Return type:

dict

Returns:

Response Syntax

{
    'profiles': [
        {
            'profileId': 'string',
            'arn': 'string',
            'accountId': 'string',
            'profileName': 'string',
            'description': 'string',
            'resourceLimits': {
                'string': {
                    'maxValue': 123,
                    'unit': 'MB'|'GB'|'HOURS'|'DAYS'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • profiles (list) –

      A list of limits profiles.

      • (dict) –

        A limits profile that defines resource usage limits for Amazon Quick Sight users. Limits profiles can be assigned to users, groups, or roles to control resource consumption.

        • profileId (string) –

          The unique identifier for the limits profile.

        • arn (string) –

          The Amazon Resource Name (ARN) of the limits profile.

        • accountId (string) –

          The ID of the Amazon Web Services account that contains the limits profile.

        • profileName (string) –

          The display name of the limits profile.

        • description (string) –

          The description of the limits profile.

        • resourceLimits (dict) –

          A map of resource types to their limit values.

          • (string) –

            The type of resource that a limit applies to.

            • (dict) –

              A value that defines a resource usage limit, consisting of a maximum value and a unit of measurement.

              • maxValue (integer) –

                The maximum allowed value for the resource.

              • unit (string) –

                The unit of measurement for the limit value.

        • createdAt (datetime) –

          The date and time that the limits profile was created.

        • updatedAt (datetime) –

          The date and time that the limits profile was last updated.

    • nextToken (string) –

      The token for the next set of results, or null if there are no more results.

Exceptions