SecurityAgent / Client / list_memberships

list_memberships

SecurityAgent.Client.list_memberships(**kwargs)

Returns a paginated list of membership summaries for the specified agent space within an application.

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]

    The unique identifier of the application that contains the agent space.

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the agent space to list memberships for.

  • memberType (string) – Filter memberships by member type.

  • maxResults (integer) – The maximum number of results to return in a single call.

  • nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

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) –

      The list of membership summaries.

      • (dict) –

        Contains summary information about a membership.

        • membershipId (string) –

          The unique identifier of the membership.

        • applicationId (string) –

          The unique identifier of the application.

        • agentSpaceId (string) –

          The unique identifier of the agent space.

        • memberType (string) –

          The type of member.

        • config (dict) –

          The configuration for the membership.

          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) –

            The user configuration for the membership.

            • role (string) –

              The role assigned to the user. Currently, only MEMBER is supported.

        • metadata (dict) –

          The metadata for the member.

          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) –

            The user metadata for the member.

            • username (string) –

              The username of the user.

            • email (string) –

              The email address of the user.

        • createdAt (datetime) –

          The date and time the membership was created, in UTC format.

        • updatedAt (datetime) –

          The date and time the membership was last updated, in UTC format.

        • createdBy (string) –

          The identifier of the entity that created the membership.

        • updatedBy (string) –

          The identifier of the entity that last updated the membership.

    • nextToken (string) –

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.