project_memberships

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

Overview

Name	project_memberships
Type	Resource
Id	aws.datazone.project_memberships

Fields

The following fields are returned by SELECT queries:

list_project_memberships

Name	Datatype	Description
designation	string	The designated role of a project member. (PROJECT_OWNER, PROJECT_CONTRIBUTOR, PROJECT_CATALOG_VIEWER, PROJECT_CATALOG_CONSUMER, PROJECT_CATALOG_STEWARD)
member_details	object	The membership details of a project member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_project_memberships	select	domain_identifier, project_identifier, region	sortBy, sortOrder, nextToken, maxResults	Lists all members of the specified project.
create_project_membership	insert	domain_identifier, project_identifier, region, member, designation		Creates a project membership in Amazon DataZone.
delete_project_membership	delete	domain_identifier, project_identifier, region		Deletes project membership in Amazon DataZone.

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
domain_identifier	string	The ID of the Amazon DataZone domain where project membership is deleted.
project_identifier	string	The ID of the Amazon DataZone project the membership to which is deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of memberships to return in a single call to ListProjectMemberships. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectMemberships to list the next set of memberships.
nextToken	string	When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.
sortBy	string	The method by which you want to sort the project memberships.
sortOrder	string	The sort order of the project memberships.

SELECT examples

list_project_memberships

Lists all members of the specified project.

SELECT
designation,
member_details
FROM aws.datazone.project_memberships
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND project_identifier = '{{ project_identifier }}' -- required
AND region = '{{ region }}' -- required
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_project_membership

Creates a project membership in Amazon DataZone.

INSERT INTO aws.datazone.project_memberships (
member,
designation,
domain_identifier,
project_identifier,
region
)
SELECT 
'{{ member }}' /* required */,
'{{ designation }}' /* required */,
'{{ domain_identifier }}',
'{{ project_identifier }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: project_memberships
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the project_memberships resource.
  - name: project_identifier
    value: "{{ project_identifier }}"
    description: Required parameter for the project_memberships resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the project_memberships resource.
  - name: member
    description: |
      The details about a project member.
    value:
      userIdentifier: "{{ userIdentifier }}"
      groupIdentifier: "{{ groupIdentifier }}"
  - name: designation
    value: "{{ designation }}"
    valid_values: ['PROJECT_OWNER', 'PROJECT_CONTRIBUTOR', 'PROJECT_CATALOG_VIEWER', 'PROJECT_CATALOG_CONSUMER', 'PROJECT_CATALOG_STEWARD']

DELETE examples

delete_project_membership

Deletes project membership in Amazon DataZone.

DELETE FROM aws.datazone.project_memberships
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND project_identifier = '{{ project_identifier }}' --required
AND region = '{{ region }}' --required
;