CleanRoomsService / Client / create_membership

create_membership

CleanRoomsService.Client.create_membership(**kwargs)

Creates a membership for a specific collaboration identifier and joins the collaboration.

See also: AWS API Documentation

Request Syntax

response = client.create_membership(
    collaborationIdentifier='string',
    queryLogStatus='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    }
)

Parameters:

• collaborationIdentifier (string) –

  [REQUIRED]

  The unique ID for the associated collaboration.

• queryLogStatus (string) –

  [REQUIRED]

  An indicator as to whether query logging has been enabled or disabled for the collaboration.

• tags (dict) –

  An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'membership': {
        'id': 'string',
        'arn': 'string',
        'collaborationArn': 'string',
        'collaborationId': 'string',
        'collaborationCreatorAccountId': 'string',
        'collaborationCreatorDisplayName': 'string',
        'collaborationName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
        'memberAbilities': [
            'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
        ],
        'queryLogStatus': 'ENABLED'|'DISABLED'
    }
}

Response Structure

• (dict) –

  • membership (dict) –

    The membership that was created.

    • id (string) –

      The unique ID of the membership.

    • arn (string) –

      The unique ARN for the membership.

    • collaborationArn (string) –

      The unique ARN for the membership’s associated collaboration.

    • collaborationId (string) –

      The unique ID for the membership’s collaboration.

    • collaborationCreatorAccountId (string) –

      The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

    • collaborationCreatorDisplayName (string) –

      The display name of the collaboration creator.

    • collaborationName (string) –

      The name of the membership’s collaboration.

    • createTime (datetime) –

      The time when the membership was created.

    • updateTime (datetime) –

      The time the membership metadata was last updated.

    • status (string) –

      The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

    • memberAbilities (list) –

      The abilities granted to the collaboration member.

      • (string) –

    • queryLogStatus (string) –

      An indicator as to whether query logging has been enabled or disabled for the collaboration.

Exceptions

• CleanRoomsService.Client.exceptions.ConflictException

• CleanRoomsService.Client.exceptions.ServiceQuotaExceededException

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException