Class: AWS.CleanRooms

var params = {
  creatorDisplayName: 'STRING_VALUE', /* required */
  creatorMemberAbilities: [ /* required */
    CAN_QUERY | CAN_RECEIVE_RESULTS,
    /* more items */
  ],
  description: 'STRING_VALUE', /* required */
  members: [ /* required */
    {
      accountId: 'STRING_VALUE', /* required */
      displayName: 'STRING_VALUE', /* required */
      memberAbilities: [ /* required */
        CAN_QUERY | CAN_RECEIVE_RESULTS,
        /* more items */
      ]
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  queryLogStatus: ENABLED | DISABLED, /* required */
  dataEncryptionMetadata: {
    allowCleartext: true || false, /* required */
    allowDuplicates: true || false, /* required */
    allowJoinsOnColumnsWithDifferentNames: true || false, /* required */
    preserveNulls: true || false /* required */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanrooms.createCollaboration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • members — (Array<map>)

    A list of initial members, not including the creator. This list is immutable.

    • accountId — required — (String)

      The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

    • memberAbilities — required — (Array<String>)

      The abilities granted to the collaboration member.

    • displayName — required — (String)

      The member's display name.

  • name — (String)

    The display name for a collaboration.

  • description — (String)

    A description of the collaboration provided by the collaboration owner.

  • creatorMemberAbilities — (Array<String>)

    The abilities granted to the collaboration creator.

  • creatorDisplayName — (String)

    The display name of the collaboration creator.

  • dataEncryptionMetadata — (map)

    The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

    • allowCleartext — required — (Boolean)

      Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

    • allowDuplicates — required — (Boolean)

      Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

    • allowJoinsOnColumnsWithDifferentNames — required — (Boolean)

      Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

    • preserveNulls — required — (Boolean)

      Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

  • queryLogStatus — (String)

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

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • collaboration — (map)

      The entire created collaboration object.

      • id — required — (String)

        The unique ID for the collaboration.

      • arn — required — (String)

        The unique ARN for the collaboration.

      • name — required — (String)

        A human-readable identifier provided by the collaboration owner. Display names are not unique.

      • description — (String)

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • creatorDisplayName — required — (String)

        A display name of the collaboration creator.

      • createTime — required — (Date)

        The time when the collaboration was created.

      • updateTime — required — (Date)

        The time the collaboration metadata was last updated.

      • memberStatus — required — (String)

        The status of a member in a collaboration.

        Possible values include:
        • "INVITED"
        • "ACTIVE"
        • "LEFT"
        • "REMOVED"
      • membershipId — (String)

        The unique ID for your membership within the collaboration.

      • membershipArn — (String)

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata — (map)

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext — required — (Boolean)

          Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

        • allowDuplicates — required — (Boolean)

          Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

        • allowJoinsOnColumnsWithDifferentNames — required — (Boolean)

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

        • preserveNulls — required — (Boolean)

          Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  allowedColumns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  analysisMethod: DIRECT_QUERY, /* required */
  name: 'STRING_VALUE', /* required */
  tableReference: { /* required */
    glue: {
      databaseName: 'STRING_VALUE', /* required */
      tableName: 'STRING_VALUE' /* required */
    }
  },
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanrooms.createConfiguredTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the configured table.

  • description — (String)

    A description for the configured table.

  • tableReference — (map)

    A reference to the AWS Glue table being configured.

    • glue — (map)

      If present, a reference to the AWS Glue table referred to by this table reference.

      • tableName — required — (String)

        The name of the AWS Glue table.

      • databaseName — required — (String)

        The name of the database the AWS Glue table belongs to.

  • allowedColumns — (Array<String>)

    The columns of the underlying table that can be used by collaborations or analysis rules.

  • analysisMethod — (String)

    The analysis method for the configured tables. The only valid value is currently DIRECT_QUERY.

    Possible values include:
    • "DIRECT_QUERY"
  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTable — (map)

      The created configured table.

      • id — required — (String)

        The unique ID for the configured table.

      • arn — required — (String)

        The unique ARN for the configured table.

      • name — required — (String)

        A name for the configured table.

      • description — (String)

        A description for the configured table.

      • tableReference — required — (map)

        The AWS Glue table that this configured table represents.

        • glue — (map)

          If present, a reference to the AWS Glue table referred to by this table reference.

          • tableName — required — (String)

            The name of the AWS Glue table.

          • databaseName — required — (String)

            The name of the database the AWS Glue table belongs to.

      • createTime — required — (Date)

        The time the configured table was created.

      • updateTime — required — (Date)

        The time the configured table was last updated

      • analysisRuleTypes — required — (Array<String>)

        The types of analysis rules associated with this configured table. Valid values are AGGREGATION and LIST. Currently, only one analysis rule may be associated with a configured table.

      • analysisMethod — required — (String)

        The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
      • allowedColumns — required — (Array<String>)

        The columns within the underlying AWS Glue table that can be utilized within collaborations.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  analysisRulePolicy: { /* required */
    v1: {
      aggregation: {
        aggregateColumns: [ /* required */
          {
            columnNames: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            function: SUM | SUM_DISTINCT | COUNT | COUNT_DISTINCT | AVG /* required */
          },
          /* more items */
        ],
        dimensionColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        joinColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        outputConstraints: [ /* required */
          {
            columnName: 'STRING_VALUE', /* required */
            minimum: 'NUMBER_VALUE', /* required */
            type: COUNT_DISTINCT /* required */
          },
          /* more items */
        ],
        scalarFunctions: [ /* required */
          TRUNC | ABS | CEILING | FLOOR | LN | LOG | ROUND | SQRT | CAST | LOWER | RTRIM | UPPER | COALESCE,
          /* more items */
        ],
        joinRequired: QUERY_RUNNER
      },
      list: {
        joinColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        listColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  analysisRuleType: AGGREGATION | LIST, /* required */
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.createConfiguredTableAnalysisRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.

  • analysisRuleType — (String)

    The type of analysis rule. Valid values are AGGREGATION and LIST.

    Possible values include:
    • "AGGREGATION"
    • "LIST"
  • analysisRulePolicy — (map)

    The entire created configured table analysis rule object.

    • v1 — (map)

      Controls on the query specifications that can be run on a configured table.

      • list — (map)

        Analysis rule type that enables only list queries on a configured table.

        • joinColumns — required — (Array<String>)

          Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

        • listColumns — required — (Array<String>)

          Columns that can be listed in the output.

      • aggregation — (map)

        Analysis rule type that enables only aggregation queries on a configured table.

        • aggregateColumns — required — (Array<map>)

          The columns that query runners are allowed to use in aggregation queries.

          • columnNames — required — (Array<String>)

            Column names in configured table of aggregate columns.

          • function — required — (String)

            Aggregation function that can be applied to aggregate column in query.

            Possible values include:
            • "SUM"
            • "SUM_DISTINCT"
            • "COUNT"
            • "COUNT_DISTINCT"
            • "AVG"
        • joinColumns — required — (Array<String>)

          Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

        • joinRequired — (String)

          Control that requires member who runs query to do a join with their configured table and/or other configured table in query

          Possible values include:
          • "QUERY_RUNNER"
        • dimensionColumns — required — (Array<String>)

          The columns that query runners are allowed to select, group by, or filter by.

        • scalarFunctions — required — (Array<String>)

          Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        • outputConstraints — required — (Array<map>)

          Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

          • columnName — required — (String)

            Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

          • minimum — required — (Integer)

            The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

          • type — required — (String)

            The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

            Possible values include:
            • "COUNT_DISTINCT"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • analysisRule — (map)

      The entire created analysis rule.

      • configuredTableId — required — (String)

        The unique ID for the configured table.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table.

      • policy — required — (map)

        The policy that controls SQL query rules.

        • v1 — (map)

          Controls on the query specifications that can be run on a configured table.

          • list — (map)

            Analysis rule type that enables only list queries on a configured table.

            • joinColumns — required — (Array<String>)

              Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

            • listColumns — required — (Array<String>)

              Columns that can be listed in the output.

          • aggregation — (map)

            Analysis rule type that enables only aggregation queries on a configured table.

            • aggregateColumns — required — (Array<map>)

              The columns that query runners are allowed to use in aggregation queries.

              • columnNames — required — (Array<String>)

                Column names in configured table of aggregate columns.

              • function — required — (String)

                Aggregation function that can be applied to aggregate column in query.

                Possible values include:
                • "SUM"
                • "SUM_DISTINCT"
                • "COUNT"
                • "COUNT_DISTINCT"
                • "AVG"
            • joinColumns — required — (Array<String>)

              Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

            • joinRequired — (String)

              Control that requires member who runs query to do a join with their configured table and/or other configured table in query

              Possible values include:
              • "QUERY_RUNNER"
            • dimensionColumns — required — (Array<String>)

              The columns that query runners are allowed to select, group by, or filter by.

            • scalarFunctions — required — (Array<String>)

              Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

            • outputConstraints — required — (Array<map>)

              Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

              • columnName — required — (String)

                Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

              • minimum — required — (Integer)

                The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

              • type — required — (String)

                The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

                Possible values include:
                • "COUNT_DISTINCT"
      • type — required — (String)

        The type of configured table analysis rule. Valid values are AGGREGATION and LIST.

        Possible values include:
        • "AGGREGATION"
        • "LIST"
      • createTime — required — (Date)

        The time the configured table analysis rule was created.

      • updateTime — required — (Date)

        The time the configured table analysis rule was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableIdentifier: 'STRING_VALUE', /* required */
  membershipIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanrooms.createConfiguredTableAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the configured table association. This name is used to query the underlying configured table.

  • description — (String)

    A description for the configured table association.

  • membershipIdentifier — (String)

    A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.

  • configuredTableIdentifier — (String)

    A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.

  • roleArn — (String)

    The service will assume this role to access catalog metadata and query the table.

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTableAssociation — (map)

      The entire configured table association object.

      • arn — required — (String)

        The unique ARN for the configured table association.

      • id — required — (String)

        The unique ID for the configured table association.

      • configuredTableId — required — (String)

        The unique ID for the configured table that the association refers to.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table that the association refers to.

      • membershipId — required — (String)

        The unique ID for the membership this configured table association belongs to.

      • membershipArn — required — (String)

        The unique ARN for the membership this configured table association belongs to.

      • roleArn — required — (String)

        The service will assume this role to access catalog metadata and query the table.

      • name — required — (String)

        The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

      • description — (String)

        A description of the configured table association.

      • createTime — required — (Date)

        The time the configured table association was created.

      • updateTime — required — (Date)

        The time the configured table association was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  queryLogStatus: ENABLED | DISABLED, /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanrooms.createMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The unique ID for the associated collaboration.

  • queryLogStatus — (String)

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

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • membership — (map)

      The membership that was created.

      • id — required — (String)

        The unique ID of the membership.

      • arn — required — (String)

        The unique ARN for the membership.

      • collaborationArn — required — (String)

        The unique ARN for the membership's associated collaboration.

      • collaborationId — required — (String)

        The unique ID for the membership's collaboration.

      • collaborationCreatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • collaborationCreatorDisplayName — required — (String)

        The display name of the collaboration creator.

      • collaborationName — required — (String)

        The name of the membership's collaboration.

      • createTime — required — (Date)

        The time when the membership was created.

      • updateTime — required — (Date)

        The time the membership metadata was last updated.

      • status — required — (String)

        The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

        Possible values include:
        • "ACTIVE"
        • "REMOVED"
        • "COLLABORATION_DELETED"
      • memberAbilities — required — (Array<String>)

        The abilities granted to the collaboration member.

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteCollaboration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The identifier for the collaboration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteConfiguredTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The unique ID for the configured table to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  analysisRuleType: AGGREGATION | LIST, /* required */
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteConfiguredTableAnalysisRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.

  • analysisRuleType — (String)

    The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

    Possible values include:
    • "AGGREGATION"
    • "LIST"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableAssociationIdentifier: 'STRING_VALUE', /* required */
  membershipIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteConfiguredTableAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableAssociationIdentifier — (String)

    The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.

  • membershipIdentifier — (String)

    A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  accountId: 'STRING_VALUE', /* required */
  collaborationIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The unique identifier for the associated collaboration.

  • accountId — (String)

    The account ID of the member to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.deleteMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The identifier for a membership resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getCollaboration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The identifier for the collaboration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • collaboration — (map)

      The entire collaboration for this identifier.

      • id — required — (String)

        The unique ID for the collaboration.

      • arn — required — (String)

        The unique ARN for the collaboration.

      • name — required — (String)

        A human-readable identifier provided by the collaboration owner. Display names are not unique.

      • description — (String)

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • creatorDisplayName — required — (String)

        A display name of the collaboration creator.

      • createTime — required — (Date)

        The time when the collaboration was created.

      • updateTime — required — (Date)

        The time the collaboration metadata was last updated.

      • memberStatus — required — (String)

        The status of a member in a collaboration.

        Possible values include:
        • "INVITED"
        • "ACTIVE"
        • "LEFT"
        • "REMOVED"
      • membershipId — (String)

        The unique ID for your membership within the collaboration.

      • membershipArn — (String)

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata — (map)

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext — required — (Boolean)

          Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

        • allowDuplicates — required — (Boolean)

          Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

        • allowJoinsOnColumnsWithDifferentNames — required — (Boolean)

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

        • preserveNulls — required — (Boolean)

          Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getConfiguredTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The unique ID for the configured table to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTable — (map)

      The retrieved configured table.

      • id — required — (String)

        The unique ID for the configured table.

      • arn — required — (String)

        The unique ARN for the configured table.

      • name — required — (String)

        A name for the configured table.

      • description — (String)

        A description for the configured table.

      • tableReference — required — (map)

        The AWS Glue table that this configured table represents.

        • glue — (map)

          If present, a reference to the AWS Glue table referred to by this table reference.

          • tableName — required — (String)

            The name of the AWS Glue table.

          • databaseName — required — (String)

            The name of the database the AWS Glue table belongs to.

      • createTime — required — (Date)

        The time the configured table was created.

      • updateTime — required — (Date)

        The time the configured table was last updated

      • analysisRuleTypes — required — (Array<String>)

        The types of analysis rules associated with this configured table. Valid values are AGGREGATION and LIST. Currently, only one analysis rule may be associated with a configured table.

      • analysisMethod — required — (String)

        The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
      • allowedColumns — required — (Array<String>)

        The columns within the underlying AWS Glue table that can be utilized within collaborations.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  analysisRuleType: AGGREGATION | LIST, /* required */
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getConfiguredTableAnalysisRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.

  • analysisRuleType — (String)

    The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

    Possible values include:
    • "AGGREGATION"
    • "LIST"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • analysisRule — (map)

      The entire analysis rule output.

      • configuredTableId — required — (String)

        The unique ID for the configured table.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table.

      • policy — required — (map)

        The policy that controls SQL query rules.

        • v1 — (map)

          Controls on the query specifications that can be run on a configured table.

          • list — (map)

            Analysis rule type that enables only list queries on a configured table.

            • joinColumns — required — (Array<String>)

              Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

            • listColumns — required — (Array<String>)

              Columns that can be listed in the output.

          • aggregation — (map)

            Analysis rule type that enables only aggregation queries on a configured table.

            • aggregateColumns — required — (Array<map>)

              The columns that query runners are allowed to use in aggregation queries.

              • columnNames — required — (Array<String>)

                Column names in configured table of aggregate columns.

              • function — required — (String)

                Aggregation function that can be applied to aggregate column in query.

                Possible values include:
                • "SUM"
                • "SUM_DISTINCT"
                • "COUNT"
                • "COUNT_DISTINCT"
                • "AVG"
            • joinColumns — required — (Array<String>)

              Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

            • joinRequired — (String)

              Control that requires member who runs query to do a join with their configured table and/or other configured table in query

              Possible values include:
              • "QUERY_RUNNER"
            • dimensionColumns — required — (Array<String>)

              The columns that query runners are allowed to select, group by, or filter by.

            • scalarFunctions — required — (Array<String>)

              Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

            • outputConstraints — required — (Array<map>)

              Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

              • columnName — required — (String)

                Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

              • minimum — required — (Integer)

                The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

              • type — required — (String)

                The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

                Possible values include:
                • "COUNT_DISTINCT"
      • type — required — (String)

        The type of configured table analysis rule. Valid values are AGGREGATION and LIST.

        Possible values include:
        • "AGGREGATION"
        • "LIST"
      • createTime — required — (Date)

        The time the configured table analysis rule was created.

      • updateTime — required — (Date)

        The time the configured table analysis rule was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableAssociationIdentifier: 'STRING_VALUE', /* required */
  membershipIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getConfiguredTableAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableAssociationIdentifier — (String)

    The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

  • membershipIdentifier — (String)

    A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTableAssociation — (map)

      The entire configured table association object.

      • arn — required — (String)

        The unique ARN for the configured table association.

      • id — required — (String)

        The unique ID for the configured table association.

      • configuredTableId — required — (String)

        The unique ID for the configured table that the association refers to.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table that the association refers to.

      • membershipId — required — (String)

        The unique ID for the membership this configured table association belongs to.

      • membershipArn — required — (String)

        The unique ARN for the membership this configured table association belongs to.

      • roleArn — required — (String)

        The service will assume this role to access catalog metadata and query the table.

      • name — required — (String)

        The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

      • description — (String)

        A description of the configured table association.

      • createTime — required — (Date)

        The time the configured table association was created.

      • updateTime — required — (Date)

        The time the configured table association was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The identifier for a membership resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • membership — (map)

      The membership retrieved for the provided identifier.

      • id — required — (String)

        The unique ID of the membership.

      • arn — required — (String)

        The unique ARN for the membership.

      • collaborationArn — required — (String)

        The unique ARN for the membership's associated collaboration.

      • collaborationId — required — (String)

        The unique ID for the membership's collaboration.

      • collaborationCreatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • collaborationCreatorDisplayName — required — (String)

        The display name of the collaboration creator.

      • collaborationName — required — (String)

        The name of the membership's collaboration.

      • createTime — required — (Date)

        The time when the membership was created.

      • updateTime — required — (Date)

        The time the membership metadata was last updated.

      • status — required — (String)

        The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

        Possible values include:
        • "ACTIVE"
        • "REMOVED"
        • "COLLABORATION_DELETED"
      • memberAbilities — required — (Array<String>)

        The abilities granted to the collaboration member.

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  protectedQueryIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.getProtectedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The identifier for a membership in a protected query instance.

  • protectedQueryIdentifier — (String)

    The identifier for a protected query instance.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • protectedQuery — (map)

      The query processing metadata.

      • id — required — (String)

        The identifier for a protected query instance.

      • membershipId — required — (String)

        The identifier for the membership.

      • membershipArn — required — (String)

        The ARN of the membership.

      • createTime — required — (Date)

        The time at which the protected query was created.

      • sqlParameters — required — (map)

        The protected query SQL parameters.

        • queryString — required — (String)

          The query string to be submitted.

      • status — required — (String)

        The status of the query.

        Possible values include:
        • "SUBMITTED"
        • "STARTED"
        • "CANCELLED"
        • "CANCELLING"
        • "FAILED"
        • "SUCCESS"
        • "TIMED_OUT"
      • resultConfiguration — required — (map)

        Contains any details needed to write the query results.

        • outputConfiguration — required — (map)

          Configuration for protected query results.

          • s3 — (map)

            Required configuration for a protected query with an S3 output type.

            • resultFormat — required — (String)

              Intended file format of the result.

              Possible values include:
              • "CSV"
              • "PARQUET"
            • bucket — required — (String)

              The S3 bucket to unload the protected query results.

            • keyPrefix — (String)

              The S3 prefix to unload the protected query results.

      • statistics — (map)

        Statistics about protected query execution.

        • totalDurationInMillis — (Integer)

          The duration of the Protected Query, from creation until query completion.

      • result — (map)

        The result of the protected query.

        • output — required — (map)

          The output of the protected query.

          • s3 — (map)

            If present, the output for a protected query with an S3 output type.

            • location — required — (String)

              The S3 location of the result.

      • error — (map)

        An error thrown by the protected query.

        • message — required — (String)

          A description of why the query failed.

        • code — required — (String)

          An error code for the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
cleanrooms.getSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • name — (String)

    The name of the relation to retrieve the schema for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • schema — (map)

      The entire schema object.

      • columns — required — (Array<map>)

        The columns for the relation this schema represents.

        • name — required — (String)

          The name of the column.

        • type — required — (String)

          The type of the column.

      • partitionKeys — required — (Array<map>)

        The partition keys for the dataset underlying this schema.

        • name — required — (String)

          The name of the column.

        • type — required — (String)

          The type of the column.

      • analysisRuleTypes — required — (Array<String>)

        The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.

      • analysisMethod — (String)

        The analysis method for the schema. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
      • creatorAccountId — required — (String)

        The unique account ID for the AWS account that owns the schema.

      • name — required — (String)

        A name for the schema. The schema relation is referred to by this name when queried by a protected query.

      • collaborationId — required — (String)

        The unique ID for the collaboration that the schema belongs to.

      • collaborationArn — required — (String)

        The unique ARN for the collaboration that the schema belongs to.

      • description — required — (String)

        A description for the schema.

      • createTime — required — (Date)

        The time the schema was created.

      • updateTime — required — (Date)

        The time the schema was last updated.

      • type — required — (String)

        The type of schema. The only valid value is currently TABLE.

        Possible values include:
        • "TABLE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: AGGREGATION | LIST /* required */
};
cleanrooms.getSchemaAnalysisRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • name — (String)

    The name of the schema to retrieve the analysis rule for.

  • type — (String)

    The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

    Possible values include:
    • "AGGREGATION"
    • "LIST"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • analysisRule — (map)

      A specification about how data from the configured table can be used.

      • collaborationId — required — (String)

        The unique ID for the associated collaboration.

      • type — required — (String)

        The type of analysis rule. Valid values are AGGREGATION and LIST.

        Possible values include:
        • "AGGREGATION"
        • "LIST"
      • name — required — (String)

        The name for the analysis rule.

      • createTime — required — (Date)

        The time the analysis rule was created.

      • updateTime — required — (Date)

        The time the analysis rule was last updated.

      • policy — required — (map)

        A policy that describes the associated data usage limitations.

        • v1 — (map)

          Controls on the query specifications that can be run on configured table..

          • list — (map)

            Analysis rule type that enables only list queries on a configured table.

            • joinColumns — required — (Array<String>)

              Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

            • listColumns — required — (Array<String>)

              Columns that can be listed in the output.

          • aggregation — (map)

            Analysis rule type that enables only aggregation queries on a configured table.

            • aggregateColumns — required — (Array<map>)

              The columns that query runners are allowed to use in aggregation queries.

              • columnNames — required — (Array<String>)

                Column names in configured table of aggregate columns.

              • function — required — (String)

                Aggregation function that can be applied to aggregate column in query.

                Possible values include:
                • "SUM"
                • "SUM_DISTINCT"
                • "COUNT"
                • "COUNT_DISTINCT"
                • "AVG"
            • joinColumns — required — (Array<String>)

              Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

            • joinRequired — (String)

              Control that requires member who runs query to do a join with their configured table and/or other configured table in query

              Possible values include:
              • "QUERY_RUNNER"
            • dimensionColumns — required — (Array<String>)

              The columns that query runners are allowed to select, group by, or filter by.

            • scalarFunctions — required — (Array<String>)

              Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

            • outputConstraints — required — (Array<map>)

              Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

              • columnName — required — (String)

                Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

              • minimum — required — (Integer)

                The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

              • type — required — (String)

                The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

                Possible values include:
                • "COUNT_DISTINCT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  memberStatus: INVITED | ACTIVE,
  nextToken: 'STRING_VALUE'
};
cleanrooms.listCollaborations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

  • memberStatus — (String)

    The caller's status in a collaboration.

    Possible values include:
    • "INVITED"
    • "ACTIVE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • collaborationList — (Array<map>)

      The list of collaborations.

      • id — required — (String)

        The identifier for the collaboration.

      • arn — required — (String)

        The ARN of the collaboration.

      • name — required — (String)

        A human-readable identifier provided by the collaboration owner. Display names are not unique.

      • creatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

      • creatorDisplayName — required — (String)

        The display name of the collaboration creator.

      • createTime — required — (Date)

        The time when the collaboration was created.

      • updateTime — required — (Date)

        The time the collaboration metadata was last updated.

      • memberStatus — required — (String)

        The status of a member in a collaboration.

        Possible values include:
        • "INVITED"
        • "ACTIVE"
        • "LEFT"
        • "REMOVED"
      • membershipId — (String)

        The identifier of a member in a collaboration.

      • membershipArn — (String)

        The ARN of a member in a collaboration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanrooms.listConfiguredTableAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTableAssociationSummaries — (Array<map>)

      The retrieved list of configured table associations.

      • configuredTableId — required — (String)

        The unique configured table ID that this configured table association refers to.

      • membershipId — required — (String)

        The unique ID for the membership that the configured table association belongs to.

      • membershipArn — required — (String)

        The unique ARN for the membership that the configured table association belongs to.

      • name — required — (String)

        The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.

      • createTime — required — (Date)

        The time the configured table association was created.

      • updateTime — required — (Date)

        The time the configured table association was last updated.

      • id — required — (String)

        The unique ID for the configured table association.

      • arn — required — (String)

        The unique ARN for the configured table association.

    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanrooms.listConfiguredTables(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTableSummaries — (Array<map>)

      The configured tables listed by the request.

      • id — required — (String)

        The unique ID of the configured table.

      • arn — required — (String)

        The unique ARN of the configured table.

      • name — required — (String)

        The name of the configured table.

      • createTime — required — (Date)

        The time the configured table was created.

      • updateTime — required — (Date)

        The time the configured table was last updated.

      • analysisRuleTypes — required — (Array<String>)

        The types of analysis rules associated with this configured table.

      • analysisMethod — required — (String)

        The analysis method for the configured tables. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
cleanrooms.listMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The identifier of the collaboration in which the members are listed.

  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • memberSummaries — (Array<map>)

      The list of members returned by the ListMembers operation.

      • accountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

      • status — required — (String)

        The status of the member. Valid values are INVITED, ACTIVE, LEFT, and REMOVED.

        Possible values include:
        • "INVITED"
        • "ACTIVE"
        • "LEFT"
        • "REMOVED"
      • displayName — required — (String)

        The member's display name.

      • abilities — required — (Array<String>)

        The abilities granted to the collaboration member.

      • createTime — required — (Date)

        The time when the member was created.

      • updateTime — required — (Date)

        The time the member metadata was last updated.

      • membershipId — (String)

        The unique ID for the member's associated membership, if present.

      • membershipArn — (String)

        The unique ARN for the member's associated membership, if present.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: ACTIVE | REMOVED | COLLABORATION_DELETED
};
cleanrooms.listMemberships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call.

  • status — (String)

    A filter which will return only memberships in the specified status.

    Possible values include:
    • "ACTIVE"
    • "REMOVED"
    • "COLLABORATION_DELETED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • membershipSummaries — (Array<map>)

      The list of memberships returned from the ListMemberships operation.

      • id — required — (String)

        The unique ID for the membership's collaboration.

      • arn — required — (String)

        The unique ARN for the membership.

      • collaborationArn — required — (String)

        The unique ARN for the membership's associated collaboration.

      • collaborationId — required — (String)

        The unique ID for the membership's collaboration.

      • collaborationCreatorAccountId — required — (String)

        The identifier of the AWS principal that created the collaboration. Currently only supports AWS account ID.

      • collaborationCreatorDisplayName — required — (String)

        The display name of the collaboration creator.

      • collaborationName — required — (String)

        The name for the membership's collaboration.

      • createTime — required — (Date)

        The time when the membership was created.

      • updateTime — required — (Date)

        The time the membership metadata was last updated.

      • status — required — (String)

        The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

        Possible values include:
        • "ACTIVE"
        • "REMOVED"
        • "COLLABORATION_DELETED"
      • memberAbilities — required — (Array<String>)

        The abilities granted to the collaboration member.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT
};
cleanrooms.listProtectedQueries(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The identifier for the membership in the collaboration.

  • status — (String)

    A filter on the status of the protected query.

    Possible values include:
    • "SUBMITTED"
    • "STARTED"
    • "CANCELLED"
    • "CANCELLING"
    • "FAILED"
    • "SUCCESS"
    • "TIMED_OUT"
  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • protectedQueries — (Array<map>)

      A list of protected queries.

      • id — required — (String)

        The unique ID of the protected query.

      • membershipId — required — (String)

        The unique ID for the membership that initiated the protected query.

      • membershipArn — required — (String)

        The unique ARN for the membership that initiated the protected query.

      • createTime — required — (Date)

        The time the protected query was created.

      • status — required — (String)

        The status of the protected query. Value values are SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS, TIMED_OUT.

        Possible values include:
        • "SUBMITTED"
        • "STARTED"
        • "CANCELLED"
        • "CANCELLING"
        • "FAILED"
        • "SUCCESS"
        • "TIMED_OUT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  schemaType: TABLE
};
cleanrooms.listSchemas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

  • schemaType — (String)

    If present, filter schemas by schema type. The only valid schema type is currently TABLE.

    Possible values include:
    • "TABLE"
  • nextToken — (String)

    The token value retrieved from a previous call to access the next page of results.

  • maxResults — (Integer)

    The maximum size of the results that is returned per call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • schemaSummaries — (Array<map>)

      The retrieved list of schemas.

      • name — required — (String)

        The name for the schema object.

      • type — required — (String)

        The type of schema object. The only valid schema type is currently TABLE.

        Possible values include:
        • "TABLE"
      • creatorAccountId — required — (String)

        The unique account ID for the AWS account that owns the schema.

      • createTime — required — (Date)

        The time the schema object was created.

      • updateTime — required — (Date)

        The time the schema object was last updated.

      • collaborationId — required — (String)

        The unique ID for the collaboration that the schema belongs to.

      • collaborationArn — required — (String)

        The unique ARN for the collaboration that the schema belongs to.

      • analysisRuleTypes — required — (Array<String>)

        The types of analysis rules that are associated with this schema object.

      • analysisMethod — (String)

        The analysis method for the associated schema. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
    • nextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
cleanrooms.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      A map of objects specifying each key name and value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  resultConfiguration: { /* required */
    outputConfiguration: { /* required */
      s3: {
        bucket: 'STRING_VALUE', /* required */
        resultFormat: CSV | PARQUET, /* required */
        keyPrefix: 'STRING_VALUE'
      }
    }
  },
  sqlParameters: { /* required */
    queryString: 'STRING_VALUE' /* required */
  },
  type: SQL /* required */
};
cleanrooms.startProtectedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • type — (String)

    The type of the protected query to be started.

    Possible values include:
    • "SQL"
  • membershipIdentifier — (String)

    A unique identifier for the membership to run this query against. Currently accepts a membership ID.

  • sqlParameters — (map)

    The protected SQL query parameters.

    • queryString — required — (String)

      The query string to be submitted.

  • resultConfiguration — (map)

    The details needed to write the query results.

    • outputConfiguration — required — (map)

      Configuration for protected query results.

      • s3 — (map)

        Required configuration for a protected query with an S3 output type.

        • resultFormat — required — (String)

          Intended file format of the result.

          Possible values include:
          • "CSV"
          • "PARQUET"
        • bucket — required — (String)

          The S3 bucket to unload the protected query results.

        • keyPrefix — (String)

          The S3 prefix to unload the protected query results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • protectedQuery — (map)

      The protected query.

      • id — required — (String)

        The identifier for a protected query instance.

      • membershipId — required — (String)

        The identifier for the membership.

      • membershipArn — required — (String)

        The ARN of the membership.

      • createTime — required — (Date)

        The time at which the protected query was created.

      • sqlParameters — required — (map)

        The protected query SQL parameters.

        • queryString — required — (String)

          The query string to be submitted.

      • status — required — (String)

        The status of the query.

        Possible values include:
        • "SUBMITTED"
        • "STARTED"
        • "CANCELLED"
        • "CANCELLING"
        • "FAILED"
        • "SUCCESS"
        • "TIMED_OUT"
      • resultConfiguration — required — (map)

        Contains any details needed to write the query results.

        • outputConfiguration — required — (map)

          Configuration for protected query results.

          • s3 — (map)

            Required configuration for a protected query with an S3 output type.

            • resultFormat — required — (String)

              Intended file format of the result.

              Possible values include:
              • "CSV"
              • "PARQUET"
            • bucket — required — (String)

              The S3 bucket to unload the protected query results.

            • keyPrefix — (String)

              The S3 prefix to unload the protected query results.

      • statistics — (map)

        Statistics about protected query execution.

        • totalDurationInMillis — (Integer)

          The duration of the Protected Query, from creation until query completion.

      • result — (map)

        The result of the protected query.

        • output — required — (map)

          The output of the protected query.

          • s3 — (map)

            If present, the output for a protected query with an S3 output type.

            • location — required — (String)

              The S3 location of the result.

      • error — (map)

        An error thrown by the protected query.

        • message — required — (String)

          A description of why the query failed.

        • code — required — (String)

          An error code for the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cleanrooms.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) associated with the resource you want to tag.

  • tags — (map<String>)

    A map of objects specifying each key name and value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cleanrooms.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

  • tagKeys — (Array<String>)

    A list of key names of tags to be removed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  collaborationIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
cleanrooms.updateCollaboration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • collaborationIdentifier — (String)

    The identifier for the collaboration.

  • name — (String)

    A human-readable identifier provided by the collaboration owner. Display names are not unique.

  • description — (String)

    A description of the collaboration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • collaboration — (map)

      The entire collaboration that has been updated.

      • id — required — (String)

        The unique ID for the collaboration.

      • arn — required — (String)

        The unique ARN for the collaboration.

      • name — required — (String)

        A human-readable identifier provided by the collaboration owner. Display names are not unique.

      • description — (String)

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • creatorDisplayName — required — (String)

        A display name of the collaboration creator.

      • createTime — required — (Date)

        The time when the collaboration was created.

      • updateTime — required — (Date)

        The time the collaboration metadata was last updated.

      • memberStatus — required — (String)

        The status of a member in a collaboration.

        Possible values include:
        • "INVITED"
        • "ACTIVE"
        • "LEFT"
        • "REMOVED"
      • membershipId — (String)

        The unique ID for your membership within the collaboration.

      • membershipArn — (String)

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata — (map)

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext — required — (Boolean)

          Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

        • allowDuplicates — required — (Boolean)

          Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

        • allowJoinsOnColumnsWithDifferentNames — required — (Boolean)

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

        • preserveNulls — required — (Boolean)

          Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
cleanrooms.updateConfiguredTable(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The identifier for the configured table to update. Currently accepts the configured table ID.

  • name — (String)

    A new name for the configured table.

  • description — (String)

    A new description for the configured table.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTable — (map)

      The updated configured table.

      • id — required — (String)

        The unique ID for the configured table.

      • arn — required — (String)

        The unique ARN for the configured table.

      • name — required — (String)

        A name for the configured table.

      • description — (String)

        A description for the configured table.

      • tableReference — required — (map)

        The AWS Glue table that this configured table represents.

        • glue — (map)

          If present, a reference to the AWS Glue table referred to by this table reference.

          • tableName — required — (String)

            The name of the AWS Glue table.

          • databaseName — required — (String)

            The name of the database the AWS Glue table belongs to.

      • createTime — required — (Date)

        The time the configured table was created.

      • updateTime — required — (Date)

        The time the configured table was last updated

      • analysisRuleTypes — required — (Array<String>)

        The types of analysis rules associated with this configured table. Valid values are AGGREGATION and LIST. Currently, only one analysis rule may be associated with a configured table.

      • analysisMethod — required — (String)

        The analysis method for the configured table. The only valid value is currently DIRECT_QUERY.

        Possible values include:
        • "DIRECT_QUERY"
      • allowedColumns — required — (Array<String>)

        The columns within the underlying AWS Glue table that can be utilized within collaborations.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  analysisRulePolicy: { /* required */
    v1: {
      aggregation: {
        aggregateColumns: [ /* required */
          {
            columnNames: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            function: SUM | SUM_DISTINCT | COUNT | COUNT_DISTINCT | AVG /* required */
          },
          /* more items */
        ],
        dimensionColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        joinColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        outputConstraints: [ /* required */
          {
            columnName: 'STRING_VALUE', /* required */
            minimum: 'NUMBER_VALUE', /* required */
            type: COUNT_DISTINCT /* required */
          },
          /* more items */
        ],
        scalarFunctions: [ /* required */
          TRUNC | ABS | CEILING | FLOOR | LN | LOG | ROUND | SQRT | CAST | LOWER | RTRIM | UPPER | COALESCE,
          /* more items */
        ],
        joinRequired: QUERY_RUNNER
      },
      list: {
        joinColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        listColumns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  analysisRuleType: AGGREGATION | LIST, /* required */
  configuredTableIdentifier: 'STRING_VALUE' /* required */
};
cleanrooms.updateConfiguredTableAnalysisRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableIdentifier — (String)

    The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.

  • analysisRuleType — (String)

    The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

    Possible values include:
    • "AGGREGATION"
    • "LIST"
  • analysisRulePolicy — (map)

    The new analysis rule policy for the configured table analysis rule.

    • v1 — (map)

      Controls on the query specifications that can be run on a configured table.

      • list — (map)

        Analysis rule type that enables only list queries on a configured table.

        • joinColumns — required — (Array<String>)

          Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

        • listColumns — required — (Array<String>)

          Columns that can be listed in the output.

      • aggregation — (map)

        Analysis rule type that enables only aggregation queries on a configured table.

        • aggregateColumns — required — (Array<map>)

          The columns that query runners are allowed to use in aggregation queries.

          • columnNames — required — (Array<String>)

            Column names in configured table of aggregate columns.

          • function — required — (String)

            Aggregation function that can be applied to aggregate column in query.

            Possible values include:
            • "SUM"
            • "SUM_DISTINCT"
            • "COUNT"
            • "COUNT_DISTINCT"
            • "AVG"
        • joinColumns — required — (Array<String>)

          Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

        • joinRequired — (String)

          Control that requires member who runs query to do a join with their configured table and/or other configured table in query

          Possible values include:
          • "QUERY_RUNNER"
        • dimensionColumns — required — (Array<String>)

          The columns that query runners are allowed to select, group by, or filter by.

        • scalarFunctions — required — (Array<String>)

          Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

        • outputConstraints — required — (Array<map>)

          Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

          • columnName — required — (String)

            Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

          • minimum — required — (Integer)

            The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

          • type — required — (String)

            The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

            Possible values include:
            • "COUNT_DISTINCT"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • analysisRule — (map)

      The entire updated analysis rule.

      • configuredTableId — required — (String)

        The unique ID for the configured table.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table.

      • policy — required — (map)

        The policy that controls SQL query rules.

        • v1 — (map)

          Controls on the query specifications that can be run on a configured table.

          • list — (map)

            Analysis rule type that enables only list queries on a configured table.

            • joinColumns — required — (Array<String>)

              Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.

            • listColumns — required — (Array<String>)

              Columns that can be listed in the output.

          • aggregation — (map)

            Analysis rule type that enables only aggregation queries on a configured table.

            • aggregateColumns — required — (Array<map>)

              The columns that query runners are allowed to use in aggregation queries.

              • columnNames — required — (Array<String>)

                Column names in configured table of aggregate columns.

              • function — required — (String)

                Aggregation function that can be applied to aggregate column in query.

                Possible values include:
                • "SUM"
                • "SUM_DISTINCT"
                • "COUNT"
                • "COUNT_DISTINCT"
                • "AVG"
            • joinColumns — required — (Array<String>)

              Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

            • joinRequired — (String)

              Control that requires member who runs query to do a join with their configured table and/or other configured table in query

              Possible values include:
              • "QUERY_RUNNER"
            • dimensionColumns — required — (Array<String>)

              The columns that query runners are allowed to select, group by, or filter by.

            • scalarFunctions — required — (Array<String>)

              Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

            • outputConstraints — required — (Array<map>)

              Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

              • columnName — required — (String)

                Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

              • minimum — required — (Integer)

                The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.

              • type — required — (String)

                The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.

                Possible values include:
                • "COUNT_DISTINCT"
      • type — required — (String)

        The type of configured table analysis rule. Valid values are AGGREGATION and LIST.

        Possible values include:
        • "AGGREGATION"
        • "LIST"
      • createTime — required — (Date)

        The time the configured table analysis rule was created.

      • updateTime — required — (Date)

        The time the configured table analysis rule was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuredTableAssociationIdentifier: 'STRING_VALUE', /* required */
  membershipIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  roleArn: 'STRING_VALUE'
};
cleanrooms.updateConfiguredTableAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuredTableAssociationIdentifier — (String)

    The unique identifier for the configured table association to update. Currently accepts the configured table association ID.

  • membershipIdentifier — (String)

    The unique ID for the membership that the configured table association belongs to.

  • description — (String)

    A new description for the configured table association.

  • roleArn — (String)

    The service will assume this role to access catalog metadata and query the table.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuredTableAssociation — (map)

      The entire updated configured table association.

      • arn — required — (String)

        The unique ARN for the configured table association.

      • id — required — (String)

        The unique ID for the configured table association.

      • configuredTableId — required — (String)

        The unique ID for the configured table that the association refers to.

      • configuredTableArn — required — (String)

        The unique ARN for the configured table that the association refers to.

      • membershipId — required — (String)

        The unique ID for the membership this configured table association belongs to.

      • membershipArn — required — (String)

        The unique ARN for the membership this configured table association belongs to.

      • roleArn — required — (String)

        The service will assume this role to access catalog metadata and query the table.

      • name — required — (String)

        The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

      • description — (String)

        A description of the configured table association.

      • createTime — required — (Date)

        The time the configured table association was created.

      • updateTime — required — (Date)

        The time the configured table association was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  queryLogStatus: ENABLED | DISABLED
};
cleanrooms.updateMembership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The unique identifier of the membership.

  • queryLogStatus — (String)

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

    Possible values include:
    • "ENABLED"
    • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • membership — (map)

      The membership object.

      • id — required — (String)

        The unique ID of the membership.

      • arn — required — (String)

        The unique ARN for the membership.

      • collaborationArn — required — (String)

        The unique ARN for the membership's associated collaboration.

      • collaborationId — required — (String)

        The unique ID for the membership's collaboration.

      • collaborationCreatorAccountId — required — (String)

        The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

      • collaborationCreatorDisplayName — required — (String)

        The display name of the collaboration creator.

      • collaborationName — required — (String)

        The name of the membership's collaboration.

      • createTime — required — (Date)

        The time when the membership was created.

      • updateTime — required — (Date)

        The time the membership metadata was last updated.

      • status — required — (String)

        The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

        Possible values include:
        • "ACTIVE"
        • "REMOVED"
        • "COLLABORATION_DELETED"
      • memberAbilities — required — (Array<String>)

        The abilities granted to the collaboration member.

      • queryLogStatus — required — (String)

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

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  membershipIdentifier: 'STRING_VALUE', /* required */
  protectedQueryIdentifier: 'STRING_VALUE', /* required */
  targetStatus: CANCELLED /* required */
};
cleanrooms.updateProtectedQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • membershipIdentifier — (String)

    The identifier for a member of a protected query instance.

  • protectedQueryIdentifier — (String)

    The identifier for a protected query instance.

  • targetStatus — (String)

    The target status of a query. Used to update the execution status of a currently running query.

    Possible values include:
    • "CANCELLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • protectedQuery — (map)

      The protected query output.

      • id — required — (String)

        The identifier for a protected query instance.

      • membershipId — required — (String)

        The identifier for the membership.

      • membershipArn — required — (String)

        The ARN of the membership.

      • createTime — required — (Date)

        The time at which the protected query was created.

      • sqlParameters — required — (map)

        The protected query SQL parameters.

        • queryString — required — (String)

          The query string to be submitted.

      • status — required — (String)

        The status of the query.

        Possible values include:
        • "SUBMITTED"
        • "STARTED"
        • "CANCELLED"
        • "CANCELLING"
        • "FAILED"
        • "SUCCESS"
        • "TIMED_OUT"
      • resultConfiguration — required — (map)

        Contains any details needed to write the query results.

        • outputConfiguration — required — (map)

          Configuration for protected query results.

          • s3 — (map)

            Required configuration for a protected query with an S3 output type.

            • resultFormat — required — (String)

              Intended file format of the result.

              Possible values include:
              • "CSV"
              • "PARQUET"
            • bucket — required — (String)

              The S3 bucket to unload the protected query results.

            • keyPrefix — (String)

              The S3 prefix to unload the protected query results.

      • statistics — (map)

        Statistics about protected query execution.

        • totalDurationInMillis — (Integer)

          The duration of the Protected Query, from creation until query completion.

      • result — (map)

        The result of the protected query.

        • output — required — (map)

          The output of the protected query.

          • s3 — (map)

            If present, the output for a protected query with an S3 output type.

            • location — required — (String)

              The S3 location of the result.

      • error — (map)

        An error thrown by the protected query.

        • message — required — (String)

          A description of why the query failed.

        • code — required — (String)

          An error code for the error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.