Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMembership

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

Request Syntax


POST /memberships HTTP/1.1
Content-type: application/json

{
   "collaborationIdentifier": "string",
   "defaultResultConfiguration": { 
      "outputConfiguration": { ... },
      "roleArn": "string"
   },
   "paymentConfiguration": { 
      "machineLearning": { 
         "modelInference": { 
            "isResponsible": boolean
         },
         "modelTraining": { 
            "isResponsible": boolean
         }
      },
      "queryCompute": { 
         "isResponsible": boolean
      }
   },
   "queryLogStatus": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

collaborationIdentifier

The unique ID for the associated collaboration.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

defaultResultConfiguration

The default protected query result configuration as specified by the member who can receive results.

Type: MembershipProtectedQueryResultConfiguration object

Required: No

paymentConfiguration

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

Type: MembershipPaymentConfiguration object

Required: No

queryLogStatus

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

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

tags

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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "membership": { 
      "arn": "string",
      "collaborationArn": "string",
      "collaborationCreatorAccountId": "string",
      "collaborationCreatorDisplayName": "string",
      "collaborationId": "string",
      "collaborationName": "string",
      "createTime": number,
      "defaultResultConfiguration": { 
         "outputConfiguration": { ... },
         "roleArn": "string"
      },
      "id": "string",
      "memberAbilities": [ "string" ],
      "mlMemberAbilities": { 
         "customMLMemberAbilities": [ "string" ]
      },
      "paymentConfiguration": { 
         "machineLearning": { 
            "modelInference": { 
               "isResponsible": boolean
            },
            "modelTraining": { 
               "isResponsible": boolean
            }
         },
         "queryCompute": { 
            "isResponsible": boolean
         }
      },
      "queryLogStatus": "string",
      "status": "string",
      "updateTime": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

membership

The membership that was created.

Type: Membership object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request denied because service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400