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

UpdateMembership

Updates a membership.

Request Syntax


PATCH /memberships/membershipIdentifier HTTP/1.1
Content-type: application/json

{
   "defaultResultConfiguration": { 
      "outputConfiguration": { ... },
      "roleArn": "string"
   },
   "queryLogStatus": "string"
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The unique identifier of the membership.

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

Request Body

The request accepts the following data in JSON format.

defaultResultConfiguration

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

Type: MembershipProtectedQueryResultConfiguration 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: 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" ],
      "paymentConfiguration": { 
         "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 object.

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

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