describe-studio¶
Description¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-studio
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--studio-id (string)
The Amazon EMR Studio ID.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
Studio -> (structure)
The Amazon EMR Studio details.
StudioId -> (string)
The ID of the EMR Studio.
StudioArn -> (string)
The Amazon Resource Name (ARN) of the EMR Studio.
Name -> (string)
The name of the EMR Studio.
Description -> (string)
The detailed description of the EMR Studio.
AuthMode -> (string)
Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.
VpcId -> (string)
The ID of the VPC associated with the EMR Studio.
SubnetIds -> (list)
The list of IDs of the subnets associated with the Amazon EMR Studio.
(string)
ServiceRole -> (string)
The name of the IAM role assumed by the Amazon EMR Studio.
UserRole -> (string)
The name of the IAM role assumed by users logged in to the Amazon EMR Studio.
WorkspaceSecurityGroupId -> (string)
The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
EngineSecurityGroupId -> (string)
The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.
Url -> (string)
The unique access URL of the Amazon EMR Studio.
CreationTime -> (timestamp)
The time the Amazon EMR Studio was created.
DefaultS3Location -> (string)
The default Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
Tags -> (list)
A list of tags associated with the Amazon EMR Studio.
(structure)
A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters .
Key -> (string)
A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .
Value -> (string)
A user-defined value, which is optional in a tag. For more information, see Tag Clusters .