CreateWorkspaceInstance
Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
Request Parameters
- BillingConfiguration
-
Optional billing configuration for the WorkSpace Instance. Allows customers to specify their preferred billing mode when creating a new instance. Defaults to hourly billing if not specified.
Type: BillingConfiguration object
Required: No
- ClientToken
-
Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\x20-\x7E]+Required: No
- ManagedInstance
-
Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.
Type: ManagedInstanceRequest object
Required: Yes
- Tags
-
Optional metadata tags for categorizing and managing WorkSpaces Instances.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Elements
The following element is returned by the service.
- WorkspaceInstanceId
-
Unique identifier assigned to the newly created WorkSpaces Instance.
Type: String
Length Constraints: Minimum length of 15. Maximum length of 70.
Pattern:
wsinst-[0-9a-zA-Z]{8,63}
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Indicates insufficient permissions to perform the requested action.
- Message
-
Detailed explanation of the access denial.
HTTP Status Code: 403
- ConflictException
-
Signals a conflict with the current state of the resource.
- Message
-
Description of the conflict encountered.
- ResourceId
-
Identifier of the conflicting resource.
- ResourceType
-
Type of the conflicting resource.
HTTP Status Code: 409
- InternalServerException
-
Indicates an unexpected server-side error occurred.
- Message
-
Description of the internal server error.
- RetryAfterSeconds
-
Recommended wait time before retrying the request.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
Indicates that a service quota has been exceeded.
- Message
-
Description of the quota limitation.
- QuotaCode
-
Specific code for the exceeded quota.
- ResourceId
-
Identifier of the resource related to the quota.
- ResourceType
-
Type of resource related to the quota.
- ServiceCode
-
Code identifying the service with the quota limitation.
HTTP Status Code: 402
- ThrottlingException
-
Indicates the request rate has exceeded limits.
- Message
-
Description of the throttling event.
- QuotaCode
-
Specific code for the throttling quota.
- RetryAfterSeconds
-
Recommended wait time before retrying the request.
- ServiceCode
-
Code identifying the service experiencing throttling.
HTTP Status Code: 429
- ValidationException
-
Indicates invalid input parameters in the request.
- FieldList
-
List of fields that failed validation.
- Message
-
Overall description of validation failures.
- Reason
-
Specific reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
