CreateSpace
Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.
Request Syntax
POST /v1/accounts/AwsAccountId/spaces HTTP/1.1
Content-type: application/json
{
"Description": "string",
"Name": "string",
"SpaceId": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the Amazon account that contains the space.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- Name
-
A display name for the space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[\P{C}\n\r\t\f\v\p{Cf}]*Required: Yes
- SpaceId
-
The ID of the space. This ID is unique per Amazon Region for each Amazon account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[0-9a-zA-Z-_=.+]+Required: Yes
- Description
-
A description of the space.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
[\P{C}\n\r\t\f\v\p{Cf}]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"RequestId": "string",
"spaceArn": "string",
"spaceId": "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.
- spaceId
-
The ID of the space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[0-9a-zA-Z-_=.+]+ - RequestId
-
The Amazon request ID for this operation.
Type: String
- spaceArn
-
The ARN of the space.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 512.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
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 Amazon request ID for this request.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
- RequestId
-
The Amazon request ID for this request.
- ResourceType
-
Limit exceeded.
HTTP Status Code: 409
- ResourceExistsException
-
The resource specified already exists.
- RequestId
-
The Amazon request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 409
- ThrottlingException
-
Access is throttled.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: