@aws-sdk/client-appconfig 3.1075.0 → 3.1076.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/README.md +108 -107
- package/dist-cjs/index.js +1825 -15
- package/dist-es/AppConfig.js +28 -0
- package/dist-es/commands/CreateExperimentDefinitionCommand.js +16 -0
- package/dist-es/commands/DeleteExperimentDefinitionCommand.js +16 -0
- package/dist-es/commands/GetExperimentDefinitionCommand.js +16 -0
- package/dist-es/commands/GetExperimentRunCommand.js +16 -0
- package/dist-es/commands/ListExperimentDefinitionsCommand.js +16 -0
- package/dist-es/commands/ListExperimentRunEventsCommand.js +16 -0
- package/dist-es/commands/ListExperimentRunsCommand.js +16 -0
- package/dist-es/commands/StartExperimentRunCommand.js +16 -0
- package/dist-es/commands/StopExperimentRunCommand.js +16 -0
- package/dist-es/commands/UpdateExperimentDefinitionCommand.js +16 -0
- package/dist-es/commands/UpdateExperimentRunCommand.js +16 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/enums.js +23 -0
- package/dist-es/pagination/ListExperimentDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/ListExperimentRunEventsPaginator.js +4 -0
- package/dist-es/pagination/ListExperimentRunsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +328 -49
- package/dist-types/AppConfig.d.ts +130 -107
- package/dist-types/AppConfigClient.d.ts +44 -109
- package/dist-types/commands/CreateApplicationCommand.d.ts +0 -3
- package/dist-types/commands/CreateConfigurationProfileCommand.d.ts +0 -3
- package/dist-types/commands/CreateDeploymentStrategyCommand.d.ts +0 -3
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +0 -3
- package/dist-types/commands/CreateExperimentDefinitionCommand.d.ts +266 -0
- package/dist-types/commands/CreateExtensionAssociationCommand.d.ts +0 -3
- package/dist-types/commands/CreateExtensionCommand.d.ts +0 -3
- package/dist-types/commands/CreateHostedConfigurationVersionCommand.d.ts +1 -4
- package/dist-types/commands/DeleteExperimentDefinitionCommand.d.ts +103 -0
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +3 -0
- package/dist-types/commands/GetExperimentDefinitionCommand.d.ts +184 -0
- package/dist-types/commands/GetExperimentRunCommand.d.ts +209 -0
- package/dist-types/commands/ListDeploymentsCommand.d.ts +2 -0
- package/dist-types/commands/ListExperimentDefinitionsCommand.d.ts +131 -0
- package/dist-types/commands/ListExperimentRunEventsCommand.d.ts +136 -0
- package/dist-types/commands/ListExperimentRunsCommand.d.ts +125 -0
- package/dist-types/commands/StartDeploymentCommand.d.ts +5 -0
- package/dist-types/commands/StartExperimentRunCommand.d.ts +230 -0
- package/dist-types/commands/StopExperimentRunCommand.d.ts +231 -0
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +6 -0
- package/dist-types/commands/UpdateExperimentDefinitionCommand.d.ts +237 -0
- package/dist-types/commands/UpdateExperimentRunCommand.d.ts +229 -0
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/index.d.ts +31 -107
- package/dist-types/models/enums.d.ts +63 -0
- package/dist-types/models/errors.d.ts +0 -3
- package/dist-types/models/models_0.d.ts +1080 -37
- package/dist-types/pagination/ListExperimentDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListExperimentRunEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListExperimentRunsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +39 -0
- package/dist-types/ts3.4/AppConfig.d.ts +209 -0
- package/dist-types/ts3.4/AppConfigClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateExperimentDefinitionCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteExperimentDefinitionCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/GetExperimentDefinitionCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetExperimentRunCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/ListExperimentDefinitionsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListExperimentRunEventsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListExperimentRunsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartExperimentRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StopExperimentRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateExperimentDefinitionCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateExperimentRunCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/enums.d.ts +32 -0
- package/dist-types/ts3.4/models/models_0.d.ts +292 -0
- package/dist-types/ts3.4/pagination/ListExperimentDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListExperimentRunEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListExperimentRunsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +39 -0
- package/package.json +8 -8
- package/dist-cjs/auth/httpAuthSchemeProvider.js +0 -40
- package/dist-cjs/endpoint/bdd.js +0 -52
- package/dist-cjs/endpoint/endpointResolver.js +0 -14
- package/dist-cjs/models/AppConfigServiceException.js +0 -8
- package/dist-cjs/models/errors.js +0 -97
- package/dist-cjs/runtimeConfig.browser.js +0 -32
- package/dist-cjs/runtimeConfig.js +0 -45
- package/dist-cjs/runtimeConfig.native.js +0 -12
- package/dist-cjs/runtimeConfig.shared.js +0 -38
- package/dist-cjs/schemas/schemas_0.js +0 -980
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
|
|
4
|
+
import type { DeleteExperimentDefinitionRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteExperimentDefinitionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteExperimentDefinitionCommandInput extends DeleteExperimentDefinitionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteExperimentDefinitionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteExperimentDefinitionCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteExperimentDefinitionCommand_base: {
|
|
25
|
+
new (input: DeleteExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<DeleteExperimentDefinitionCommandInput, DeleteExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<DeleteExperimentDefinitionCommandInput, DeleteExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Deletes an experiment definition. You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { AppConfigClient, DeleteExperimentDefinitionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
|
|
37
|
+
* // const { AppConfigClient, DeleteExperimentDefinitionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
|
|
38
|
+
* // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
|
|
39
|
+
* const config = {}; // type is AppConfigClientConfig
|
|
40
|
+
* const client = new AppConfigClient(config);
|
|
41
|
+
* const input = { // DeleteExperimentDefinitionRequest
|
|
42
|
+
* ApplicationIdentifier: "STRING_VALUE", // required
|
|
43
|
+
* ExperimentDefinitionIdentifier: "STRING_VALUE", // required
|
|
44
|
+
* DeleteType: "ARCHIVE" || "DESTROY",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DeleteExperimentDefinitionCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // {};
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param DeleteExperimentDefinitionCommandInput - {@link DeleteExperimentDefinitionCommandInput}
|
|
53
|
+
* @returns {@link DeleteExperimentDefinitionCommandOutput}
|
|
54
|
+
* @see {@link DeleteExperimentDefinitionCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link DeleteExperimentDefinitionCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestException} (client fault)
|
|
59
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ConflictException} (client fault)
|
|
62
|
+
* <p>The request could not be processed because of conflict in the current state of the
|
|
63
|
+
* resource.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>There was an internal failure in the AppConfig service.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p>The requested resource could not be found.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AppConfigServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from AppConfig service.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
* @example To delete an experiment definition
|
|
76
|
+
* ```javascript
|
|
77
|
+
* // The following DeleteExperimentDefinition example archives (soft-deletes) the specified experiment definition.
|
|
78
|
+
* const input = {
|
|
79
|
+
* ApplicationIdentifier: "339ohji",
|
|
80
|
+
* ExperimentDefinitionIdentifier: "bsxyd7k"
|
|
81
|
+
* };
|
|
82
|
+
* const command = new DeleteExperimentDefinitionCommand(input);
|
|
83
|
+
* const response = await client.send(command);
|
|
84
|
+
* /* response is
|
|
85
|
+
* { /* metadata only *\/ }
|
|
86
|
+
* *\/
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class DeleteExperimentDefinitionCommand extends DeleteExperimentDefinitionCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: DeleteExperimentDefinitionRequest;
|
|
96
|
+
output: {};
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: DeleteExperimentDefinitionCommandInput;
|
|
100
|
+
output: DeleteExperimentDefinitionCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -47,6 +47,9 @@ declare const GetAccountSettingsCommand_base: {
|
|
|
47
47
|
* // Enabled: true || false,
|
|
48
48
|
* // ProtectionPeriodInMinutes: Number("int"),
|
|
49
49
|
* // },
|
|
50
|
+
* // VendedMetrics: { // VendedMetricsSettings
|
|
51
|
+
* // Enabled: true || false,
|
|
52
|
+
* // },
|
|
50
53
|
* // };
|
|
51
54
|
*
|
|
52
55
|
* ```
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
|
|
4
|
+
import type { ExperimentDefinition, GetExperimentDefinitionRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetExperimentDefinitionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetExperimentDefinitionCommandInput extends GetExperimentDefinitionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetExperimentDefinitionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetExperimentDefinitionCommandOutput extends ExperimentDefinition, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetExperimentDefinitionCommand_base: {
|
|
25
|
+
new (input: GetExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<GetExperimentDefinitionCommandInput, GetExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<GetExperimentDefinitionCommandInput, GetExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Retrieves information about an experiment definition.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { AppConfigClient, GetExperimentDefinitionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
|
|
37
|
+
* // const { AppConfigClient, GetExperimentDefinitionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
|
|
38
|
+
* // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
|
|
39
|
+
* const config = {}; // type is AppConfigClientConfig
|
|
40
|
+
* const client = new AppConfigClient(config);
|
|
41
|
+
* const input = { // GetExperimentDefinitionRequest
|
|
42
|
+
* ApplicationIdentifier: "STRING_VALUE", // required
|
|
43
|
+
* ExperimentDefinitionIdentifier: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new GetExperimentDefinitionCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ExperimentDefinition
|
|
48
|
+
* // ApplicationId: "STRING_VALUE",
|
|
49
|
+
* // Id: "STRING_VALUE",
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // Hypothesis: "STRING_VALUE",
|
|
52
|
+
* // Status: "ACTIVE" || "IDLE" || "ARCHIVED",
|
|
53
|
+
* // ConfigurationProfileId: "STRING_VALUE",
|
|
54
|
+
* // EnvironmentId: "STRING_VALUE",
|
|
55
|
+
* // FlagKey: "STRING_VALUE",
|
|
56
|
+
* // AudienceRule: "STRING_VALUE",
|
|
57
|
+
* // AudienceDescription: "STRING_VALUE",
|
|
58
|
+
* // LaunchCriteria: "STRING_VALUE",
|
|
59
|
+
* // Treatments: [ // TreatmentList
|
|
60
|
+
* // { // Treatment
|
|
61
|
+
* // Key: "STRING_VALUE",
|
|
62
|
+
* // Weight: Number("float"), // required
|
|
63
|
+
* // Description: "STRING_VALUE",
|
|
64
|
+
* // FlagValue: { // FlagValue
|
|
65
|
+
* // Enabled: true || false, // required
|
|
66
|
+
* // AttributeValues: { // AttributeValueMap
|
|
67
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
68
|
+
* // StringValue: "STRING_VALUE",
|
|
69
|
+
* // NumberValue: Number("double"),
|
|
70
|
+
* // BooleanValue: true || false,
|
|
71
|
+
* // StringArray: [ // StringList
|
|
72
|
+
* // "STRING_VALUE",
|
|
73
|
+
* // ],
|
|
74
|
+
* // NumberArray: [ // NumberList
|
|
75
|
+
* // Number("double"),
|
|
76
|
+
* // ],
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // Control: {
|
|
83
|
+
* // Key: "STRING_VALUE",
|
|
84
|
+
* // Weight: Number("float"), // required
|
|
85
|
+
* // Description: "STRING_VALUE",
|
|
86
|
+
* // FlagValue: {
|
|
87
|
+
* // Enabled: true || false, // required
|
|
88
|
+
* // AttributeValues: {
|
|
89
|
+
* // "<keys>": {// Union: only one key present
|
|
90
|
+
* // StringValue: "STRING_VALUE",
|
|
91
|
+
* // NumberValue: Number("double"),
|
|
92
|
+
* // BooleanValue: true || false,
|
|
93
|
+
* // StringArray: [
|
|
94
|
+
* // "STRING_VALUE",
|
|
95
|
+
* // ],
|
|
96
|
+
* // NumberArray: [
|
|
97
|
+
* // Number("double"),
|
|
98
|
+
* // ],
|
|
99
|
+
* // },
|
|
100
|
+
* // },
|
|
101
|
+
* // },
|
|
102
|
+
* // },
|
|
103
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
104
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
105
|
+
* // KmsKeyIdentifier: "STRING_VALUE",
|
|
106
|
+
* // };
|
|
107
|
+
*
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @param GetExperimentDefinitionCommandInput - {@link GetExperimentDefinitionCommandInput}
|
|
111
|
+
* @returns {@link GetExperimentDefinitionCommandOutput}
|
|
112
|
+
* @see {@link GetExperimentDefinitionCommandInput} for command's `input` shape.
|
|
113
|
+
* @see {@link GetExperimentDefinitionCommandOutput} for command's `response` shape.
|
|
114
|
+
* @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link BadRequestException} (client fault)
|
|
117
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link InternalServerException} (server fault)
|
|
120
|
+
* <p>There was an internal failure in the AppConfig service.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
123
|
+
* <p>The requested resource could not be found.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link AppConfigServiceException}
|
|
126
|
+
* <p>Base exception class for all service exceptions from AppConfig service.</p>
|
|
127
|
+
*
|
|
128
|
+
*
|
|
129
|
+
* @example To get an experiment definition
|
|
130
|
+
* ```javascript
|
|
131
|
+
* // The following GetExperimentDefinition example retrieves the details of an experiment definition.
|
|
132
|
+
* const input = {
|
|
133
|
+
* ApplicationIdentifier: "339ohji",
|
|
134
|
+
* ExperimentDefinitionIdentifier: "bsxyd7k"
|
|
135
|
+
* };
|
|
136
|
+
* const command = new GetExperimentDefinitionCommand(input);
|
|
137
|
+
* const response = await client.send(command);
|
|
138
|
+
* /* response is
|
|
139
|
+
* {
|
|
140
|
+
* ApplicationId: "339ohji",
|
|
141
|
+
* AudienceRule: `(eq $country "US")`,
|
|
142
|
+
* ConfigurationProfileId: "ur8hx2f",
|
|
143
|
+
* Control: {
|
|
144
|
+
* FlagValue: {
|
|
145
|
+
* Enabled: false
|
|
146
|
+
* },
|
|
147
|
+
* Key: "c",
|
|
148
|
+
* Weight: 50.0
|
|
149
|
+
* },
|
|
150
|
+
* CreatedAt: "2026-06-16T17:54:55.847Z",
|
|
151
|
+
* EnvironmentId: "54j1r29",
|
|
152
|
+
* FlagKey: "my-feature-flag",
|
|
153
|
+
* Id: "bsxyd7k",
|
|
154
|
+
* Name: "Example-Experiment-Definition",
|
|
155
|
+
* Status: "IDLE",
|
|
156
|
+
* Treatments: [
|
|
157
|
+
* {
|
|
158
|
+
* FlagValue: {
|
|
159
|
+
* Enabled: true
|
|
160
|
+
* },
|
|
161
|
+
* Key: "t1",
|
|
162
|
+
* Weight: 50.0
|
|
163
|
+
* }
|
|
164
|
+
* ],
|
|
165
|
+
* UpdatedAt: "2026-06-16T17:57:36Z"
|
|
166
|
+
* }
|
|
167
|
+
* *\/
|
|
168
|
+
* ```
|
|
169
|
+
*
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export declare class GetExperimentDefinitionCommand extends GetExperimentDefinitionCommand_base {
|
|
173
|
+
/** @internal type navigation helper, not in runtime. */
|
|
174
|
+
protected static __types: {
|
|
175
|
+
api: {
|
|
176
|
+
input: GetExperimentDefinitionRequest;
|
|
177
|
+
output: ExperimentDefinition;
|
|
178
|
+
};
|
|
179
|
+
sdk: {
|
|
180
|
+
input: GetExperimentDefinitionCommandInput;
|
|
181
|
+
output: GetExperimentDefinitionCommandOutput;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
}
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
|
|
4
|
+
import type { ExperimentRun, GetExperimentRunRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetExperimentRunCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetExperimentRunCommandInput extends GetExperimentRunRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetExperimentRunCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetExperimentRunCommandOutput extends ExperimentRun, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetExperimentRunCommand_base: {
|
|
25
|
+
new (input: GetExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<GetExperimentRunCommandInput, GetExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<GetExperimentRunCommandInput, GetExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Retrieves information about an experiment run, including its status, start time, and exposure settings.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { AppConfigClient, GetExperimentRunCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
|
|
37
|
+
* // const { AppConfigClient, GetExperimentRunCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
|
|
38
|
+
* // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
|
|
39
|
+
* const config = {}; // type is AppConfigClientConfig
|
|
40
|
+
* const client = new AppConfigClient(config);
|
|
41
|
+
* const input = { // GetExperimentRunRequest
|
|
42
|
+
* ApplicationIdentifier: "STRING_VALUE", // required
|
|
43
|
+
* ExperimentDefinitionIdentifier: "STRING_VALUE", // required
|
|
44
|
+
* Run: Number("int"), // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new GetExperimentRunCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ExperimentRun
|
|
49
|
+
* // ApplicationId: "STRING_VALUE",
|
|
50
|
+
* // ExperimentDefinitionId: "STRING_VALUE",
|
|
51
|
+
* // Run: Number("int"),
|
|
52
|
+
* // Description: "STRING_VALUE",
|
|
53
|
+
* // Status: "RUNNING" || "DONE",
|
|
54
|
+
* // ExposurePercentage: Number("float"),
|
|
55
|
+
* // TreatmentOverrides: { // TreatmentOverrides Union: only one key present
|
|
56
|
+
* // Inline: { // TreatmentOverrideMap
|
|
57
|
+
* // "<keys>": "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // Result: { // ExperimentRunResult
|
|
61
|
+
* // ExecutiveSummary: "STRING_VALUE",
|
|
62
|
+
* // ReasonsToLaunch: "STRING_VALUE",
|
|
63
|
+
* // ReasonsNotToLaunch: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // StartedAt: new Date("TIMESTAMP"),
|
|
66
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
67
|
+
* // EndedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // ExperimentDefinitionSnapshot: { // ExperimentDefinitionSnapshot
|
|
69
|
+
* // ApplicationId: "STRING_VALUE",
|
|
70
|
+
* // Id: "STRING_VALUE",
|
|
71
|
+
* // Name: "STRING_VALUE",
|
|
72
|
+
* // Hypothesis: "STRING_VALUE",
|
|
73
|
+
* // ConfigurationProfileId: "STRING_VALUE",
|
|
74
|
+
* // EnvironmentId: "STRING_VALUE",
|
|
75
|
+
* // FlagKey: "STRING_VALUE",
|
|
76
|
+
* // AudienceRule: "STRING_VALUE",
|
|
77
|
+
* // AudienceDescription: "STRING_VALUE",
|
|
78
|
+
* // LaunchCriteria: "STRING_VALUE",
|
|
79
|
+
* // Treatments: [ // TreatmentList
|
|
80
|
+
* // { // Treatment
|
|
81
|
+
* // Key: "STRING_VALUE",
|
|
82
|
+
* // Weight: Number("float"), // required
|
|
83
|
+
* // Description: "STRING_VALUE",
|
|
84
|
+
* // FlagValue: { // FlagValue
|
|
85
|
+
* // Enabled: true || false, // required
|
|
86
|
+
* // AttributeValues: { // AttributeValueMap
|
|
87
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
88
|
+
* // StringValue: "STRING_VALUE",
|
|
89
|
+
* // NumberValue: Number("double"),
|
|
90
|
+
* // BooleanValue: true || false,
|
|
91
|
+
* // StringArray: [ // StringList
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // NumberArray: [ // NumberList
|
|
95
|
+
* // Number("double"),
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
98
|
+
* // },
|
|
99
|
+
* // },
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // Control: {
|
|
103
|
+
* // Key: "STRING_VALUE",
|
|
104
|
+
* // Weight: Number("float"), // required
|
|
105
|
+
* // Description: "STRING_VALUE",
|
|
106
|
+
* // FlagValue: {
|
|
107
|
+
* // Enabled: true || false, // required
|
|
108
|
+
* // AttributeValues: {
|
|
109
|
+
* // "<keys>": {// Union: only one key present
|
|
110
|
+
* // StringValue: "STRING_VALUE",
|
|
111
|
+
* // NumberValue: Number("double"),
|
|
112
|
+
* // BooleanValue: true || false,
|
|
113
|
+
* // StringArray: [
|
|
114
|
+
* // "STRING_VALUE",
|
|
115
|
+
* // ],
|
|
116
|
+
* // NumberArray: [
|
|
117
|
+
* // Number("double"),
|
|
118
|
+
* // ],
|
|
119
|
+
* // },
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // };
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @param GetExperimentRunCommandInput - {@link GetExperimentRunCommandInput}
|
|
129
|
+
* @returns {@link GetExperimentRunCommandOutput}
|
|
130
|
+
* @see {@link GetExperimentRunCommandInput} for command's `input` shape.
|
|
131
|
+
* @see {@link GetExperimentRunCommandOutput} for command's `response` shape.
|
|
132
|
+
* @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link BadRequestException} (client fault)
|
|
135
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link InternalServerException} (server fault)
|
|
138
|
+
* <p>There was an internal failure in the AppConfig service.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
141
|
+
* <p>The requested resource could not be found.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link AppConfigServiceException}
|
|
144
|
+
* <p>Base exception class for all service exceptions from AppConfig service.</p>
|
|
145
|
+
*
|
|
146
|
+
*
|
|
147
|
+
* @example To get an experiment run
|
|
148
|
+
* ```javascript
|
|
149
|
+
* // The following GetExperimentRun example retrieves the details of an experiment run.
|
|
150
|
+
* const input = {
|
|
151
|
+
* ApplicationIdentifier: "339ohji",
|
|
152
|
+
* ExperimentDefinitionIdentifier: "bsxyd7k",
|
|
153
|
+
* Run: 1
|
|
154
|
+
* };
|
|
155
|
+
* const command = new GetExperimentRunCommand(input);
|
|
156
|
+
* const response = await client.send(command);
|
|
157
|
+
* /* response is
|
|
158
|
+
* {
|
|
159
|
+
* ApplicationId: "339ohji",
|
|
160
|
+
* ExperimentDefinitionId: "bsxyd7k",
|
|
161
|
+
* ExperimentDefinitionSnapshot: {
|
|
162
|
+
* ApplicationId: "339ohji",
|
|
163
|
+
* AudienceRule: `(eq $country "US")`,
|
|
164
|
+
* ConfigurationProfileId: "ur8hx2f",
|
|
165
|
+
* Control: {
|
|
166
|
+
* FlagValue: {
|
|
167
|
+
* Enabled: false
|
|
168
|
+
* },
|
|
169
|
+
* Key: "c",
|
|
170
|
+
* Weight: 50.0
|
|
171
|
+
* },
|
|
172
|
+
* EnvironmentId: "54j1r29",
|
|
173
|
+
* FlagKey: "my-feature-flag",
|
|
174
|
+
* Id: "bsxyd7k",
|
|
175
|
+
* Name: "Example-Experiment-Definition",
|
|
176
|
+
* Treatments: [
|
|
177
|
+
* {
|
|
178
|
+
* FlagValue: {
|
|
179
|
+
* Enabled: true
|
|
180
|
+
* },
|
|
181
|
+
* Key: "t1",
|
|
182
|
+
* Weight: 50.0
|
|
183
|
+
* }
|
|
184
|
+
* ]
|
|
185
|
+
* },
|
|
186
|
+
* ExposurePercentage: 50.0,
|
|
187
|
+
* Run: 1,
|
|
188
|
+
* StartedAt: "2026-06-16T17:57:10.046Z",
|
|
189
|
+
* Status: "RUNNING",
|
|
190
|
+
* UpdatedAt: "2026-06-16T17:57:10.567Z"
|
|
191
|
+
* }
|
|
192
|
+
* *\/
|
|
193
|
+
* ```
|
|
194
|
+
*
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
export declare class GetExperimentRunCommand extends GetExperimentRunCommand_base {
|
|
198
|
+
/** @internal type navigation helper, not in runtime. */
|
|
199
|
+
protected static __types: {
|
|
200
|
+
api: {
|
|
201
|
+
input: GetExperimentRunRequest;
|
|
202
|
+
output: ExperimentRun;
|
|
203
|
+
};
|
|
204
|
+
sdk: {
|
|
205
|
+
input: GetExperimentRunCommandInput;
|
|
206
|
+
output: GetExperimentRunCommandOutput;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
}
|
|
@@ -50,6 +50,7 @@ declare const ListDeploymentsCommand_base: {
|
|
|
50
50
|
* // Items: [ // DeploymentList
|
|
51
51
|
* // { // DeploymentSummary
|
|
52
52
|
* // DeploymentNumber: Number("int"),
|
|
53
|
+
* // ConfigurationProfileId: "STRING_VALUE",
|
|
53
54
|
* // ConfigurationName: "STRING_VALUE",
|
|
54
55
|
* // ConfigurationVersion: "STRING_VALUE",
|
|
55
56
|
* // DeploymentDurationInMinutes: Number("int"),
|
|
@@ -61,6 +62,7 @@ declare const ListDeploymentsCommand_base: {
|
|
|
61
62
|
* // StartedAt: new Date("TIMESTAMP"),
|
|
62
63
|
* // CompletedAt: new Date("TIMESTAMP"),
|
|
63
64
|
* // VersionLabel: "STRING_VALUE",
|
|
65
|
+
* // Type: "USER" || "MANAGED",
|
|
64
66
|
* // },
|
|
65
67
|
* // ],
|
|
66
68
|
* // NextToken: "STRING_VALUE",
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
|
|
4
|
+
import type { ExperimentDefinitions, ListExperimentDefinitionsRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListExperimentDefinitionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListExperimentDefinitionsCommandInput extends ListExperimentDefinitionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListExperimentDefinitionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListExperimentDefinitionsCommandOutput extends ExperimentDefinitions, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListExperimentDefinitionsCommand_base: {
|
|
25
|
+
new (input: ListExperimentDefinitionsCommandInput): import("@smithy/core/client").CommandImpl<ListExperimentDefinitionsCommandInput, ListExperimentDefinitionsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListExperimentDefinitionsCommandInput]): import("@smithy/core/client").CommandImpl<ListExperimentDefinitionsCommandInput, ListExperimentDefinitionsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { AppConfigClient, ListExperimentDefinitionsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
|
|
37
|
+
* // const { AppConfigClient, ListExperimentDefinitionsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
|
|
38
|
+
* // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
|
|
39
|
+
* const config = {}; // type is AppConfigClientConfig
|
|
40
|
+
* const client = new AppConfigClient(config);
|
|
41
|
+
* const input = { // ListExperimentDefinitionsRequest
|
|
42
|
+
* ApplicationIdentifier: "STRING_VALUE",
|
|
43
|
+
* ConfigurationProfileIdentifier: "STRING_VALUE",
|
|
44
|
+
* EnvironmentIdentifier: "STRING_VALUE",
|
|
45
|
+
* Status: "ACTIVE" || "IDLE" || "ARCHIVED",
|
|
46
|
+
* MaxResults: Number("int"),
|
|
47
|
+
* NextToken: "STRING_VALUE",
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListExperimentDefinitionsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // ExperimentDefinitions
|
|
52
|
+
* // Items: [ // ExperimentDefinitionList
|
|
53
|
+
* // { // ExperimentDefinitionSummary
|
|
54
|
+
* // ApplicationId: "STRING_VALUE",
|
|
55
|
+
* // Id: "STRING_VALUE",
|
|
56
|
+
* // Name: "STRING_VALUE",
|
|
57
|
+
* // Hypothesis: "STRING_VALUE",
|
|
58
|
+
* // Status: "ACTIVE" || "IDLE" || "ARCHIVED",
|
|
59
|
+
* // ConfigurationProfileId: "STRING_VALUE",
|
|
60
|
+
* // EnvironmentId: "STRING_VALUE",
|
|
61
|
+
* // FlagKey: "STRING_VALUE",
|
|
62
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
63
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // NextToken: "STRING_VALUE",
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param ListExperimentDefinitionsCommandInput - {@link ListExperimentDefinitionsCommandInput}
|
|
72
|
+
* @returns {@link ListExperimentDefinitionsCommandOutput}
|
|
73
|
+
* @see {@link ListExperimentDefinitionsCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link ListExperimentDefinitionsCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BadRequestException} (client fault)
|
|
78
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>There was an internal failure in the AppConfig service.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The requested resource could not be found.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link AppConfigServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from AppConfig service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @example To list experiment definitions
|
|
91
|
+
* ```javascript
|
|
92
|
+
* // The following ListExperimentDefinitions example lists the experiment definitions for an application.
|
|
93
|
+
* const input = {
|
|
94
|
+
* ApplicationIdentifier: "339ohji"
|
|
95
|
+
* };
|
|
96
|
+
* const command = new ListExperimentDefinitionsCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response is
|
|
99
|
+
* {
|
|
100
|
+
* Items: [
|
|
101
|
+
* {
|
|
102
|
+
* ApplicationId: "339ohji",
|
|
103
|
+
* ConfigurationProfileId: "ur8hx2f",
|
|
104
|
+
* CreatedAt: "2026-06-16T17:54:55.847Z",
|
|
105
|
+
* EnvironmentId: "54j1r29",
|
|
106
|
+
* FlagKey: "my-feature-flag",
|
|
107
|
+
* Id: "bsxyd7k",
|
|
108
|
+
* Name: "Example-Experiment-Definition",
|
|
109
|
+
* Status: "IDLE",
|
|
110
|
+
* UpdatedAt: "2026-06-16T17:57:36Z"
|
|
111
|
+
* }
|
|
112
|
+
* ]
|
|
113
|
+
* }
|
|
114
|
+
* *\/
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class ListExperimentDefinitionsCommand extends ListExperimentDefinitionsCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: ListExperimentDefinitionsRequest;
|
|
124
|
+
output: ExperimentDefinitions;
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: ListExperimentDefinitionsCommandInput;
|
|
128
|
+
output: ListExperimentDefinitionsCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|