SecurityAgent / Client / create_membership

create_membership

SecurityAgent.Client.create_membership(**kwargs)

Adds a single member to an agent space with specified role

See also: AWS API Documentation

Request Syntax

response = client.create_membership(
    applicationId='string',
    agentSpaceId='string',
    membershipId='string',
    memberType='USER',
    config={
        'user': {
            'role': 'MEMBER'
        }
    }
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  Application identifier

• agentSpaceId (string) –

  [REQUIRED]

  Agent space identifier

• membershipId (string) –

  [REQUIRED]

  Member identifier (userId or agentSpaceId)

• memberType (string) –

  [REQUIRED]

  Type of member (USER or AGENT_SPACE)

• config (dict) –

  Membership details (user or agent specific)

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: user.

  • user (dict) –

    Configuration for user members

    • role (string) –

      Role of the user associated to the agent space

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  Response structure for adding a single member to an agent space