Amazon EMR

2021/09/09 - Amazon EMR - 3 updated api methods

Changes  This release enables customers to login to EMR Studio using AWS Identity and Access Management (IAM) identities or identities in their Identity Provider (IdP) via IAM.

CreateStudio (updated) Link ¶
Changes (request) 
{'IdpAuthUrl': 'string', 'IdpRelayStateParameterName': 'string'}

Creates a new Amazon EMR Studio.

See also: AWS API Documentation

Request Syntax

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'
        },
    ]
)
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 Amazon Web Services SSO.

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 Amazon Web Services SSO 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 .

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

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.

DescribeStudio (updated) Link ¶
Changes (response) 
{'Studio': {'IdpAuthUrl': 'string', 'IdpRelayStateParameterName': 'string'}}

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

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

string

param StudioId

[REQUIRED]

The Amazon EMR Studio ID.

rtype

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'
            },
        ]
    }
}

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 using IAM or Amazon Web Services SSO.

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

ListStudios (updated) Link ¶
Changes (response) 
{'Studios': {'AuthMode': 'SSO | IAM'}}

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.

See also: AWS API Documentation

Request Syntax

client.list_studios(
    Marker='string'
)
type Marker

string

param Marker

The pagination token that indicates the set of results to retrieve.

rtype

dict

returns

Response Syntax

{
    'Studios': [
        {
            'StudioId': 'string',
            'Name': 'string',
            'VpcId': 'string',
            'Description': 'string',
            'Url': 'string',
            'AuthMode': 'SSO'|'IAM',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • Studios (list) --

      The list of Studio summary objects.

      • (dict) --

        Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The details do not include subnets, IAM roles, security groups, or tags associated with the Studio.

        • StudioId (string) --

          The ID of the Amazon EMR Studio.

        • Name (string) --

          The name of the Amazon EMR Studio.

        • VpcId (string) --

          The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.

        • Description (string) --

          The detailed description of the Amazon EMR Studio.

        • Url (string) --

          The unique access URL of the Amazon EMR Studio.

        • AuthMode (string) --

          Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

        • CreationTime (datetime) --

          The time when the Amazon EMR Studio was created.

    • Marker (string) --

      The pagination token that indicates the next set of results to retrieve.