Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateLimitsProfile

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

Request Syntax


POST /governance/limits/accounts/AccountId/profiles HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "ProfileName": "string",
   "ResourceLimits": { 
      "string" : { 
         "MaxValue": number,
         "Unit": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

AccountId

The ID of the AWS account that contains the limits profile.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

ProfileName

A display name for the limits profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

ResourceLimits

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

Type: String to ProfileLimitValue object map

Map Entries: Maximum number of items.

Valid Keys: INDEX_STORAGE | AGENT_HOURS

Required: Yes

Description

A description for the limits profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ProfileId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

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

Type: String

ProfileId

The unique identifier for the created limits profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: lp-[a-f0-9-]+

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The AWS request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The AWS request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429