QuickSight / Client / describe_limits_profile

describe_limits_profile¶

QuickSight.Client.describe_limits_profile(**kwargs)¶

Describes the properties of an existing limits profile.

Request Syntax

response = client.describe_limits_profile(
    profileId='string',
    accountId='string'
)

Parameters:

profileId (string) –
[REQUIRED]

The unique identifier for the limits profile.
accountId (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'profile': {
        '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)
    }
}

Response Structure

(dict) –
- profile (dict) –
  
  The details of the requested limits profile, including its name, description, resource limits, and metadata.
  - 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.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException