---
title: "GET /memberships/{membershipIdentifier}"
method: GET
path: "/memberships/{membershipIdentifier}"
---

# GET /memberships/{membershipIdentifier}

`GET /memberships/{membershipIdentifier}`

Retrieves a specified membership for an identifier.

## Path parameters

- `membershipIdentifier` string, required

## Response `200`

Success

- GetMembershipOutput
  - `membership` object, required — The membership retrieved for the provided identifier.
    - `id` string, required — The unique ID of the membership.
    - `arn` string, required — The unique ARN for the membership.
    - `collaborationArn` string, required — The unique ARN for the membership's associated collaboration.
    - `collaborationId` string, required — The unique ID for the membership's collaboration.
    - `collaborationCreatorAccountId` string, required — The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
    - `collaborationCreatorDisplayName` string, required — The display name of the collaboration creator.
    - `collaborationName` string, required — The name of the membership's collaboration.
    - `createTime` string, date-time, required — The time when the membership was created.
    - `updateTime` string, date-time, required — The time the membership metadata was last updated.
    - `status` 'ACTIVE' | 'REMOVED' | 'COLLABORATION_DELETED', required — The status of the membership.
    - `memberAbilities` MemberAbility[], required — The abilities granted to the collaboration member.
    - `mlMemberAbilities` object — Specifies the ML member abilities that are granted to a collaboration member.
      - `customMLMemberAbilities` CustomMLMemberAbility[], required — The custom ML member abilities for a collaboration member.
    - `queryLogStatus` 'ENABLED' | 'DISABLED', required — <p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
    - `jobLogStatus` 'ENABLED' | 'DISABLED' — <p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>
    - `defaultResultConfiguration` object — The default protected query result configuration as specified by the member who can receive results.
      - `outputConfiguration` object, required — Configuration for protected query results.
        - `s3` ProtectedQueryS3OutputConfiguration — Contains the configuration to write the query results to S3.
          - `resultFormat` 'CSV' | 'PARQUET', required — Intended file format of the result.
          - `bucket` string, required — The S3 bucket to unload the protected query results.
          - `keyPrefix` string — The S3 prefix to unload the protected query results.
          - `singleFileOutput` boolean — Indicates whether files should be output as a single file (<code>TRUE</code>) or output as multiple files (<code>FALSE</code>). This parameter is only supported for analyses with the Spark analytics engine.
      - `roleArn` string — The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
    - `defaultJobResultConfiguration` object — The default job result configuration for the membership.
      - `outputConfiguration` object, required — The output configuration for a protected job result.
        - `s3` object — Contains the configuration to write the job results to S3.
          - `bucket` string, required — The S3 bucket for job output.
          - `keyPrefix` string — The S3 prefix to unload the protected job results.
      - `roleArn` string, required — The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.
    - `paymentConfiguration` object, required — The payment responsibilities accepted by the collaboration member.
      - `queryCompute` object, required — The payment responsibilities accepted by the collaboration member for query compute costs.
        - `isResponsible` boolean, required — <p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>
      - `machineLearning` object — The payment responsibilities accepted by the collaboration member for machine learning costs.
        - `modelTraining` object — The payment responsibilities accepted by the member for model training.
          - `isResponsible` boolean, required — <p>Indicates whether the collaboration member has accepted to pay for model training costs (<code>TRUE</code>) or has not accepted to pay for model training costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model training costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model training costs. </p> </li> </ul>
        - `modelInference` object — The payment responsibilities accepted by the member for model inference.
          - `isResponsible` boolean, required — <p>Indicates whether the collaboration member has accepted to pay for model inference costs (<code>TRUE</code>) or has not accepted to pay for model inference costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model inference costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model inference costs. </p> </li> </ul>
        - `syntheticDataGeneration` object — The payment configuration for synthetic data generation for this machine learning membership.
          - `isResponsible` boolean, required — Indicates if this membership is responsible for paying for synthetic data generation.
      - `jobCompute` object — The payment responsibilities accepted by the collaboration member for job compute costs.
        - `isResponsible` boolean, required — <p>Indicates whether the collaboration member has accepted to pay for job compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs (<code>FALSE</code>).</p> <p>There can be one or more members who are designated as payer candidates for queries and jobs. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query and job compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query and job compute costs. </p> </li> </ul>
    - `isMetricsEnabled` boolean — <p>An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.</p> <p>When <code>true</code>, metrics about query execution are collected in Amazon CloudWatch.</p>

## Other responses

- `480` — ResourceNotFoundException
- `481` — InternalServerException
- `482` — ValidationException
- `483` — ThrottlingException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/cleanrooms.md) · [All operations](https://skmtc.net/aws/apis/cleanrooms/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/cleanrooms/versions/17ce59ba806e/schema)