@aws-sdk/client-appconfig 3.1074.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,229 @@
|
|
|
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, UpdateExperimentRunRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateExperimentRunCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateExperimentRunCommandInput extends UpdateExperimentRunRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateExperimentRunCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateExperimentRunCommandOutput extends ExperimentRun, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateExperimentRunCommand_base: {
|
|
25
|
+
new (input: UpdateExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<UpdateExperimentRunCommandInput, UpdateExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<UpdateExperimentRunCommandInput, UpdateExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { AppConfigClient, UpdateExperimentRunCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
|
|
37
|
+
* // const { AppConfigClient, UpdateExperimentRunCommand } = 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 = { // UpdateExperimentRunRequest
|
|
42
|
+
* ApplicationIdentifier: "STRING_VALUE", // required
|
|
43
|
+
* ExperimentDefinitionIdentifier: "STRING_VALUE", // required
|
|
44
|
+
* Run: Number("int"), // required
|
|
45
|
+
* Description: "STRING_VALUE",
|
|
46
|
+
* ExposurePercentage: Number("float"),
|
|
47
|
+
* TreatmentOverrides: { // TreatmentOverrides Union: only one key present
|
|
48
|
+
* Inline: { // TreatmentOverrideMap
|
|
49
|
+
* "<keys>": "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* DeploymentParameters: { // DeploymentParameters
|
|
53
|
+
* DynamicExtensionParameters: { // DynamicParameterMap
|
|
54
|
+
* "<keys>": "STRING_VALUE",
|
|
55
|
+
* },
|
|
56
|
+
* Tags: { // TagMap
|
|
57
|
+
* "<keys>": "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* };
|
|
61
|
+
* const command = new UpdateExperimentRunCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // { // ExperimentRun
|
|
64
|
+
* // ApplicationId: "STRING_VALUE",
|
|
65
|
+
* // ExperimentDefinitionId: "STRING_VALUE",
|
|
66
|
+
* // Run: Number("int"),
|
|
67
|
+
* // Description: "STRING_VALUE",
|
|
68
|
+
* // Status: "RUNNING" || "DONE",
|
|
69
|
+
* // ExposurePercentage: Number("float"),
|
|
70
|
+
* // TreatmentOverrides: { // TreatmentOverrides Union: only one key present
|
|
71
|
+
* // Inline: { // TreatmentOverrideMap
|
|
72
|
+
* // "<keys>": "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // Result: { // ExperimentRunResult
|
|
76
|
+
* // ExecutiveSummary: "STRING_VALUE",
|
|
77
|
+
* // ReasonsToLaunch: "STRING_VALUE",
|
|
78
|
+
* // ReasonsNotToLaunch: "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // StartedAt: new Date("TIMESTAMP"),
|
|
81
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
82
|
+
* // EndedAt: new Date("TIMESTAMP"),
|
|
83
|
+
* // ExperimentDefinitionSnapshot: { // ExperimentDefinitionSnapshot
|
|
84
|
+
* // ApplicationId: "STRING_VALUE",
|
|
85
|
+
* // Id: "STRING_VALUE",
|
|
86
|
+
* // Name: "STRING_VALUE",
|
|
87
|
+
* // Hypothesis: "STRING_VALUE",
|
|
88
|
+
* // ConfigurationProfileId: "STRING_VALUE",
|
|
89
|
+
* // EnvironmentId: "STRING_VALUE",
|
|
90
|
+
* // FlagKey: "STRING_VALUE",
|
|
91
|
+
* // AudienceRule: "STRING_VALUE",
|
|
92
|
+
* // AudienceDescription: "STRING_VALUE",
|
|
93
|
+
* // LaunchCriteria: "STRING_VALUE",
|
|
94
|
+
* // Treatments: [ // TreatmentList
|
|
95
|
+
* // { // Treatment
|
|
96
|
+
* // Key: "STRING_VALUE",
|
|
97
|
+
* // Weight: Number("float"), // required
|
|
98
|
+
* // Description: "STRING_VALUE",
|
|
99
|
+
* // FlagValue: { // FlagValue
|
|
100
|
+
* // Enabled: true || false, // required
|
|
101
|
+
* // AttributeValues: { // AttributeValueMap
|
|
102
|
+
* // "<keys>": { // AttributeValue Union: only one key present
|
|
103
|
+
* // StringValue: "STRING_VALUE",
|
|
104
|
+
* // NumberValue: Number("double"),
|
|
105
|
+
* // BooleanValue: true || false,
|
|
106
|
+
* // StringArray: [ // StringList
|
|
107
|
+
* // "STRING_VALUE",
|
|
108
|
+
* // ],
|
|
109
|
+
* // NumberArray: [ // NumberList
|
|
110
|
+
* // Number("double"),
|
|
111
|
+
* // ],
|
|
112
|
+
* // },
|
|
113
|
+
* // },
|
|
114
|
+
* // },
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // Control: {
|
|
118
|
+
* // Key: "STRING_VALUE",
|
|
119
|
+
* // Weight: Number("float"), // required
|
|
120
|
+
* // Description: "STRING_VALUE",
|
|
121
|
+
* // FlagValue: {
|
|
122
|
+
* // Enabled: true || false, // required
|
|
123
|
+
* // AttributeValues: {
|
|
124
|
+
* // "<keys>": {// Union: only one key present
|
|
125
|
+
* // StringValue: "STRING_VALUE",
|
|
126
|
+
* // NumberValue: Number("double"),
|
|
127
|
+
* // BooleanValue: true || false,
|
|
128
|
+
* // StringArray: [
|
|
129
|
+
* // "STRING_VALUE",
|
|
130
|
+
* // ],
|
|
131
|
+
* // NumberArray: [
|
|
132
|
+
* // Number("double"),
|
|
133
|
+
* // ],
|
|
134
|
+
* // },
|
|
135
|
+
* // },
|
|
136
|
+
* // },
|
|
137
|
+
* // },
|
|
138
|
+
* // },
|
|
139
|
+
* // };
|
|
140
|
+
*
|
|
141
|
+
* ```
|
|
142
|
+
*
|
|
143
|
+
* @param UpdateExperimentRunCommandInput - {@link UpdateExperimentRunCommandInput}
|
|
144
|
+
* @returns {@link UpdateExperimentRunCommandOutput}
|
|
145
|
+
* @see {@link UpdateExperimentRunCommandInput} for command's `input` shape.
|
|
146
|
+
* @see {@link UpdateExperimentRunCommandOutput} for command's `response` shape.
|
|
147
|
+
* @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link BadRequestException} (client fault)
|
|
150
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link ConflictException} (client fault)
|
|
153
|
+
* <p>The request could not be processed because of conflict in the current state of the
|
|
154
|
+
* resource.</p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link InternalServerException} (server fault)
|
|
157
|
+
* <p>There was an internal failure in the AppConfig service.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
160
|
+
* <p>The requested resource could not be found.</p>
|
|
161
|
+
*
|
|
162
|
+
* @throws {@link AppConfigServiceException}
|
|
163
|
+
* <p>Base exception class for all service exceptions from AppConfig service.</p>
|
|
164
|
+
*
|
|
165
|
+
*
|
|
166
|
+
* @example To update an experiment run
|
|
167
|
+
* ```javascript
|
|
168
|
+
* // The following UpdateExperimentRun example increases the exposure percentage of a running experiment.
|
|
169
|
+
* const input = {
|
|
170
|
+
* ApplicationIdentifier: "339ohji",
|
|
171
|
+
* ExperimentDefinitionIdentifier: "bsxyd7k",
|
|
172
|
+
* ExposurePercentage: 75.0,
|
|
173
|
+
* Run: 1
|
|
174
|
+
* };
|
|
175
|
+
* const command = new UpdateExperimentRunCommand(input);
|
|
176
|
+
* const response = await client.send(command);
|
|
177
|
+
* /* response is
|
|
178
|
+
* {
|
|
179
|
+
* ApplicationId: "339ohji",
|
|
180
|
+
* ExperimentDefinitionId: "bsxyd7k",
|
|
181
|
+
* ExperimentDefinitionSnapshot: {
|
|
182
|
+
* ApplicationId: "339ohji",
|
|
183
|
+
* AudienceRule: `(eq $country "US")`,
|
|
184
|
+
* ConfigurationProfileId: "ur8hx2f",
|
|
185
|
+
* Control: {
|
|
186
|
+
* FlagValue: {
|
|
187
|
+
* Enabled: false
|
|
188
|
+
* },
|
|
189
|
+
* Key: "c",
|
|
190
|
+
* Weight: 50.0
|
|
191
|
+
* },
|
|
192
|
+
* EnvironmentId: "54j1r29",
|
|
193
|
+
* FlagKey: "my-feature-flag",
|
|
194
|
+
* Id: "bsxyd7k",
|
|
195
|
+
* Name: "Example-Experiment-Definition",
|
|
196
|
+
* Treatments: [
|
|
197
|
+
* {
|
|
198
|
+
* FlagValue: {
|
|
199
|
+
* Enabled: true
|
|
200
|
+
* },
|
|
201
|
+
* Key: "t1",
|
|
202
|
+
* Weight: 50.0
|
|
203
|
+
* }
|
|
204
|
+
* ]
|
|
205
|
+
* },
|
|
206
|
+
* ExposurePercentage: 75.0,
|
|
207
|
+
* Run: 1,
|
|
208
|
+
* StartedAt: "2026-06-16T17:57:10.046Z",
|
|
209
|
+
* Status: "RUNNING",
|
|
210
|
+
* UpdatedAt: "2026-06-16T18:01:24.769Z"
|
|
211
|
+
* }
|
|
212
|
+
* *\/
|
|
213
|
+
* ```
|
|
214
|
+
*
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
export declare class UpdateExperimentRunCommand extends UpdateExperimentRunCommand_base {
|
|
218
|
+
/** @internal type navigation helper, not in runtime. */
|
|
219
|
+
protected static __types: {
|
|
220
|
+
api: {
|
|
221
|
+
input: UpdateExperimentRunRequest;
|
|
222
|
+
output: ExperimentRun;
|
|
223
|
+
};
|
|
224
|
+
sdk: {
|
|
225
|
+
input: UpdateExperimentRunCommandInput;
|
|
226
|
+
output: UpdateExperimentRunCommandOutput;
|
|
227
|
+
};
|
|
228
|
+
};
|
|
229
|
+
}
|
|
@@ -2,6 +2,7 @@ export * from "./CreateApplicationCommand";
|
|
|
2
2
|
export * from "./CreateConfigurationProfileCommand";
|
|
3
3
|
export * from "./CreateDeploymentStrategyCommand";
|
|
4
4
|
export * from "./CreateEnvironmentCommand";
|
|
5
|
+
export * from "./CreateExperimentDefinitionCommand";
|
|
5
6
|
export * from "./CreateExtensionAssociationCommand";
|
|
6
7
|
export * from "./CreateExtensionCommand";
|
|
7
8
|
export * from "./CreateHostedConfigurationVersionCommand";
|
|
@@ -9,6 +10,7 @@ export * from "./DeleteApplicationCommand";
|
|
|
9
10
|
export * from "./DeleteConfigurationProfileCommand";
|
|
10
11
|
export * from "./DeleteDeploymentStrategyCommand";
|
|
11
12
|
export * from "./DeleteEnvironmentCommand";
|
|
13
|
+
export * from "./DeleteExperimentDefinitionCommand";
|
|
12
14
|
export * from "./DeleteExtensionAssociationCommand";
|
|
13
15
|
export * from "./DeleteExtensionCommand";
|
|
14
16
|
export * from "./DeleteHostedConfigurationVersionCommand";
|
|
@@ -19,6 +21,8 @@ export * from "./GetConfigurationProfileCommand";
|
|
|
19
21
|
export * from "./GetDeploymentCommand";
|
|
20
22
|
export * from "./GetDeploymentStrategyCommand";
|
|
21
23
|
export * from "./GetEnvironmentCommand";
|
|
24
|
+
export * from "./GetExperimentDefinitionCommand";
|
|
25
|
+
export * from "./GetExperimentRunCommand";
|
|
22
26
|
export * from "./GetExtensionAssociationCommand";
|
|
23
27
|
export * from "./GetExtensionCommand";
|
|
24
28
|
export * from "./GetHostedConfigurationVersionCommand";
|
|
@@ -27,12 +31,17 @@ export * from "./ListConfigurationProfilesCommand";
|
|
|
27
31
|
export * from "./ListDeploymentStrategiesCommand";
|
|
28
32
|
export * from "./ListDeploymentsCommand";
|
|
29
33
|
export * from "./ListEnvironmentsCommand";
|
|
34
|
+
export * from "./ListExperimentDefinitionsCommand";
|
|
35
|
+
export * from "./ListExperimentRunEventsCommand";
|
|
36
|
+
export * from "./ListExperimentRunsCommand";
|
|
30
37
|
export * from "./ListExtensionAssociationsCommand";
|
|
31
38
|
export * from "./ListExtensionsCommand";
|
|
32
39
|
export * from "./ListHostedConfigurationVersionsCommand";
|
|
33
40
|
export * from "./ListTagsForResourceCommand";
|
|
34
41
|
export * from "./StartDeploymentCommand";
|
|
42
|
+
export * from "./StartExperimentRunCommand";
|
|
35
43
|
export * from "./StopDeploymentCommand";
|
|
44
|
+
export * from "./StopExperimentRunCommand";
|
|
36
45
|
export * from "./TagResourceCommand";
|
|
37
46
|
export * from "./UntagResourceCommand";
|
|
38
47
|
export * from "./UpdateAccountSettingsCommand";
|
|
@@ -40,6 +49,8 @@ export * from "./UpdateApplicationCommand";
|
|
|
40
49
|
export * from "./UpdateConfigurationProfileCommand";
|
|
41
50
|
export * from "./UpdateDeploymentStrategyCommand";
|
|
42
51
|
export * from "./UpdateEnvironmentCommand";
|
|
52
|
+
export * from "./UpdateExperimentDefinitionCommand";
|
|
53
|
+
export * from "./UpdateExperimentRunCommand";
|
|
43
54
|
export * from "./UpdateExtensionAssociationCommand";
|
|
44
55
|
export * from "./UpdateExtensionCommand";
|
|
45
56
|
export * from "./ValidateConfigurationCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,45 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>AppConfig feature flags and dynamic configurations
|
|
3
|
-
*
|
|
4
|
-
* code deployments. AppConfig speeds up software release frequency, improves
|
|
5
|
-
* application resiliency, and helps you address emergent issues more quickly. With feature
|
|
6
|
-
* flags, you can gradually release new capabilities to users and measure the impact of those
|
|
7
|
-
* changes before fully deploying the new capabilities to all users. With operational flags
|
|
8
|
-
* and dynamic configurations, you can update block lists, allow lists, throttling limits,
|
|
9
|
-
* logging verbosity, and perform other operational tuning to quickly respond to issues in
|
|
10
|
-
* production environments.</p>
|
|
11
|
-
* <note>
|
|
12
|
-
* <p>AppConfig is a tool in Amazon Web Services Systems Manager.</p>
|
|
13
|
-
* </note>
|
|
14
|
-
* <p>Despite the fact that application configuration content can vary greatly from
|
|
15
|
-
* application to application, AppConfig supports the following use cases, which
|
|
16
|
-
* cover a broad spectrum of customer needs:</p>
|
|
2
|
+
* <p>AppConfig helps you safely change application behavior in production without redeploying code. Using feature flags and dynamic free-form configurations, you can control how your application runs in real time. This approach reduces risk, accelerates releases, and enables faster responses to issues. You can gradually roll out new features to specific users, monitor their impact, and expand availability with confidence. You can also update block lists, allow lists, throttling limits, and logging levels instantly, allowing you to mitigate issues and fine-tune performance without a deployment.</p>
|
|
3
|
+
* <p>AppConfig supports a broad spectrum of use cases:</p>
|
|
17
4
|
* <ul>
|
|
18
5
|
* <li>
|
|
19
6
|
* <p>
|
|
20
|
-
* <b>Feature flags and toggles</b>
|
|
21
|
-
* capabilities to your customers in a controlled environment. Instantly roll back
|
|
22
|
-
* changes if you experience a problem.</p>
|
|
7
|
+
* <b>Feature flags and toggles</b> – Gradually release new capabilities to targeted users, monitor impact, and instantly roll back changes if issues occur.</p>
|
|
23
8
|
* </li>
|
|
24
9
|
* <li>
|
|
25
10
|
* <p>
|
|
26
|
-
* <b>Application tuning</b>
|
|
27
|
-
* application changes while testing the impact of those changes with users in
|
|
28
|
-
* production environments.</p>
|
|
11
|
+
* <b>Application tuning</b> – Introduce changes safely in production, measure their effects, and refine behavior without redeploying code.</p>
|
|
29
12
|
* </li>
|
|
30
13
|
* <li>
|
|
31
14
|
* <p>
|
|
32
|
-
* <b>Allow list or block list</b>
|
|
33
|
-
* premium features or instantly block specific users without deploying new code.
|
|
34
|
-
* </p>
|
|
15
|
+
* <b>Allow list or block list</b> – Control access to features or restrict specific users in real time, without modifying application code. </p>
|
|
35
16
|
* </li>
|
|
36
17
|
* <li>
|
|
37
18
|
* <p>
|
|
38
|
-
* <b>Centralized configuration storage</b>
|
|
39
|
-
* configuration data organized and consistent across all of your workloads. You can use
|
|
40
|
-
* AppConfig to deploy configuration data stored in the AppConfig
|
|
41
|
-
* hosted configuration store, Secrets Manager, Systems Manager, Parameter
|
|
42
|
-
* Store, or Amazon S3.</p>
|
|
19
|
+
* <b>Centralized configuration storage</b> – Manage configuration data consistently across workloads. AppConfig can deploy configuration from the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Systems Manager Parameter Store, or Amazon S3.</p>
|
|
43
20
|
* </li>
|
|
44
21
|
* </ul>
|
|
45
22
|
* <p>
|
|
@@ -48,103 +25,50 @@
|
|
|
48
25
|
* <p>This section provides a high-level description of how AppConfig works and how
|
|
49
26
|
* you get started.</p>
|
|
50
27
|
* <dl>
|
|
51
|
-
* <dt>1. Identify configuration
|
|
28
|
+
* <dt>1. Identify configuration data to manage in AppConfig</dt>
|
|
52
29
|
* <dd>
|
|
53
|
-
* <p>Before you
|
|
54
|
-
*
|
|
55
|
-
* AppConfig. Good examples include feature flags or toggles, allow and
|
|
56
|
-
* block lists, logging verbosity, service limits, and throttling rules, to name a
|
|
57
|
-
* few.</p>
|
|
58
|
-
* <p>If your configuration data already exists in the cloud, you can take advantage
|
|
59
|
-
* of AppConfig validation, deployment, and extension features to further
|
|
60
|
-
* streamline configuration data management.</p>
|
|
30
|
+
* <p>Before creating a configuration profile, identify the configuration data in your code that you want to manage dynamically using AppConfig. Common examples include feature flags, allow and block lists, logging levels, service limits, and throttling rules. These values tend to change frequently and can cause issues if misconfigured.</p>
|
|
31
|
+
* <p>If your configuration data already exists in cloud services such as Systems Manager Parameter Store or Amazon S3, you can use AppConfig to validate, deploy, and manage that data more effectively.</p>
|
|
61
32
|
* </dd>
|
|
62
|
-
* <dt>2. Create
|
|
33
|
+
* <dt>2. Create a configuration profile in AppConfig</dt>
|
|
63
34
|
* <dd>
|
|
64
|
-
* <p>
|
|
65
|
-
*
|
|
66
|
-
* folder.</p>
|
|
67
|
-
* </dd>
|
|
68
|
-
* <dt>3. Create environments</dt>
|
|
69
|
-
* <dd>
|
|
70
|
-
* <p>For each AppConfig application, you define one or more environments.
|
|
71
|
-
* An environment is a logical grouping of targets, such as applications in a
|
|
72
|
-
* <code>Beta</code> or <code>Production</code> environment, Lambda functions,
|
|
73
|
-
* or containers. You can also define environments for application subcomponents,
|
|
74
|
-
* such as the <code>Web</code>, <code>Mobile</code>, and
|
|
75
|
-
* <code>Back-end</code>.</p>
|
|
76
|
-
* <p>You can configure Amazon CloudWatch alarms for each environment. The system monitors
|
|
77
|
-
* alarms during a configuration deployment. If an alarm is triggered, the system
|
|
78
|
-
* rolls back the configuration.</p>
|
|
79
|
-
* </dd>
|
|
80
|
-
* <dt>4. Create a configuration profile</dt>
|
|
81
|
-
* <dd>
|
|
82
|
-
* <p>A configuration profile includes, among other things, a URI that enables
|
|
83
|
-
* AppConfig to locate your configuration data in its stored location
|
|
84
|
-
* and a profile type. AppConfig supports two configuration profile types:
|
|
85
|
-
* feature flags and freeform configurations. Feature flag configuration profiles
|
|
86
|
-
* store their data in the AppConfig hosted configuration store and the URI
|
|
87
|
-
* is simply <code>hosted</code>. For freeform configuration profiles, you can store
|
|
88
|
-
* your data in the AppConfig hosted configuration store or any Amazon Web Services
|
|
89
|
-
* service that integrates with AppConfig, as described in <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-free-form-configurations-creating.html">Creating
|
|
90
|
-
* a free form configuration profile</a> in the the <i>AppConfig User Guide</i>.</p>
|
|
91
|
-
* <p>A configuration profile can also include optional validators to ensure your
|
|
92
|
-
* configuration data is syntactically and semantically correct. AppConfig
|
|
93
|
-
* performs a check using the validators when you start a deployment. If any errors
|
|
94
|
-
* are detected, the deployment rolls back to the previous configuration data.</p>
|
|
95
|
-
* </dd>
|
|
96
|
-
* <dt>5. Deploy configuration data</dt>
|
|
97
|
-
* <dd>
|
|
98
|
-
* <p>When you create a new deployment, you specify the following:</p>
|
|
35
|
+
* <p>A configuration profile defines how AppConfig locates and manages your configuration data. It includes a URI that points to the data source and a profile type.</p>
|
|
36
|
+
* <p>AppConfig supports two profile types</p>
|
|
99
37
|
* <ul>
|
|
100
38
|
* <li>
|
|
101
|
-
* <p>
|
|
102
|
-
*
|
|
103
|
-
* <li>
|
|
104
|
-
* <p>A configuration profile ID</p>
|
|
105
|
-
* </li>
|
|
106
|
-
* <li>
|
|
107
|
-
* <p>A configuration version</p>
|
|
39
|
+
* <p>
|
|
40
|
+
* <b>Feature flags</b> – Enable controlled feature releases, gradual rollouts, and testing in production.</p>
|
|
108
41
|
* </li>
|
|
109
42
|
* <li>
|
|
110
|
-
* <p>
|
|
111
|
-
*
|
|
112
|
-
* <li>
|
|
113
|
-
* <p>A deployment strategy ID that defines how fast you want the changes to
|
|
114
|
-
* take effect</p>
|
|
43
|
+
* <p>
|
|
44
|
+
* <b>Free-form configurations</b> – Store and retrieve configuration data from external sources and update it without redeploying code.</p>
|
|
115
45
|
* </li>
|
|
116
46
|
* </ul>
|
|
117
|
-
* <p>
|
|
118
|
-
*
|
|
47
|
+
* <p>Both profile types help decouple configuration from code, support continuous delivery, and reduce deployment risk.</p>
|
|
48
|
+
* <p>You can also add optional validators to ensure that configuration data is syntactically and semantically correct. During deployment, AppConfig evaluates these validators and automatically rolls back changes if validation fails.</p>
|
|
49
|
+
* <p>Each configuration profile is associated with an application, which acts as a logical container for your configuration resources. For more information about creating a configuration profile, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-profile.html">Creating a configuration profile in AppConfig</a> in the the <i>AppConfig User Guide</i>.</p>
|
|
50
|
+
* </dd>
|
|
51
|
+
* <dt>3. Deploy configuration data</dt>
|
|
52
|
+
* <dd>
|
|
53
|
+
* <p>When you start a deployment, AppConfig:</p>
|
|
119
54
|
* <ol>
|
|
120
55
|
* <li>
|
|
121
|
-
* <p>Retrieves
|
|
122
|
-
* the location URI in the configuration profile.</p>
|
|
56
|
+
* <p>Retrieves configuration data from the source defined in the configuration profile</p>
|
|
123
57
|
* </li>
|
|
124
58
|
* <li>
|
|
125
|
-
* <p>
|
|
126
|
-
* by using the validators you specified when you created your configuration
|
|
127
|
-
* profile.</p>
|
|
59
|
+
* <p>Validates the data using the configured validators</p>
|
|
128
60
|
* </li>
|
|
129
61
|
* <li>
|
|
130
|
-
* <p>
|
|
131
|
-
* application. This cached copy is called the <i>deployed
|
|
132
|
-
* data</i>.</p>
|
|
62
|
+
* <p>Delivers the validated configuration to AppConfig Agent</p>
|
|
133
63
|
* </li>
|
|
134
64
|
* </ol>
|
|
65
|
+
* <p>The delivered configuration becomes the deployed version used by your application. For more information about deploying a configuration, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/deploying-feature-flags.html">Deploying feature flags and configuration data in AppConfig</a>.</p>
|
|
135
66
|
* </dd>
|
|
136
|
-
* <dt>
|
|
67
|
+
* <dt>4. Retrieve configuration data</dt>
|
|
137
68
|
* <dd>
|
|
138
|
-
* <p>
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* localhost server. AppConfig Agent supports several use cases, as
|
|
142
|
-
* described in <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-simplified-methods.html">Simplified
|
|
143
|
-
* retrieval methods</a> in the the <i>AppConfig User
|
|
144
|
-
* Guide</i>.</p>
|
|
145
|
-
* <p>If AppConfig Agent isn't supported for your use case, you can
|
|
146
|
-
* configure your application to poll AppConfig for configuration updates
|
|
147
|
-
* by directly calling the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> API actions. </p>
|
|
69
|
+
* <p>Your application retrieves configuration data by calling a local endpoint exposed by AppConfig Agent, which caches the deployed configuration. Retrieving data is a metered event. AppConfig Agent supports a variety of use cases, as described in <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-agent-how-to-use.html">How to use AppConfig Agent to retrieve configuration data</a>.</p>
|
|
70
|
+
* <p>If the agent is not suitable for your use case, your application can retrieve configuration data directly from AppConfig by calling the <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html">StartConfigurationSession</a> and <a href="https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html">GetLatestConfiguration</a> API actions. </p>
|
|
71
|
+
* <p>For more information about retrieving a configuration, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html">Retrieving feature flags and configuration data in AppConfig</a>.</p>
|
|
148
72
|
* </dd>
|
|
149
73
|
* </dl>
|
|
150
74
|
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
|
|
@@ -78,6 +78,19 @@ export declare const EnvironmentState: {
|
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
80
|
export type EnvironmentState = (typeof EnvironmentState)[keyof typeof EnvironmentState];
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
* @enum
|
|
84
|
+
*/
|
|
85
|
+
export declare const ExperimentDefinitionStatus: {
|
|
86
|
+
readonly ACTIVE: "ACTIVE";
|
|
87
|
+
readonly ARCHIVED: "ARCHIVED";
|
|
88
|
+
readonly IDLE: "IDLE";
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export type ExperimentDefinitionStatus = (typeof ExperimentDefinitionStatus)[keyof typeof ExperimentDefinitionStatus];
|
|
81
94
|
/**
|
|
82
95
|
* @public
|
|
83
96
|
* @enum
|
|
@@ -102,6 +115,18 @@ export declare const DeletionProtectionCheck: {
|
|
|
102
115
|
* @public
|
|
103
116
|
*/
|
|
104
117
|
export type DeletionProtectionCheck = (typeof DeletionProtectionCheck)[keyof typeof DeletionProtectionCheck];
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
* @enum
|
|
121
|
+
*/
|
|
122
|
+
export declare const DeleteType: {
|
|
123
|
+
readonly ARCHIVE: "ARCHIVE";
|
|
124
|
+
readonly DESTROY: "DESTROY";
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
export type DeleteType = (typeof DeleteType)[keyof typeof DeleteType];
|
|
105
130
|
/**
|
|
106
131
|
* @public
|
|
107
132
|
* @enum
|
|
@@ -150,3 +175,41 @@ export declare const DeploymentState: {
|
|
|
150
175
|
* @public
|
|
151
176
|
*/
|
|
152
177
|
export type DeploymentState = (typeof DeploymentState)[keyof typeof DeploymentState];
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
* @enum
|
|
181
|
+
*/
|
|
182
|
+
export declare const ExperimentRunStatus: {
|
|
183
|
+
readonly DONE: "DONE";
|
|
184
|
+
readonly RUNNING: "RUNNING";
|
|
185
|
+
};
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export type ExperimentRunStatus = (typeof ExperimentRunStatus)[keyof typeof ExperimentRunStatus];
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
* @enum
|
|
193
|
+
*/
|
|
194
|
+
export declare const DeploymentType: {
|
|
195
|
+
readonly MANAGED: "MANAGED";
|
|
196
|
+
readonly USER: "USER";
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType];
|
|
202
|
+
/**
|
|
203
|
+
* @public
|
|
204
|
+
* @enum
|
|
205
|
+
*/
|
|
206
|
+
export declare const ExperimentRunEventType: {
|
|
207
|
+
readonly EXPOSURE_UPDATED: "EXPOSURE_UPDATED";
|
|
208
|
+
readonly OVERRIDES_UPDATED: "OVERRIDES_UPDATED";
|
|
209
|
+
readonly RUN_STARTED: "RUN_STARTED";
|
|
210
|
+
readonly RUN_STOPPED: "RUN_STOPPED";
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
export type ExperimentRunEventType = (typeof ExperimentRunEventType)[keyof typeof ExperimentRunEventType];
|
|
@@ -39,9 +39,6 @@ export declare class InternalServerException extends __BaseException {
|
|
|
39
39
|
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
|
|
40
40
|
* environment doesn't exceed the following service quotas:</p>
|
|
41
41
|
* <p>Applications: 100 max</p>
|
|
42
|
-
* <p>Deployment strategies: 20 max</p>
|
|
43
|
-
* <p>Configuration profiles: 100 max per application</p>
|
|
44
|
-
* <p>Environments: 20 max per application</p>
|
|
45
42
|
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you can
|
|
46
43
|
* request a quota increase. For more information about quotas and to request an increase, see
|
|
47
44
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
|