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

GetMembership

Retrieves a specified membership for an identifier.

Request Syntax


GET /memberships/membershipIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The identifier for a membership resource.

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 does not have a request body.

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,
      "defaultJobResultConfiguration": { 
         "outputConfiguration": { ... },
         "roleArn": "string"
      },
      "defaultResultConfiguration": { 
         "outputConfiguration": { ... },
         "roleArn": "string"
      },
      "id": "string",
      "jobLogStatus": "string",
      "memberAbilities": [ "string" ],
      "mlMemberAbilities": { 
         "customMLMemberAbilities": [ "string" ]
      },
      "paymentConfiguration": { 
         "jobCompute": { 
            "isResponsible": boolean
         },
         "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 retrieved for the provided identifier.

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.

reason: A reason code for the exception.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

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.

fieldList: Validation errors for specific input parameters.
reason: A reason code for the exception.

HTTP Status Code: 400