get_membership

CleanRoomsService.Client.get_membership(**kwargs)

Retrieves a specified membership for an identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_membership(
    membershipIdentifier='string'
)

Parameters

membershipIdentifier (string) --

[REQUIRED]

The identifier for a membership resource.

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 retrieved for the provided identifier.

    • 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.ResourceNotFoundException
• CleanRoomsService.Client.exceptions.InternalServerException
• CleanRoomsService.Client.exceptions.ValidationException
• CleanRoomsService.Client.exceptions.ThrottlingException
• CleanRoomsService.Client.exceptions.AccessDeniedException