AWS Security Agent

{'memberType': {'GROUP'}}

Creates a new membership, granting a user or group access to an agent space within an application.

See also: AWS API Documentation

Request Syntax

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

type applicationId:

string

param applicationId:

[REQUIRED]

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

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space to grant access to.

type membershipId:

string

param membershipId:

[REQUIRED]

The unique identifier for the membership.

type memberType:

string

param memberType:

[REQUIRED]

The type of member. Use USER for an individual user or GROUP for an IAM Identity Center group. All members of a group have access to the agent space.

type config:

dict

param config:

The configuration for the membership, such as the user role.

• user (dict) --

  The user configuration for the membership.

  • role (string) --

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

  Response structure for adding a single member to an agent space.

{'memberType': {'GROUP'}}

Deletes a membership, revoking a user's or group's access to an agent space.

See also: AWS API Documentation

Request Syntax

client.delete_membership(
    applicationId='string',
    agentSpaceId='string',
    membershipId='string',
    memberType='USER'|'GROUP'
)

type applicationId:

string

param applicationId:

[REQUIRED]

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

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space to revoke access from.

type membershipId:

string

param membershipId:

[REQUIRED]

The unique identifier of the membership to delete.

type memberType:

string

param memberType:

The type of member to remove.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

  Response structure for removing a single member from an agent space.

{'memberType': {'GROUP'}}

{'membershipSummaries': {'memberType': {'GROUP'},
                         'metadata': {'group': {'description': 'string',
                                                'displayName': 'string'}}}}

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

See also: AWS API Documentation

Request Syntax

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

type applicationId:

string

param applicationId:

[REQUIRED]

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

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

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

type memberType:

string

param memberType:

Filter memberships by member type.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'membershipSummaries': [
        {
            'membershipId': 'string',
            'applicationId': 'string',
            'agentSpaceId': 'string',
            'memberType': 'USER'|'GROUP',
            'config': {
                'user': {
                    'role': 'MEMBER'
                }
            },
            'metadata': {
                'user': {
                    'username': 'string',
                    'email': 'string'
                },
                'group': {
                    'displayName': 'string',
                    'description': '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.

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

        • user (dict) --

          The user metadata for the member.

          • username (string) --

            The username of the user.

          • email (string) --

            The email address of the user.

        • group (dict) --

          The group metadata for the member.

          • displayName (string) --

            The display name of the group.

          • description (string) --

            The description of the group.

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