# CreateSpace
<a name="API_CreateSpace"></a>

Creates a private space or a space used for real time collaboration in a domain.

## Request Syntax
<a name="API_CreateSpace_RequestSyntax"></a>

```
{
   "DomainId": "{{string}}",
   "OwnershipSettings": { 
      "OwnerUserProfileName": "{{string}}"
   },
   "SpaceDisplayName": "{{string}}",
   "SpaceName": "{{string}}",
   "SpaceSettings": { 
      "AppType": "{{string}}",
      "CodeEditorAppSettings": { 
         "AppLifecycleManagement": { 
            "IdleSettings": { 
               "IdleTimeoutInMinutes": {{number}}
            }
         },
         "DefaultResourceSpec": { 
            "InstanceType": "{{string}}",
            "LifecycleConfigArn": "{{string}}",
            "SageMakerImageArn": "{{string}}",
            "SageMakerImageVersionAlias": "{{string}}",
            "SageMakerImageVersionArn": "{{string}}"
         }
      },
      "CustomFileSystems": [ 
         { ... }
      ],
      "JupyterLabAppSettings": { 
         "AppLifecycleManagement": { 
            "IdleSettings": { 
               "IdleTimeoutInMinutes": {{number}}
            }
         },
         "CodeRepositories": [ 
            { 
               "RepositoryUrl": "{{string}}"
            }
         ],
         "DefaultResourceSpec": { 
            "InstanceType": "{{string}}",
            "LifecycleConfigArn": "{{string}}",
            "SageMakerImageArn": "{{string}}",
            "SageMakerImageVersionAlias": "{{string}}",
            "SageMakerImageVersionArn": "{{string}}"
         }
      },
      "JupyterServerAppSettings": { 
         "CodeRepositories": [ 
            { 
               "RepositoryUrl": "{{string}}"
            }
         ],
         "DefaultResourceSpec": { 
            "InstanceType": "{{string}}",
            "LifecycleConfigArn": "{{string}}",
            "SageMakerImageArn": "{{string}}",
            "SageMakerImageVersionAlias": "{{string}}",
            "SageMakerImageVersionArn": "{{string}}"
         },
         "LifecycleConfigArns": [ "{{string}}" ]
      },
      "KernelGatewayAppSettings": { 
         "CustomImages": [ 
            { 
               "AppImageConfigName": "{{string}}",
               "ImageName": "{{string}}",
               "ImageVersionNumber": {{number}}
            }
         ],
         "DefaultResourceSpec": { 
            "InstanceType": "{{string}}",
            "LifecycleConfigArn": "{{string}}",
            "SageMakerImageArn": "{{string}}",
            "SageMakerImageVersionAlias": "{{string}}",
            "SageMakerImageVersionArn": "{{string}}"
         },
         "LifecycleConfigArns": [ "{{string}}" ]
      },
      "RemoteAccess": "{{string}}",
      "SpaceManagedResources": "{{string}}",
      "SpaceStorageSettings": { 
         "EbsStorageSettings": { 
            "EbsVolumeSizeInGb": {{number}}
         }
      }
   },
   "SpaceSharingSettings": { 
      "SharingType": "{{string}}"
   },
   "Tags": [ 
      { 
         "Key": "{{string}}",
         "Value": "{{string}}"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateSpace_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-DomainId"></a>
The ID of the associated domain.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 63.  
Pattern: `d-(-*[a-z0-9]){1,61}`   
Required: Yes

 ** [OwnershipSettings](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-OwnershipSettings"></a>
A collection of ownership settings.  
Type: [OwnershipSettings](API_OwnershipSettings.md) object  
Required: No

 ** [SpaceDisplayName](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-SpaceDisplayName"></a>
The name of the space that appears in the SageMaker Studio UI.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Pattern: `(?!\s*$).+`   
Required: No

 ** [SpaceName](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-SpaceName"></a>
The name of the space.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 63.  
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`   
Required: Yes

 ** [SpaceSettings](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-SpaceSettings"></a>
A collection of space settings.  
Type: [SpaceSettings](API_SpaceSettings.md) object  
Required: No

 ** [SpaceSharingSettings](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-SpaceSharingSettings"></a>
A collection of space sharing settings.  
Type: [SpaceSharingSettings](API_SpaceSharingSettings.md) object  
Required: No

 ** [Tags](#API_CreateSpace_RequestSyntax) **   <a name="sagemaker-CreateSpace-request-Tags"></a>
Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the `Search` API.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateSpace_ResponseSyntax"></a>

```
{
   "SpaceArn": "string"
}
```

## Response Elements
<a name="API_CreateSpace_ResponseElements"></a>

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

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

 ** [SpaceArn](#API_CreateSpace_ResponseSyntax) **   <a name="sagemaker-CreateSpace-response-SpaceArn"></a>
The space's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:space/.*` 

## Errors
<a name="API_CreateSpace_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceInUse **   
Resource being accessed is in use.  
HTTP Status Code: 400

 ** ResourceLimitExceeded **   
 You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.   
HTTP Status Code: 400

## See Also
<a name="API_CreateSpace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/CreateSpace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/CreateSpace)