studios

Creates, updates, deletes, gets or lists a studios resource.

Overview

Name	`studios`
Type	Resource
Id	`aws.emr.studios`

Fields

The following fields are returned by SELECT queries:

describe_studio
list_studios

Name	Datatype	Description
`auth_mode`	`string`	Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center. (SSO, IAM)
`creation_time`	`string (date-time)`	The time the Amazon EMR Studio was created.
`default_s3_location`	`string`	The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`description`	`string`	The detailed description of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`encryption_key_arn`	`string`	The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`engine_security_group_id`	`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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`idc_instance_arn`	`string`	The ARN of the IAM Identity Center instance the Studio application belongs to.
`idc_user_assignment`	`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. (REQUIRED, OPTIONAL)
`idp_auth_url`	`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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`idp_relay_state_parameter_name`	`string`	The name of your identity provider's RelayState parameter. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`name`	`string`	The name of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`service_role`	`string`	The name of the IAM role assumed by the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`studio_arn`	`string`	The Amazon Resource Name (ARN) of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`studio_id`	`string`	The ID of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`subnet_ids`	`array`	The list of IDs of the subnets associated with the Amazon EMR Studio.
`tags`	`array`	A list of tags associated with the Amazon EMR Studio.
`trusted_identity_propagation_enabled`	`boolean`	Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.
`url`	`string`	The unique access URL of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`user_role`	`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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`vpc_id`	`string`	The ID of the VPC associated with the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`workspace_security_group_id`	`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. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)

Name	Datatype	Description
`auth_mode`	`string`	Specifies whether the Studio authenticates users using IAM or IAM Identity Center. (SSO, IAM)
`creation_time`	`string (date-time)`	The time when the Amazon EMR Studio was created.
`description`	`string`	The detailed description of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`name`	`string`	The name of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`studio_id`	`string`	The ID of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`url`	`string`	The unique access URL of the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)
`vpc_id`	`string`	The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_studio`	`select`	`region`	Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.
`list_studios`	`select`	`region`	Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.
`create_studio`	`insert`	`region`, `AuthMode`, `VpcId`, `SubnetIds`, `ServiceRole`, `WorkspaceSecurityGroupId`, `EngineSecurityGroupId`, `DefaultS3Location`	Creates a new Amazon EMR Studio.
`update_studio`	`update`	`region`, `StudioId`	Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.
`delete_studio`	`delete`	`region`	Removes an Amazon EMR Studio from the Studio metadata store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_studio
list_studios

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

SELECT
auth_mode,
creation_time,
default_s3_location,
description,
encryption_key_arn,
engine_security_group_id,
idc_instance_arn,
idc_user_assignment,
idp_auth_url,
idp_relay_state_parameter_name,
name,
service_role,
studio_arn,
studio_id,
subnet_ids,
tags,
trusted_identity_propagation_enabled,
url,
user_role,
vpc_id,
workspace_security_group_id
FROM aws.emr.studios
WHERE region = '{{ region }}' -- required
;

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.

SELECT
auth_mode,
creation_time,
description,
name,
studio_id,
url,
vpc_id
FROM aws.emr.studios
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_studio
Manifest

Creates a new Amazon EMR Studio.

INSERT INTO aws.emr.studios (
Name,
Description,
AuthMode,
VpcId,
SubnetIds,
ServiceRole,
UserRole,
WorkspaceSecurityGroupId,
EngineSecurityGroupId,
DefaultS3Location,
IdpAuthUrl,
IdpRelayStateParameterName,
Tags,
TrustedIdentityPropagationEnabled,
IdcUserAssignment,
IdcInstanceArn,
EncryptionKeyArn,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ AuthMode }}' /* required */,
'{{ VpcId }}' /* required */,
'{{ SubnetIds }}' /* required */,
'{{ ServiceRole }}' /* required */,
'{{ UserRole }}',
'{{ WorkspaceSecurityGroupId }}' /* required */,
'{{ EngineSecurityGroupId }}' /* required */,
'{{ DefaultS3Location }}' /* required */,
'{{ IdpAuthUrl }}',
'{{ IdpRelayStateParameterName }}',
'{{ Tags }}',
{{ TrustedIdentityPropagationEnabled }},
'{{ IdcUserAssignment }}',
'{{ IdcInstanceArn }}',
'{{ EncryptionKeyArn }}',
'{{ region }}'
RETURNING
studio_id,
url
;

# Description fields are for documentation purposes
- name: studios
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the studios resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A descriptive name for the Amazon EMR Studio.
  - name: Description
    value: "{{ Description }}"
    description: |
      A detailed description of the Amazon EMR Studio.
  - name: AuthMode
    value: "{{ AuthMode }}"
    description: |
      Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
    valid_values: ['SSO', 'IAM']
  - name: VpcId
    value: "{{ VpcId }}"
    description: |
      The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
  - name: SubnetIds
    value:
      - "{{ SubnetIds }}"
    description: |
      A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
  - name: ServiceRole
    value: "{{ ServiceRole }}"
    description: |
      The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
  - name: UserRole
    value: "{{ UserRole }}"
    description: |
      The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
  - name: WorkspaceSecurityGroupId
    value: "{{ WorkspaceSecurityGroupId }}"
    description: |
      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.
  - name: EngineSecurityGroupId
    value: "{{ EngineSecurityGroupId }}"
    description: |
      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.
  - name: DefaultS3Location
    value: "{{ DefaultS3Location }}"
    description: |
      The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
  - name: IdpAuthUrl
    value: "{{ IdpAuthUrl }}"
    description: |
      The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
  - name: IdpRelayStateParameterName
    value: "{{ IdpRelayStateParameterName }}"
    description: |
      The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.
  - name: Tags
    description: |
      A list of tags to associate with the Amazon EMR 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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: TrustedIdentityPropagationEnabled
    value: {{ TrustedIdentityPropagationEnabled }}
    description: |
      A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
  - name: IdcUserAssignment
    value: "{{ IdcUserAssignment }}"
    description: |
      Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    valid_values: ['REQUIRED', 'OPTIONAL']
  - name: IdcInstanceArn
    value: "{{ IdcInstanceArn }}"
    description: |
      The ARN of the IAM Identity Center instance to create the Studio application.
  - name: EncryptionKeyArn
    value: "{{ EncryptionKeyArn }}"
    description: |
      The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

`UPDATE` examples

update_studio

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

UPDATE aws.emr.studios
SET 
StudioId = '{{ StudioId }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
SubnetIds = '{{ SubnetIds }}',
DefaultS3Location = '{{ DefaultS3Location }}',
EncryptionKeyArn = '{{ EncryptionKeyArn }}'
WHERE 
region = '{{ region }}' --required
AND StudioId = '{{ StudioId }}' --required;

`DELETE` examples

delete_studio

Removes an Amazon EMR Studio from the Studio metadata store.

DELETE FROM aws.emr.studios
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​