:doc:`EMR <../../emr>` / Client / create_studio

*************
create_studio
*************



.. py:method:: EMR.Client.create_studio(**kwargs)

  

  Creates a new Amazon EMR Studio.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticmapreduce-2009-03-31/CreateStudio>`_  


  **Request Syntax**
  ::

    response = client.create_studio(
        Name='string',
        Description='string',
        AuthMode='SSO'|'IAM',
        VpcId='string',
        SubnetIds=[
            'string',
        ],
        ServiceRole='string',
        UserRole='string',
        WorkspaceSecurityGroupId='string',
        EngineSecurityGroupId='string',
        DefaultS3Location='string',
        IdpAuthUrl='string',
        IdpRelayStateParameterName='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        TrustedIdentityPropagationEnabled=True|False,
        IdcUserAssignment='REQUIRED'|'OPTIONAL',
        IdcInstanceArn='string',
        EncryptionKeyArn='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    A descriptive name for the Amazon EMR Studio.

    

  
  :type Description: string
  :param Description: 

    A detailed description of the Amazon EMR Studio.

    

  
  :type AuthMode: string
  :param AuthMode: **[REQUIRED]** 

    Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

    

  
  :type VpcId: string
  :param VpcId: **[REQUIRED]** 

    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

    

  
  :type SubnetIds: list
  :param SubnetIds: **[REQUIRED]** 

    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.

    

  
    - *(string) --* 

    

  :type ServiceRole: string
  :param ServiceRole: **[REQUIRED]** 

    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.

    

  
  :type UserRole: string
  :param UserRole: 

    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.

    

  
  :type WorkspaceSecurityGroupId: string
  :param WorkspaceSecurityGroupId: **[REQUIRED]** 

    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``.

    

  
  :type EngineSecurityGroupId: string
  :param EngineSecurityGroupId: **[REQUIRED]** 

    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``.

    

  
  :type DefaultS3Location: string
  :param DefaultS3Location: **[REQUIRED]** 

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

    

  
  :type IdpAuthUrl: string
  :param IdpAuthUrl: 

    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.

    

  
  :type IdpRelayStateParameterName: string
  :param IdpRelayStateParameterName: 

    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.

    

  
  :type Tags: list
  :param Tags: 

    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.

    

  
    - *(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 <https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html>`__.

      

    
      - **Key** *(string) --* 

        A user-defined key, which is the minimum required information for a valid tag. For more information, see `Tag <https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html>`__.

        

      
      - **Value** *(string) --* 

        A user-defined value, which is optional in a tag. For more information, see `Tag Clusters <https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html>`__.

        

      
    

  :type TrustedIdentityPropagationEnabled: boolean
  :param TrustedIdentityPropagationEnabled: 

    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is ``false``.

    

  
  :type IdcUserAssignment: string
  :param IdcUserAssignment: 

    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.

    

  
  :type IdcInstanceArn: string
  :param IdcInstanceArn: 

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

    

  
  :type EncryptionKeyArn: string
  :param EncryptionKeyArn: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'StudioId': 'string',
          'Url': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **StudioId** *(string) --* 

        The ID of the Amazon EMR Studio.

        
      

      - **Url** *(string) --* 

        The unique Studio access URL.

        
  
  **Exceptions**
  
  *   :py:class:`EMR.Client.exceptions.InternalServerException`

  
  *   :py:class:`EMR.Client.exceptions.InvalidRequestException`

  