memberships

Creates, updates, deletes, gets or lists a memberships resource.

Overview

Name	memberships
Type	Resource
Id	aws.securityagent.memberships

Fields

The following fields are returned by SELECT queries:

list_memberships

Name	Datatype	Description
agent_space_id	string	Unique identifier of the agent space.
application_id	string	Application identifier.
config	object	The configuration for a membership. This is a union type that contains member-type-specific configuration.
created_at	string (date-time)	The date and time the membership was created, in UTC format.
created_by	string	The identifier of the entity that created the membership.
member_type	string	Type of membership. (USER)
membership_id	string	Member identifier.
metadata	object	The metadata for the member.
updated_at	string (date-time)	The date and time the membership was last updated, in UTC format.
updated_by	string	The identifier of the entity that last updated the membership.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_memberships	select	region		Returns a paginated list of membership summaries for the specified agent space within an application.
create_membership	insert	region, applicationId, agentSpaceId, membershipId, memberType		Creates a new membership, granting a user access to an agent space within an application.
delete_membership	delete	region		Deletes a membership, revoking a user's access to an agent space.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_memberships

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

SELECT
agent_space_id,
application_id,
config,
created_at,
created_by,
member_type,
membership_id,
metadata,
updated_at,
updated_by
FROM aws.securityagent.memberships
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_membership

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

INSERT INTO aws.securityagent.memberships (
applicationId,
agentSpaceId,
membershipId,
memberType,
config,
region
)
SELECT 
'{{ applicationId }}' /* required */,
'{{ agentSpaceId }}' /* required */,
'{{ membershipId }}' /* required */,
'{{ memberType }}' /* required */,
'{{ config }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: memberships
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the memberships resource.
  - name: applicationId
    value: "{{ applicationId }}"
    description: |
      Application identifier.
  - name: agentSpaceId
    value: "{{ agentSpaceId }}"
    description: |
      Unique identifier of the agent space.
  - name: membershipId
    value: "{{ membershipId }}"
    description: |
      Member identifier.
  - name: memberType
    value: "{{ memberType }}"
    description: |
      Type of membership.
    valid_values: ['USER']
  - name: config
    description: |
      The configuration for a membership. This is a union type that contains member-type-specific configuration.
    value:
      user:
        role: "{{ role }}"

DELETE examples

delete_membership

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

DELETE FROM aws.securityagent.memberships
WHERE region = '{{ region }}' --required
;