limits_profiles

Creates, updates, deletes, gets or lists a limits_profiles resource.

Overview

Name	limits_profiles
Type	Resource
Id	aws.quicksight.limits_profiles

Fields

The following fields are returned by SELECT queries:

describe_limits_profile

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account that contains the limits profile. (pattern: <code>^[0-9]{12}$</code>)
arn	string	The Amazon Resource Name (ARN) of the limits profile.
created_at	string (date-time)	The date and time that the limits profile was created.
description	string	The description of the limits profile.
profile_id	string	The unique identifier for the limits profile. (pattern: <code>lp-[a-f0-9-]+</code>)
profile_name	string	The display name of the limits profile.
resource_limits	object	A map of resource types to their limit values.
updated_at	string (date-time)	The date and time that the limits profile was last updated.

list_limits_profiles

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account that contains the limits profile. (pattern: <code>^[0-9]{12}$</code>)
arn	string	The Amazon Resource Name (ARN) of the limits profile.
created_at	string (date-time)	The date and time that the limits profile was created.
description	string	The description of the limits profile.
profile_id	string	The unique identifier for the limits profile. (pattern: <code>lp-[a-f0-9-]+</code>)
profile_name	string	The display name of the limits profile.
resource_limits	object	A map of resource types to their limit values.
updated_at	string (date-time)	The date and time that the limits profile was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_limits_profile	select	profile_id, account_id, region		Describes the properties of an existing limits profile.
list_limits_profiles	select	account_id, region	resourceType, maxResults, nextToken	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.
create_limits_profile	insert	account_id, region, profileName, resourceLimits, clientToken		Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.
update_limits_profile	update	profile_id, account_id, region		Updates the properties of an existing limits profile.
delete_limits_profile	delete	profile_id, account_id, region		Deletes a limits profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account that contains the limits profile.
profile_id	string	The unique identifier for the limits profile to delete.
region	string	AWS region (default: us-east-1)
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.
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.

SELECT examples

describe_limits_profile

Describes the properties of an existing limits profile.

SELECT
account_id,
arn,
created_at,
description,
profile_id,
profile_name,
resource_limits,
updated_at
FROM aws.quicksight.limits_profiles
WHERE profile_id = '{{ profile_id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_limits_profiles

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.

SELECT
account_id,
arn,
created_at,
description,
profile_id,
profile_name,
resource_limits,
updated_at
FROM aws.quicksight.limits_profiles
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
AND resourceType = '{{ resourceType }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_limits_profile

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

INSERT INTO aws.quicksight.limits_profiles (
profileName,
description,
resourceLimits,
clientToken,
account_id,
region
)
SELECT 
'{{ profileName }}' /* required */,
'{{ description }}',
'{{ resourceLimits }}' /* required */,
'{{ clientToken }}' /* required */,
'{{ account_id }}',
'{{ region }}'
RETURNING
arn,
profile_id
;

Manifest

# Description fields are for documentation purposes
- name: limits_profiles
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the limits_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the limits_profiles resource.
  - name: profileName
    value: "{{ profileName }}"
  - name: description
    value: "{{ description }}"
  - name: resourceLimits
    value: "{{ resourceLimits }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_limits_profile

Updates the properties of an existing limits profile.

UPDATE aws.quicksight.limits_profiles
SET 
profileName = '{{ profileName }}',
description = '{{ description }}',
resourceLimits = '{{ resourceLimits }}'
WHERE 
profile_id = '{{ profile_id }}' --required
AND account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn;

DELETE examples

delete_limits_profile

Deletes a limits profile.

DELETE FROM aws.quicksight.limits_profiles
WHERE profile_id = '{{ profile_id }}' --required
AND account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
;