EMR / Client / describe_studio

describe_studio

EMR.Client.describe_studio(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_studio(
    StudioId='string'
)

Parameters:

StudioId (string) –

[REQUIRED]

The Amazon EMR Studio ID.

Return type:

dict

Returns:

Response Syntax

{
    'Studio': {
        'StudioId': 'string',
        'StudioArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'AuthMode': 'SSO'|'IAM',
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'ServiceRole': 'string',
        'UserRole': 'string',
        'WorkspaceSecurityGroupId': 'string',
        'EngineSecurityGroupId': 'string',
        'Url': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'DefaultS3Location': 'string',
        'IdpAuthUrl': 'string',
        'IdpRelayStateParameterName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'IdcInstanceArn': 'string',
        'TrustedIdentityPropagationEnabled': True|False,
        'IdcUserAssignment': 'REQUIRED'|'OPTIONAL',
        'EncryptionKeyArn': 'string'
    }
}

Response Structure

• (dict) –

  • Studio (dict) –

    The Amazon EMR Studio details.

    • StudioId (string) –

      The ID of the Amazon EMR Studio.

    • StudioArn (string) –

      The Amazon Resource Name (ARN) of the Amazon EMR Studio.

    • Name (string) –

      The name of the Amazon EMR Studio.

    • Description (string) –

      The detailed description of the Amazon EMR Studio.

    • AuthMode (string) –

      Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.

    • VpcId (string) –

      The ID of the VPC associated with the Amazon 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. A Studio only requires a UserRole when you use IAM authentication.

    • 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 (datetime) –

      The time the Amazon EMR Studio was created.

    • DefaultS3Location (string) –

      The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

    • IdpAuthUrl (string) –

      Your identity provider’s authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

    • IdpRelayStateParameterName (string) –

      The name of your identity provider’s RelayState parameter.

    • Tags (list) –

      A list of tags associated with the Amazon EMR Studio.

      • (dict) –

        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.

    • IdcInstanceArn (string) –

      The ARN of the IAM Identity Center instance the Studio application belongs to.

    • TrustedIdentityPropagationEnabled (boolean) –

      Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.

    • IdcUserAssignment (string) –

      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.

    • EncryptionKeyArn (string) –

      The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

Exceptions

• EMR.Client.exceptions.InternalServerException

• EMR.Client.exceptions.InvalidRequestException