EMR / Paginator / ListStudioSessionMappings

ListStudioSessionMappings#

class EMR.Paginator.ListStudioSessionMappings#
paginator = client.get_paginator('list_studio_session_mappings')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from EMR.Client.list_studio_session_mappings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StudioId='string',
    IdentityType='USER'|'GROUP',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • StudioId (string) – The ID of the Amazon EMR Studio.

  • IdentityType (string) – Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SessionMappings': [
        {
            'StudioId': 'string',
            'IdentityId': 'string',
            'IdentityName': 'string',
            'IdentityType': 'USER'|'GROUP',
            'SessionPolicyArn': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SessionMappings (list) –

      A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.

      • (dict) –

        Details for an Amazon EMR Studio session mapping. The details do not include the time the session mapping was last modified.

        • StudioId (string) –

          The ID of the Amazon EMR Studio.

        • IdentityId (string) –

          The globally unique identifier (GUID) of the user or group from the IAM Identity Center Identity Store.

        • IdentityName (string) –

          The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference.

        • IdentityType (string) –

          Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

        • SessionPolicyArn (string) –

          The Amazon Resource Name (ARN) of the session policy associated with the user or group.

        • CreationTime (datetime) –

          The time the session mapping was created.

    • NextToken (string) –

      A token to resume pagination.