CreateStudio
The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.
Creates a new Amazon EMR Studio.
Request Syntax
{
"AuthMode": "string
",
"DefaultS3Location": "string
",
"Description": "string
",
"EngineSecurityGroupId": "string
",
"Name": "string
",
"ServiceRole": "string
",
"SubnetIds": [ "string
" ],
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"UserRole": "string
",
"VpcId": "string
",
"WorkspaceSecurityGroupId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AuthMode
-
Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
Type: String
Valid Values:
SSO | IAM
Required: Yes
- DefaultS3Location
-
The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- Description
-
A detailed description of the Studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- EngineSecurityGroupId
-
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- Name
-
A descriptive name for the Amazon EMR Studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- ServiceRole
-
The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- SubnetIds
-
A list of subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by
VpcId
. Studio users can create a Workspace in any of the specified subnets.Type: Array of strings
Required: Yes
- Tags
-
A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
Type: Array of Tag objects
Required: No
- UserRole
-
The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- VpcId
-
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
- WorkspaceSecurityGroupId
-
The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by
VpcId
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes
Response Syntax
{
"StudioId": "string",
"Url": "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.
- StudioId
-
The ID of the Amazon EMR Studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
- Url
-
The unique Studio access URL.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10280.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
This exception occurs when there is an internal failure in the EMR service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception occurs when there is something wrong with user input.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: