QuickSight / Client / create_limits_profile

create_limits_profile

QuickSight.Client.create_limits_profile(**kwargs)

Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.

See also: AWS API Documentation

Request Syntax

response = client.create_limits_profile(
    accountId='string',
    profileName='string',
    description='string',
    resourceLimits={
        'string': {
            'maxValue': 123,
            'unit': 'MB'|'GB'|'HOURS'|'DAYS'
        }
    },
    clientToken='string'
)
Parameters:
  • accountId (string) –

    [REQUIRED]

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

  • profileName (string) –

    [REQUIRED]

    A display name for the limits profile.

  • description (string) – A description for the limits profile.

  • resourceLimits (dict) –

    [REQUIRED]

    A map of resource types to their limit values for this profile.

    • (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) – [REQUIRED]

          The maximum allowed value for the resource.

        • unit (string) – [REQUIRED]

          The unit of measurement for the limit value.

  • clientToken (string) –

    [REQUIRED]

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'profileId': 'string'
}

Response Structure

  • (dict) –

    • arn (string) –

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

    • profileId (string) –

      The unique identifier for the created limits profile.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.ConflictException