Skip to content

Studio

Source code in docs_src/capo_emr/types/studio.py
class Studio(TypedDict, closed=True):
    studio_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The ID of the Amazon EMR Studio.</p>"""
    studio_arn: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The Amazon Resource Name (ARN) of the Amazon EMR Studio.</p>"""
    name: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The name of the Amazon EMR Studio.</p>"""
    description: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The detailed description of the Amazon EMR Studio.</p>"""
    auth_mode: NotRequired["capo_emr.types.auth_mode.AuthMode"]
    """<p>Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.</p>"""
    vpc_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The ID of the VPC associated with the Amazon EMR Studio.</p>"""
    subnet_ids: NotRequired["capo_emr.types.subnet_id_list.SubnetIdList"]
    """<p>The list of IDs of the subnets associated with the Amazon EMR Studio.</p>"""
    service_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The name of the IAM role assumed by the Amazon EMR Studio.</p>"""
    user_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a <code>UserRole</code> when you use IAM authentication.</p>"""
    workspace_security_group_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>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.</p>"""
    engine_security_group_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>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.</p>"""
    url: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The unique access URL of the Amazon EMR Studio.</p>"""
    creation_time: NotRequired["capo_emr.types.date.Date"]
    """<p>The time the Amazon EMR Studio was created.</p>"""
    default_s3_location: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p>"""
    idp_auth_url: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>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.</p>"""
    idp_relay_state_parameter_name: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The name of your identity provider's <code>RelayState</code> parameter.</p>"""
    tags: NotRequired["capo_emr.types.tag_list.TagList"]
    """<p>A list of tags associated with the Amazon EMR Studio.</p>"""
    idc_instance_arn: NotRequired["capo_emr.types.arn_type.ArnType"]
    """<p> The ARN of the IAM Identity Center instance the Studio application belongs to. </p>"""
    trusted_identity_propagation_enabled: NotRequired[
        "capo_emr.types.boolean_object.BooleanObject"
    ]
    """<p> Indicates whether the Studio has Trusted identity propagation enabled. The default value is <code>false</code>. </p>"""
    idc_user_assignment: NotRequired[
        "capo_emr.types.idc_user_assignment.IdcUserAssignment"
    ]
    """<p> Indicates whether the Studio has <code>REQUIRED</code> or <code>OPTIONAL</code> IAM Identity Center user assignment. If the value is set to <code>REQUIRED</code>, users must be explicitly assigned to the Studio application to access the Studio. </p>"""
    encryption_key_arn: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.</p>"""

auth_mode instance-attribute

auth_mode: NotRequired[AuthMode]

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

creation_time instance-attribute

creation_time: NotRequired[Date]

The time the Amazon EMR Studio was created.

default_s3_location instance-attribute

default_s3_location: NotRequired[XmlString]

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

description instance-attribute

description: NotRequired[XmlStringMaxLen256]

The detailed description of the Amazon EMR Studio.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[XmlString]

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

engine_security_group_id instance-attribute

engine_security_group_id: NotRequired[XmlStringMaxLen256]

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.

idc_instance_arn instance-attribute

idc_instance_arn: NotRequired[ArnType]

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

idc_user_assignment instance-attribute

idc_user_assignment: NotRequired[IdcUserAssignment]

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.

idp_auth_url instance-attribute

idp_auth_url: NotRequired[XmlString]

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.

idp_relay_state_parameter_name instance-attribute

idp_relay_state_parameter_name: NotRequired[XmlStringMaxLen256]

The name of your identity provider's RelayState parameter.

name instance-attribute

name: NotRequired[XmlStringMaxLen256]

The name of the Amazon EMR Studio.

service_role instance-attribute

service_role: NotRequired[XmlString]

The name of the IAM role assumed by the Amazon EMR Studio.

studio_arn instance-attribute

studio_arn: NotRequired[XmlStringMaxLen256]

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

studio_id instance-attribute

studio_id: NotRequired[XmlStringMaxLen256]

The ID of the Amazon EMR Studio.

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIdList]

The list of IDs of the subnets associated with the Amazon EMR Studio.

tags instance-attribute

tags: NotRequired[TagList]

A list of tags associated with the Amazon EMR Studio.

trusted_identity_propagation_enabled instance-attribute

trusted_identity_propagation_enabled: NotRequired[BooleanObject]

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

url instance-attribute

url: NotRequired[XmlString]

The unique access URL of the Amazon EMR Studio.

user_role instance-attribute

user_role: NotRequired[XmlString]

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.

vpc_id instance-attribute

vpc_id: NotRequired[XmlStringMaxLen256]

The ID of the VPC associated with the Amazon EMR Studio.

workspace_security_group_id instance-attribute

workspace_security_group_id: NotRequired[XmlStringMaxLen256]

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.