Skip to content

Commit

Permalink
feat(client-cleanrooms): This release introduces custom SQL queries -…
Browse files Browse the repository at this point in the history 
… an expanded set of SQL you can run. This release adds analysis templates, a new resource for storing pre-defined custom SQL queries ahead of time. This release also adds the Custom analysis rule, which lets you approve analysis templates for querying.
  • Loading branch information
awstools committed Jul 31, 2023
1 parent 721c19a commit d50fb3f
Show file tree
Hide file tree
Showing 33 changed files with 5,752 additions and 536 deletions.
78 changes: 71 additions & 7 deletions clients/client-cleanrooms/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ using your favorite package manager:

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the `CleanRoomsClient` and
the commands you need, for example `BatchGetSchemaCommand`:
the commands you need, for example `BatchGetCollaborationAnalysisTemplateCommand`:

```js
// ES5 example
const { CleanRoomsClient, BatchGetSchemaCommand } = require("@aws-sdk/client-cleanrooms");
const { CleanRoomsClient, BatchGetCollaborationAnalysisTemplateCommand } = require("@aws-sdk/client-cleanrooms");
```

```ts
// ES6+ example
import { CleanRoomsClient, BatchGetSchemaCommand } from "@aws-sdk/client-cleanrooms";
import { CleanRoomsClient, BatchGetCollaborationAnalysisTemplateCommand } from "@aws-sdk/client-cleanrooms";
```

### Usage
Expand All @@ -57,7 +57,7 @@ const client = new CleanRoomsClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new BatchGetSchemaCommand(params);
const command = new BatchGetCollaborationAnalysisTemplateCommand(params);
```

#### Async/await
Expand Down Expand Up @@ -136,15 +136,15 @@ const client = new AWS.CleanRooms({ region: "REGION" });

// async/await.
try {
const data = await client.batchGetSchema(params);
const data = await client.batchGetCollaborationAnalysisTemplate(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.batchGetSchema(params)
.batchGetCollaborationAnalysisTemplate(params)
.then((data) => {
// process data.
})
Expand All @@ -153,7 +153,7 @@ client
});

// callbacks.
client.batchGetSchema(params, (err, data) => {
client.batchGetCollaborationAnalysisTemplate(params, (err, data) => {
// process err and data.
});
```
Expand Down Expand Up @@ -209,13 +209,29 @@ see LICENSE for more information.

## Client Commands (Operations List)

<details>
<summary>
BatchGetCollaborationAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/batchgetcollaborationanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/batchgetcollaborationanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/batchgetcollaborationanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
BatchGetSchema
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/batchgetschemacommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/batchgetschemacommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/batchgetschemacommandoutput.html)

</details>
<details>
<summary>
CreateAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/createanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/createanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/createanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -256,6 +272,14 @@ CreateMembership

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/createmembershipcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/createmembershipcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/createmembershipcommandoutput.html)

</details>
<details>
<summary>
DeleteAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/deleteanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/deleteanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/deleteanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -304,6 +328,14 @@ DeleteMembership

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/deletemembershipcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/deletemembershipcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/deletemembershipcommandoutput.html)

</details>
<details>
<summary>
GetAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/getanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -312,6 +344,14 @@ GetCollaboration

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/getcollaborationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getcollaborationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getcollaborationcommandoutput.html)

</details>
<details>
<summary>
GetCollaborationAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/getcollaborationanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getcollaborationanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getcollaborationanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -368,6 +408,22 @@ GetSchemaAnalysisRule

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/getschemaanalysisrulecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getschemaanalysisrulecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/getschemaanalysisrulecommandoutput.html)

</details>
<details>
<summary>
ListAnalysisTemplates
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/listanalysistemplatescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/listanalysistemplatescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/listanalysistemplatescommandoutput.html)

</details>
<details>
<summary>
ListCollaborationAnalysisTemplates
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/listcollaborationanalysistemplatescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/listcollaborationanalysistemplatescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/listcollaborationanalysistemplatescommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -456,6 +512,14 @@ UntagResource

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/untagresourcecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/untagresourcecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/untagresourcecommandoutput.html)

</details>
<details>
<summary>
UpdateAnalysisTemplate
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/classes/updateanalysistemplatecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/updateanalysistemplatecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-cleanrooms/interfaces/updateanalysistemplatecommandoutput.html)

</details>
<details>
<summary>
Expand Down
Loading

0 comments on commit d50fb3f

Please sign in to comment.