SecurityAgent / Client / list_memberships

list_memberships

SecurityAgent.Client.list_memberships(**kwargs)

Lists all members associated to an agent space with pagination support

See also: AWS API Documentation

Request Syntax

response = client.list_memberships(
    applicationId='string',
    agentSpaceId='string',
    memberType='USER'|'ALL',
    maxResults=123,
    nextToken='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  Application identifier

• agentSpaceId (string) –

  [REQUIRED]

  Agent space identifier

• memberType (string) – Filter by member type

• maxResults (integer) – Maximum number of results to return

• nextToken (string) – Token for pagination

Return type:

dict

Returns:

Response Syntax

{
    'membershipSummaries': [
        {
            'membershipId': 'string',
            'applicationId': 'string',
            'agentSpaceId': 'string',
            'memberType': 'USER',
            'config': {
                'user': {
                    'role': 'MEMBER'
                }
            },
            'metadata': {
                'user': {
                    'username': 'string',
                    'email': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for listing members associated to an agent space

  • membershipSummaries (list) –

    List of membership summaries

    • (dict) –

      Membership summary for list operations

      • membershipId (string) –

        Member identifier (userId or agentSpaceId)

      • applicationId (string) –

        Application identifier

      • agentSpaceId (string) –

        Agent space identifier

      • memberType (string) –

        Type of member

      • config (dict) –

        Configuration specific to the member type

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: user. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • user (dict) –

          Configuration for user members

          • role (string) –

            Role of the user associated to the agent space

      • metadata (dict) –

        Member-specific metadata

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: user. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • user (dict) –

          User metadata for USER members

          • username (string) –

            User name/display name

          • email (string) –

            User email address

      • createdAt (datetime) –

        Timestamp when the membership was created (ISO 8601)

      • updatedAt (datetime) –

        Timestamp when the membership was last updated (ISO 8601)

      • createdBy (string) –

        User ID who created the membership

      • updatedBy (string) –

        User ID who last updated the membership

  • nextToken (string) –

    Token for next page of results