@aws-sdk/client-cleanroomsml 3.462.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +405 -0
- package/dist-cjs/CleanRoomsML.js +61 -0
- package/dist-cjs/CleanRoomsMLClient.js +43 -0
- package/dist-cjs/commands/CreateAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/CreateConfiguredAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/CreateTrainingDatasetCommand.js +51 -0
- package/dist-cjs/commands/DeleteAudienceGenerationJobCommand.js +51 -0
- package/dist-cjs/commands/DeleteAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/DeleteConfiguredAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/DeleteConfiguredAudienceModelPolicyCommand.js +51 -0
- package/dist-cjs/commands/DeleteTrainingDatasetCommand.js +51 -0
- package/dist-cjs/commands/GetAudienceGenerationJobCommand.js +51 -0
- package/dist-cjs/commands/GetAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/GetConfiguredAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/GetConfiguredAudienceModelPolicyCommand.js +51 -0
- package/dist-cjs/commands/GetTrainingDatasetCommand.js +51 -0
- package/dist-cjs/commands/ListAudienceExportJobsCommand.js +51 -0
- package/dist-cjs/commands/ListAudienceGenerationJobsCommand.js +51 -0
- package/dist-cjs/commands/ListAudienceModelsCommand.js +51 -0
- package/dist-cjs/commands/ListConfiguredAudienceModelsCommand.js +51 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/ListTrainingDatasetsCommand.js +51 -0
- package/dist-cjs/commands/PutConfiguredAudienceModelPolicyCommand.js +51 -0
- package/dist-cjs/commands/StartAudienceExportJobCommand.js +51 -0
- package/dist-cjs/commands/StartAudienceGenerationJobCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateConfiguredAudienceModelCommand.js +51 -0
- package/dist-cjs/commands/index.js +28 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/CleanRoomsMLServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +131 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAudienceExportJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAudienceGenerationJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAudienceModelsPaginator.js +29 -0
- package/dist-cjs/pagination/ListConfiguredAudienceModelsPaginator.js +29 -0
- package/dist-cjs/pagination/ListTrainingDatasetsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +9 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1835 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/CleanRoomsML.js +57 -0
- package/dist-es/CleanRoomsMLClient.js +39 -0
- package/dist-es/commands/CreateAudienceModelCommand.js +47 -0
- package/dist-es/commands/CreateConfiguredAudienceModelCommand.js +47 -0
- package/dist-es/commands/CreateTrainingDatasetCommand.js +47 -0
- package/dist-es/commands/DeleteAudienceGenerationJobCommand.js +47 -0
- package/dist-es/commands/DeleteAudienceModelCommand.js +47 -0
- package/dist-es/commands/DeleteConfiguredAudienceModelCommand.js +47 -0
- package/dist-es/commands/DeleteConfiguredAudienceModelPolicyCommand.js +47 -0
- package/dist-es/commands/DeleteTrainingDatasetCommand.js +47 -0
- package/dist-es/commands/GetAudienceGenerationJobCommand.js +47 -0
- package/dist-es/commands/GetAudienceModelCommand.js +47 -0
- package/dist-es/commands/GetConfiguredAudienceModelCommand.js +47 -0
- package/dist-es/commands/GetConfiguredAudienceModelPolicyCommand.js +47 -0
- package/dist-es/commands/GetTrainingDatasetCommand.js +47 -0
- package/dist-es/commands/ListAudienceExportJobsCommand.js +47 -0
- package/dist-es/commands/ListAudienceGenerationJobsCommand.js +47 -0
- package/dist-es/commands/ListAudienceModelsCommand.js +47 -0
- package/dist-es/commands/ListConfiguredAudienceModelsCommand.js +47 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/ListTrainingDatasetsCommand.js +47 -0
- package/dist-es/commands/PutConfiguredAudienceModelPolicyCommand.js +47 -0
- package/dist-es/commands/StartAudienceExportJobCommand.js +47 -0
- package/dist-es/commands/StartAudienceGenerationJobCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateConfiguredAudienceModelCommand.js +47 -0
- package/dist-es/commands/index.js +25 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/CleanRoomsMLServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +123 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAudienceExportJobsPaginator.js +25 -0
- package/dist-es/pagination/ListAudienceGenerationJobsPaginator.js +25 -0
- package/dist-es/pagination/ListAudienceModelsPaginator.js +25 -0
- package/dist-es/pagination/ListConfiguredAudienceModelsPaginator.js +25 -0
- package/dist-es/pagination/ListTrainingDatasetsPaginator.js +25 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +1782 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/CleanRoomsML.d.ts +185 -0
- package/dist-types/CleanRoomsMLClient.d.ts +194 -0
- package/dist-types/commands/CreateAudienceModelCommand.d.ts +96 -0
- package/dist-types/commands/CreateConfiguredAudienceModelCommand.d.ts +112 -0
- package/dist-types/commands/CreateTrainingDatasetCommand.d.ts +109 -0
- package/dist-types/commands/DeleteAudienceGenerationJobCommand.d.ts +83 -0
- package/dist-types/commands/DeleteAudienceModelCommand.d.ts +83 -0
- package/dist-types/commands/DeleteConfiguredAudienceModelCommand.d.ts +83 -0
- package/dist-types/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +80 -0
- package/dist-types/commands/DeleteTrainingDatasetCommand.d.ts +83 -0
- package/dist-types/commands/GetAudienceGenerationJobCommand.d.ts +115 -0
- package/dist-types/commands/GetAudienceModelCommand.d.ts +105 -0
- package/dist-types/commands/GetConfiguredAudienceModelCommand.d.ts +110 -0
- package/dist-types/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +84 -0
- package/dist-types/commands/GetTrainingDatasetCommand.d.ts +113 -0
- package/dist-types/commands/ListAudienceExportJobsCommand.d.ts +100 -0
- package/dist-types/commands/ListAudienceGenerationJobsCommand.d.ts +95 -0
- package/dist-types/commands/ListAudienceModelsCommand.d.ts +91 -0
- package/dist-types/commands/ListConfiguredAudienceModelsCommand.d.ts +99 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +84 -0
- package/dist-types/commands/ListTrainingDatasetsCommand.d.ts +90 -0
- package/dist-types/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +86 -0
- package/dist-types/commands/StartAudienceExportJobCommand.d.ts +92 -0
- package/dist-types/commands/StartAudienceGenerationJobCommand.d.ts +101 -0
- package/dist-types/commands/TagResourceCommand.d.ts +83 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +83 -0
- package/dist-types/commands/UpdateConfiguredAudienceModelCommand.d.ts +105 -0
- package/dist-types/commands/index.d.ts +25 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +15 -0
- package/dist-types/models/CleanRoomsMLServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1729 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAudienceExportJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAudienceGenerationJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAudienceModelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConfiguredAudienceModelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTrainingDatasetsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +227 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/CleanRoomsML.d.ts +438 -0
- package/dist-types/ts3.4/CleanRoomsMLClient.d.ts +269 -0
- package/dist-types/ts3.4/commands/CreateAudienceModelCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateConfiguredAudienceModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateTrainingDatasetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAudienceGenerationJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAudienceModelCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteTrainingDatasetCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetAudienceGenerationJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAudienceModelCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetConfiguredAudienceModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetTrainingDatasetCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAudienceExportJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAudienceGenerationJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAudienceModelsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListConfiguredAudienceModelsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTrainingDatasetsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartAudienceExportJobCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/StartAudienceGenerationJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateConfiguredAudienceModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +25 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/CleanRoomsMLServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +453 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAudienceExportJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAudienceGenerationJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAudienceModelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConfiguredAudienceModelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTrainingDatasetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +305 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +102 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { GetAudienceGenerationJobRequest, GetAudienceGenerationJobResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAudienceGenerationJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAudienceGenerationJobCommandInput extends GetAudienceGenerationJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAudienceGenerationJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAudienceGenerationJobCommandOutput extends GetAudienceGenerationJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns information about an audience generation job.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, GetAudienceGenerationJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, GetAudienceGenerationJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // GetAudienceGenerationJobRequest
|
|
34
|
+
* audienceGenerationJobArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetAudienceGenerationJobCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetAudienceGenerationJobResponse
|
|
39
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
40
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
41
|
+
* // audienceGenerationJobArn: "STRING_VALUE", // required
|
|
42
|
+
* // name: "STRING_VALUE", // required
|
|
43
|
+
* // description: "STRING_VALUE",
|
|
44
|
+
* // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", // required
|
|
45
|
+
* // statusDetails: { // StatusDetails
|
|
46
|
+
* // statusCode: "STRING_VALUE",
|
|
47
|
+
* // message: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // configuredAudienceModelArn: "STRING_VALUE", // required
|
|
50
|
+
* // seedAudience: { // AudienceGenerationJobDataSource
|
|
51
|
+
* // dataSource: { // S3ConfigMap
|
|
52
|
+
* // s3Uri: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // roleArn: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // includeSeedInOutput: true || false,
|
|
57
|
+
* // collaborationId: "STRING_VALUE",
|
|
58
|
+
* // metrics: { // AudienceQualityMetrics
|
|
59
|
+
* // relevanceMetrics: [ // RelevanceMetrics // required
|
|
60
|
+
* // { // RelevanceMetric
|
|
61
|
+
* // audienceSize: { // AudienceSize
|
|
62
|
+
* // type: "ABSOLUTE" || "PERCENTAGE", // required
|
|
63
|
+
* // value: Number("int"), // required
|
|
64
|
+
* // },
|
|
65
|
+
* // score: Number("double"),
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
69
|
+
* // startedBy: "STRING_VALUE",
|
|
70
|
+
* // tags: { // TagMap
|
|
71
|
+
* // "<keys>": "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param GetAudienceGenerationJobCommandInput - {@link GetAudienceGenerationJobCommandInput}
|
|
78
|
+
* @returns {@link GetAudienceGenerationJobCommandOutput}
|
|
79
|
+
* @see {@link GetAudienceGenerationJobCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link GetAudienceGenerationJobCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
84
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The resource you are requesting does not exist.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export declare class GetAudienceGenerationJobCommand extends $Command<GetAudienceGenerationJobCommandInput, GetAudienceGenerationJobCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
97
|
+
readonly input: GetAudienceGenerationJobCommandInput;
|
|
98
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
constructor(input: GetAudienceGenerationJobCommandInput);
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
*/
|
|
106
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAudienceGenerationJobCommandInput, GetAudienceGenerationJobCommandOutput>;
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
private serialize;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private deserialize;
|
|
115
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { GetAudienceModelRequest, GetAudienceModelResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAudienceModelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAudienceModelCommandInput extends GetAudienceModelRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAudienceModelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAudienceModelCommandOutput extends GetAudienceModelResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns information about an audience model</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, GetAudienceModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, GetAudienceModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // GetAudienceModelRequest
|
|
34
|
+
* audienceModelArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetAudienceModelCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetAudienceModelResponse
|
|
39
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
40
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
41
|
+
* // trainingDataStartTime: new Date("TIMESTAMP"),
|
|
42
|
+
* // trainingDataEndTime: new Date("TIMESTAMP"),
|
|
43
|
+
* // audienceModelArn: "STRING_VALUE", // required
|
|
44
|
+
* // name: "STRING_VALUE", // required
|
|
45
|
+
* // trainingDatasetArn: "STRING_VALUE", // required
|
|
46
|
+
* // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED", // required
|
|
47
|
+
* // statusDetails: { // StatusDetails
|
|
48
|
+
* // statusCode: "STRING_VALUE",
|
|
49
|
+
* // message: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // metrics: [ // AudienceModelMetrics
|
|
52
|
+
* // { // AudienceModelMetric
|
|
53
|
+
* // type: "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN" || "MEAN_RECIPROCAL_RANK" || "PRECISION" || "RECALL", // required
|
|
54
|
+
* // forTopKItemPredictions: Number("int"), // required
|
|
55
|
+
* // value: Number("double"), // required
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
59
|
+
* // tags: { // TagMap
|
|
60
|
+
* // "<keys>": "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // description: "STRING_VALUE",
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param GetAudienceModelCommandInput - {@link GetAudienceModelCommandInput}
|
|
68
|
+
* @returns {@link GetAudienceModelCommandOutput}
|
|
69
|
+
* @see {@link GetAudienceModelCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link GetAudienceModelCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
74
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The resource you are requesting does not exist.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
84
|
+
*
|
|
85
|
+
*/
|
|
86
|
+
export declare class GetAudienceModelCommand extends $Command<GetAudienceModelCommandInput, GetAudienceModelCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
87
|
+
readonly input: GetAudienceModelCommandInput;
|
|
88
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
constructor(input: GetAudienceModelCommandInput);
|
|
93
|
+
/**
|
|
94
|
+
* @internal
|
|
95
|
+
*/
|
|
96
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAudienceModelCommandInput, GetAudienceModelCommandOutput>;
|
|
97
|
+
/**
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
private serialize;
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
private deserialize;
|
|
105
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { GetConfiguredAudienceModelRequest, GetConfiguredAudienceModelResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConfiguredAudienceModelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConfiguredAudienceModelCommandInput extends GetConfiguredAudienceModelRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConfiguredAudienceModelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConfiguredAudienceModelCommandOutput extends GetConfiguredAudienceModelResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns information about a specified configured audience model.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, GetConfiguredAudienceModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, GetConfiguredAudienceModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // GetConfiguredAudienceModelRequest
|
|
34
|
+
* configuredAudienceModelArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetConfiguredAudienceModelCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetConfiguredAudienceModelResponse
|
|
39
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
40
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
41
|
+
* // configuredAudienceModelArn: "STRING_VALUE", // required
|
|
42
|
+
* // name: "STRING_VALUE", // required
|
|
43
|
+
* // audienceModelArn: "STRING_VALUE", // required
|
|
44
|
+
* // outputConfig: { // ConfiguredAudienceModelOutputConfig
|
|
45
|
+
* // destination: { // AudienceDestination
|
|
46
|
+
* // s3Destination: { // S3ConfigMap
|
|
47
|
+
* // s3Uri: "STRING_VALUE", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // },
|
|
50
|
+
* // roleArn: "STRING_VALUE", // required
|
|
51
|
+
* // },
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // status: "ACTIVE", // required
|
|
54
|
+
* // sharedAudienceMetrics: [ // MetricsList // required
|
|
55
|
+
* // "ALL" || "NONE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // minMatchingSeedSize: Number("int"),
|
|
58
|
+
* // audienceSizeConfig: { // AudienceSizeConfig
|
|
59
|
+
* // audienceSizeType: "ABSOLUTE" || "PERCENTAGE", // required
|
|
60
|
+
* // audienceSizeBins: [ // AudienceSizeBins // required
|
|
61
|
+
* // Number("int"),
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // tags: { // TagMap
|
|
65
|
+
* // "<keys>": "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // childResourceTagOnCreatePolicy: "FROM_PARENT_RESOURCE" || "NONE",
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetConfiguredAudienceModelCommandInput - {@link GetConfiguredAudienceModelCommandInput}
|
|
73
|
+
* @returns {@link GetConfiguredAudienceModelCommandOutput}
|
|
74
|
+
* @see {@link GetConfiguredAudienceModelCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetConfiguredAudienceModelCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>The resource you are requesting does not exist.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
export declare class GetConfiguredAudienceModelCommand extends $Command<GetConfiguredAudienceModelCommandInput, GetConfiguredAudienceModelCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
92
|
+
readonly input: GetConfiguredAudienceModelCommandInput;
|
|
93
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
constructor(input: GetConfiguredAudienceModelCommandInput);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfiguredAudienceModelCommandInput, GetConfiguredAudienceModelCommandOutput>;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private serialize;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private deserialize;
|
|
110
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { GetConfiguredAudienceModelPolicyRequest, GetConfiguredAudienceModelPolicyResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConfiguredAudienceModelPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConfiguredAudienceModelPolicyCommandInput extends GetConfiguredAudienceModelPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConfiguredAudienceModelPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConfiguredAudienceModelPolicyCommandOutput extends GetConfiguredAudienceModelPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns information about a configured audience model policy.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, GetConfiguredAudienceModelPolicyCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, GetConfiguredAudienceModelPolicyCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // GetConfiguredAudienceModelPolicyRequest
|
|
34
|
+
* configuredAudienceModelArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetConfiguredAudienceModelPolicyCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetConfiguredAudienceModelPolicyResponse
|
|
39
|
+
* // configuredAudienceModelArn: "STRING_VALUE", // required
|
|
40
|
+
* // configuredAudienceModelPolicy: "STRING_VALUE", // required
|
|
41
|
+
* // policyHash: "STRING_VALUE", // required
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param GetConfiguredAudienceModelPolicyCommandInput - {@link GetConfiguredAudienceModelPolicyCommandInput}
|
|
47
|
+
* @returns {@link GetConfiguredAudienceModelPolicyCommandOutput}
|
|
48
|
+
* @see {@link GetConfiguredAudienceModelPolicyCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link GetConfiguredAudienceModelPolicyCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
56
|
+
* <p>The resource you are requesting does not exist.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ValidationException} (client fault)
|
|
59
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
export declare class GetConfiguredAudienceModelPolicyCommand extends $Command<GetConfiguredAudienceModelPolicyCommandInput, GetConfiguredAudienceModelPolicyCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
66
|
+
readonly input: GetConfiguredAudienceModelPolicyCommandInput;
|
|
67
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
constructor(input: GetConfiguredAudienceModelPolicyCommandInput);
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
*/
|
|
75
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfiguredAudienceModelPolicyCommandInput, GetConfiguredAudienceModelPolicyCommandOutput>;
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
private serialize;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
private deserialize;
|
|
84
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { GetTrainingDatasetRequest, GetTrainingDatasetResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetTrainingDatasetCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetTrainingDatasetCommandInput extends GetTrainingDatasetRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetTrainingDatasetCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetTrainingDatasetCommandOutput extends GetTrainingDatasetResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns information about a training dataset.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, GetTrainingDatasetCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, GetTrainingDatasetCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // GetTrainingDatasetRequest
|
|
34
|
+
* trainingDatasetArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetTrainingDatasetCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetTrainingDatasetResponse
|
|
39
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
40
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
41
|
+
* // trainingDatasetArn: "STRING_VALUE", // required
|
|
42
|
+
* // name: "STRING_VALUE", // required
|
|
43
|
+
* // trainingData: [ // DatasetList // required
|
|
44
|
+
* // { // Dataset
|
|
45
|
+
* // type: "INTERACTIONS", // required
|
|
46
|
+
* // inputConfig: { // DatasetInputConfig
|
|
47
|
+
* // schema: [ // DatasetSchemaList // required
|
|
48
|
+
* // { // ColumnSchema
|
|
49
|
+
* // columnName: "STRING_VALUE", // required
|
|
50
|
+
* // columnTypes: [ // ColumnTypeList // required
|
|
51
|
+
* // "USER_ID" || "ITEM_ID" || "TIMESTAMP" || "CATEGORICAL_FEATURE" || "NUMERICAL_FEATURE",
|
|
52
|
+
* // ],
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // dataSource: { // DataSource
|
|
56
|
+
* // glueDataSource: { // GlueDataSource
|
|
57
|
+
* // tableName: "STRING_VALUE", // required
|
|
58
|
+
* // databaseName: "STRING_VALUE", // required
|
|
59
|
+
* // catalogId: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // status: "ACTIVE", // required
|
|
66
|
+
* // roleArn: "STRING_VALUE", // required
|
|
67
|
+
* // tags: { // TagMap
|
|
68
|
+
* // "<keys>": "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // description: "STRING_VALUE",
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param GetTrainingDatasetCommandInput - {@link GetTrainingDatasetCommandInput}
|
|
76
|
+
* @returns {@link GetTrainingDatasetCommandOutput}
|
|
77
|
+
* @see {@link GetTrainingDatasetCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link GetTrainingDatasetCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>The resource you are requesting does not exist.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ValidationException} (client fault)
|
|
88
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
92
|
+
*
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetTrainingDatasetCommand extends $Command<GetTrainingDatasetCommandInput, GetTrainingDatasetCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
95
|
+
readonly input: GetTrainingDatasetCommandInput;
|
|
96
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
constructor(input: GetTrainingDatasetCommandInput);
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetTrainingDatasetCommandInput, GetTrainingDatasetCommandOutput>;
|
|
105
|
+
/**
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
private serialize;
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
private deserialize;
|
|
113
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient";
|
|
5
|
+
import { ListAudienceExportJobsRequest, ListAudienceExportJobsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAudienceExportJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAudienceExportJobsCommandInput extends ListAudienceExportJobsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAudienceExportJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAudienceExportJobsCommandOutput extends ListAudienceExportJobsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a list of the audience export jobs.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { CleanRoomsMLClient, ListAudienceExportJobsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
|
|
31
|
+
* // const { CleanRoomsMLClient, ListAudienceExportJobsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
|
|
32
|
+
* const client = new CleanRoomsMLClient(config);
|
|
33
|
+
* const input = { // ListAudienceExportJobsRequest
|
|
34
|
+
* nextToken: "STRING_VALUE",
|
|
35
|
+
* maxResults: Number("int"),
|
|
36
|
+
* audienceGenerationJobArn: "STRING_VALUE",
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListAudienceExportJobsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListAudienceExportJobsResponse
|
|
41
|
+
* // nextToken: "STRING_VALUE",
|
|
42
|
+
* // audienceExportJobs: [ // AudienceExportJobList // required
|
|
43
|
+
* // { // AudienceExportJobSummary
|
|
44
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // name: "STRING_VALUE", // required
|
|
47
|
+
* // audienceGenerationJobArn: "STRING_VALUE", // required
|
|
48
|
+
* // audienceSize: { // AudienceSize
|
|
49
|
+
* // type: "ABSOLUTE" || "PERCENTAGE", // required
|
|
50
|
+
* // value: Number("int"), // required
|
|
51
|
+
* // },
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE", // required
|
|
54
|
+
* // statusDetails: { // StatusDetails
|
|
55
|
+
* // statusCode: "STRING_VALUE",
|
|
56
|
+
* // message: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // outputLocation: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param ListAudienceExportJobsCommandInput - {@link ListAudienceExportJobsCommandInput}
|
|
66
|
+
* @returns {@link ListAudienceExportJobsCommandOutput}
|
|
67
|
+
* @see {@link ListAudienceExportJobsCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link ListAudienceExportJobsCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>The request parameters for this request are incorrect.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link CleanRoomsMLServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from CleanRoomsML service.</p>
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
export declare class ListAudienceExportJobsCommand extends $Command<ListAudienceExportJobsCommandInput, ListAudienceExportJobsCommandOutput, CleanRoomsMLClientResolvedConfig> {
|
|
82
|
+
readonly input: ListAudienceExportJobsCommandInput;
|
|
83
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
constructor(input: ListAudienceExportJobsCommandInput);
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CleanRoomsMLClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAudienceExportJobsCommandInput, ListAudienceExportJobsCommandOutput>;
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
private serialize;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
private deserialize;
|
|
100
|
+
}
|