DescribeStudio - Amazon Elastic MapReduce

DescribeStudio

Note

The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.

Request Syntax

{ "StudioId": "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.

StudioId

The Amazon EMR Studio ID.

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

{ "Studio": { "AuthMode": "string", "CreationTime": number, "DefaultS3Location": "string", "Description": "string", "EngineSecurityGroupId": "string", "Name": "string", "ServiceRole": "string", "StudioArn": "string", "StudioId": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "Url": "string", "UserRole": "string", "VpcId": "string", "WorkspaceSecurityGroupId": "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.

Studio

The Amazon EMR Studio details.

Type: Studio object

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: