@aws-sdk/client-appconfig 3.1075.0 → 3.1077.0

package/dist-types/commands/StopExperimentRunCommand.d.ts

@@ -0,0 +1,231 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
+import type { ExperimentRun, StopExperimentRunRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StopExperimentRunCommand}.
+ */
+export interface StopExperimentRunCommandInput extends StopExperimentRunRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StopExperimentRunCommand}.
+ */
+export interface StopExperimentRunCommandOutput extends ExperimentRun, __MetadataBearer {
+}
+declare const StopExperimentRunCommand_base: {
+    new (input: StopExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<StopExperimentRunCommandInput, StopExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StopExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<StopExperimentRunCommandInput, StopExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Stops a running experiment. Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppConfigClient, StopExperimentRunCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
+ * // const { AppConfigClient, StopExperimentRunCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
+ * // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
+ * const config = {}; // type is AppConfigClientConfig
+ * const client = new AppConfigClient(config);
+ * const input = { // StopExperimentRunRequest
+ *   ApplicationIdentifier: "STRING_VALUE", // required
+ *   ExperimentDefinitionIdentifier: "STRING_VALUE", // required
+ *   Run: Number("int"), // required
+ *   Result: { // ExperimentRunResult
+ *     ExecutiveSummary: "STRING_VALUE",
+ *     ReasonsToLaunch: "STRING_VALUE",
+ *     ReasonsNotToLaunch: "STRING_VALUE",
+ *   },
+ *   DeploymentParameters: { // DeploymentParameters
+ *     DynamicExtensionParameters: { // DynamicParameterMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Tags: { // TagMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
+ * };
+ * const command = new StopExperimentRunCommand(input);
+ * const response = await client.send(command);
+ * // { // ExperimentRun
+ * //   ApplicationId: "STRING_VALUE",
+ * //   ExperimentDefinitionId: "STRING_VALUE",
+ * //   Run: Number("int"),
+ * //   Description: "STRING_VALUE",
+ * //   Status: "RUNNING" || "DONE",
+ * //   ExposurePercentage: Number("float"),
+ * //   TreatmentOverrides: { // TreatmentOverrides Union: only one key present
+ * //     Inline: { // TreatmentOverrideMap
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   Result: { // ExperimentRunResult
+ * //     ExecutiveSummary: "STRING_VALUE",
+ * //     ReasonsToLaunch: "STRING_VALUE",
+ * //     ReasonsNotToLaunch: "STRING_VALUE",
+ * //   },
+ * //   StartedAt: new Date("TIMESTAMP"),
+ * //   UpdatedAt: new Date("TIMESTAMP"),
+ * //   EndedAt: new Date("TIMESTAMP"),
+ * //   ExperimentDefinitionSnapshot: { // ExperimentDefinitionSnapshot
+ * //     ApplicationId: "STRING_VALUE",
+ * //     Id: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Hypothesis: "STRING_VALUE",
+ * //     ConfigurationProfileId: "STRING_VALUE",
+ * //     EnvironmentId: "STRING_VALUE",
+ * //     FlagKey: "STRING_VALUE",
+ * //     AudienceRule: "STRING_VALUE",
+ * //     AudienceDescription: "STRING_VALUE",
+ * //     LaunchCriteria: "STRING_VALUE",
+ * //     Treatments: [ // TreatmentList
+ * //       { // Treatment
+ * //         Key: "STRING_VALUE",
+ * //         Weight: Number("float"), // required
+ * //         Description: "STRING_VALUE",
+ * //         FlagValue: { // FlagValue
+ * //           Enabled: true || false, // required
+ * //           AttributeValues: { // AttributeValueMap
+ * //             "<keys>": { // AttributeValue Union: only one key present
+ * //               StringValue: "STRING_VALUE",
+ * //               NumberValue: Number("double"),
+ * //               BooleanValue: true || false,
+ * //               StringArray: [ // StringList
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               NumberArray: [ // NumberList
+ * //                 Number("double"),
+ * //               ],
+ * //             },
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     Control: {
+ * //       Key: "STRING_VALUE",
+ * //       Weight: Number("float"), // required
+ * //       Description: "STRING_VALUE",
+ * //       FlagValue: {
+ * //         Enabled: true || false, // required
+ * //         AttributeValues: {
+ * //           "<keys>": {//  Union: only one key present
+ * //             StringValue: "STRING_VALUE",
+ * //             NumberValue: Number("double"),
+ * //             BooleanValue: true || false,
+ * //             StringArray: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             NumberArray: [
+ * //               Number("double"),
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param StopExperimentRunCommandInput - {@link StopExperimentRunCommandInput}
+ * @returns {@link StopExperimentRunCommandOutput}
+ * @see {@link StopExperimentRunCommandInput} for command's `input` shape.
+ * @see {@link StopExperimentRunCommandOutput} for command's `response` shape.
+ * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ * @throws {@link AppConfigServiceException}
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
+ *
+ *
+ * @example To stop an experiment run
+ * ```javascript
+ * // The following StopExperimentRun example stops a running experiment and records the result.
+ * const input = {
+ *   ApplicationIdentifier: "339ohji",
+ *   ExperimentDefinitionIdentifier: "bsxyd7k",
+ *   Result: {
+ *     ExecutiveSummary: "t1 wins with 16% lift in conversion",
+ *     ReasonsToLaunch: "Significant improvement in key metric"
+ *   },
+ *   Run: 1
+ * };
+ * const command = new StopExperimentRunCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   ApplicationId: "339ohji",
+ *   EndedAt: "2026-06-16T17:57:36.083Z",
+ *   ExperimentDefinitionId: "bsxyd7k",
+ *   ExperimentDefinitionSnapshot: {
+ *     ApplicationId: "339ohji",
+ *     AudienceRule: `(eq $country "US")`,
+ *     ConfigurationProfileId: "ur8hx2f",
+ *     Control: {
+ *       FlagValue: {
+ *         Enabled: false
+ *       },
+ *       Key: "c",
+ *       Weight: 50.0
+ *     },
+ *     EnvironmentId: "54j1r29",
+ *     FlagKey: "my-feature-flag",
+ *     Id: "bsxyd7k",
+ *     Name: "Example-Experiment-Definition",
+ *     Treatments: [
+ *       {
+ *         FlagValue: {
+ *           Enabled: true
+ *         },
+ *         Key: "t1",
+ *         Weight: 50.0
+ *       }
+ *     ]
+ *   },
+ *   ExposurePercentage: 50.0,
+ *   Result: {
+ *     ExecutiveSummary: "t1 wins with 16% lift in conversion",
+ *     ReasonsToLaunch: "Significant improvement in key metric"
+ *   },
+ *   Run: 1,
+ *   StartedAt: "2026-06-16T17:57:10.046Z",
+ *   Status: "DONE",
+ *   UpdatedAt: "2026-06-16T17:57:36.083Z"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class StopExperimentRunCommand extends StopExperimentRunCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StopExperimentRunRequest;
+            output: ExperimentRun;
+        };
+        sdk: {
+            input: StopExperimentRunCommandInput;
+            output: StopExperimentRunCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateAccountSettingsCommand.d.ts

@@ -43,6 +43,9 @@ declare const UpdateAccountSettingsCommand_base: {
  *     Enabled: true || false,
  *     ProtectionPeriodInMinutes: Number("int"),
  *   },
+ *   VendedMetrics: { // VendedMetricsSettings
+ *     Enabled: true || false,
+ *   },
  * };
  * const command = new UpdateAccountSettingsCommand(input);
  * const response = await client.send(command);
@@ -51,6 +54,9 @@ declare const UpdateAccountSettingsCommand_base: {
  * //     Enabled: true || false,
  * //     ProtectionPeriodInMinutes: Number("int"),
  * //   },
+ * //   VendedMetrics: { // VendedMetricsSettings
+ * //     Enabled: true || false,
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/UpdateExperimentDefinitionCommand.d.ts

@@ -0,0 +1,237 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigClient";
+import type { ExperimentDefinition, UpdateExperimentDefinitionRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateExperimentDefinitionCommand}.
+ */
+export interface UpdateExperimentDefinitionCommandInput extends UpdateExperimentDefinitionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateExperimentDefinitionCommand}.
+ */
+export interface UpdateExperimentDefinitionCommandOutput extends ExperimentDefinition, __MetadataBearer {
+}
+declare const UpdateExperimentDefinitionCommand_base: {
+    new (input: UpdateExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<UpdateExperimentDefinitionCommandInput, UpdateExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateExperimentDefinitionCommandInput): import("@smithy/core/client").CommandImpl<UpdateExperimentDefinitionCommandInput, UpdateExperimentDefinitionCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Updates an experiment definition. You can update treatments, the control, audience rules, and other properties. You cannot update an experiment definition while an experiment run is active.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppConfigClient, UpdateExperimentDefinitionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
+ * // const { AppConfigClient, UpdateExperimentDefinitionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
+ * // import type { AppConfigClientConfig } from "@aws-sdk/client-appconfig";
+ * const config = {}; // type is AppConfigClientConfig
+ * const client = new AppConfigClient(config);
+ * const input = { // UpdateExperimentDefinitionRequest
+ *   ApplicationIdentifier: "STRING_VALUE", // required
+ *   ExperimentDefinitionIdentifier: "STRING_VALUE", // required
+ *   Treatments: [ // TreatmentInputList
+ *     { // TreatmentInput
+ *       Weight: Number("float"), // required
+ *       Description: "STRING_VALUE",
+ *       FlagValue: { // FlagValue
+ *         Enabled: true || false, // required
+ *         AttributeValues: { // AttributeValueMap
+ *           "<keys>": { // AttributeValue Union: only one key present
+ *             StringValue: "STRING_VALUE",
+ *             NumberValue: Number("double"),
+ *             BooleanValue: true || false,
+ *             StringArray: [ // StringList
+ *               "STRING_VALUE",
+ *             ],
+ *             NumberArray: [ // NumberList
+ *               Number("double"),
+ *             ],
+ *           },
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   Control: {
+ *     Weight: Number("float"), // required
+ *     Description: "STRING_VALUE",
+ *     FlagValue: {
+ *       Enabled: true || false, // required
+ *       AttributeValues: {
+ *         "<keys>": {//  Union: only one key present
+ *           StringValue: "STRING_VALUE",
+ *           NumberValue: Number("double"),
+ *           BooleanValue: true || false,
+ *           StringArray: [
+ *             "STRING_VALUE",
+ *           ],
+ *           NumberArray: [
+ *             Number("double"),
+ *           ],
+ *         },
+ *       },
+ *     },
+ *   },
+ *   Hypothesis: "STRING_VALUE",
+ *   AudienceRule: "STRING_VALUE",
+ *   AudienceDescription: "STRING_VALUE",
+ *   LaunchCriteria: "STRING_VALUE",
+ * };
+ * const command = new UpdateExperimentDefinitionCommand(input);
+ * const response = await client.send(command);
+ * // { // ExperimentDefinition
+ * //   ApplicationId: "STRING_VALUE",
+ * //   Id: "STRING_VALUE",
+ * //   Name: "STRING_VALUE",
+ * //   Hypothesis: "STRING_VALUE",
+ * //   Status: "ACTIVE" || "IDLE" || "ARCHIVED",
+ * //   ConfigurationProfileId: "STRING_VALUE",
+ * //   EnvironmentId: "STRING_VALUE",
+ * //   FlagKey: "STRING_VALUE",
+ * //   AudienceRule: "STRING_VALUE",
+ * //   AudienceDescription: "STRING_VALUE",
+ * //   LaunchCriteria: "STRING_VALUE",
+ * //   Treatments: [ // TreatmentList
+ * //     { // Treatment
+ * //       Key: "STRING_VALUE",
+ * //       Weight: Number("float"), // required
+ * //       Description: "STRING_VALUE",
+ * //       FlagValue: { // FlagValue
+ * //         Enabled: true || false, // required
+ * //         AttributeValues: { // AttributeValueMap
+ * //           "<keys>": { // AttributeValue Union: only one key present
+ * //             StringValue: "STRING_VALUE",
+ * //             NumberValue: Number("double"),
+ * //             BooleanValue: true || false,
+ * //             StringArray: [ // StringList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             NumberArray: [ // NumberList
+ * //               Number("double"),
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   Control: {
+ * //     Key: "STRING_VALUE",
+ * //     Weight: Number("float"), // required
+ * //     Description: "STRING_VALUE",
+ * //     FlagValue: {
+ * //       Enabled: true || false, // required
+ * //       AttributeValues: {
+ * //         "<keys>": {//  Union: only one key present
+ * //           StringValue: "STRING_VALUE",
+ * //           NumberValue: Number("double"),
+ * //           BooleanValue: true || false,
+ * //           StringArray: [
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           NumberArray: [
+ * //             Number("double"),
+ * //           ],
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * //   CreatedAt: new Date("TIMESTAMP"),
+ * //   UpdatedAt: new Date("TIMESTAMP"),
+ * //   KmsKeyIdentifier: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateExperimentDefinitionCommandInput - {@link UpdateExperimentDefinitionCommandInput}
+ * @returns {@link UpdateExperimentDefinitionCommandOutput}
+ * @see {@link UpdateExperimentDefinitionCommandInput} for command's `input` shape.
+ * @see {@link UpdateExperimentDefinitionCommandOutput} for command's `response` shape.
+ * @see {@link AppConfigClientResolvedConfig | config} for AppConfigClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the
+ *          resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal failure in the AppConfig service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource could not be found.</p>
+ *
+ * @throws {@link AppConfigServiceException}
+ * <p>Base exception class for all service exceptions from AppConfig service.</p>
+ *
+ *
+ * @example To update an experiment definition
+ * ```javascript
+ * // The following UpdateExperimentDefinition example updates the hypothesis and audience rule of an experiment definition.
+ * const input = {
+ *   ApplicationIdentifier: "339ohji",
+ *   AudienceRule: `(eq $country "US")`,
+ *   ExperimentDefinitionIdentifier: "bsxyd7k",
+ *   Hypothesis: "Enabling the feature will increase conversion by 10%"
+ * };
+ * const command = new UpdateExperimentDefinitionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   ApplicationId: "339ohji",
+ *   AudienceRule: `(eq $country "US")`,
+ *   ConfigurationProfileId: "ur8hx2f",
+ *   Control: {
+ *     FlagValue: {
+ *       Enabled: false
+ *     },
+ *     Key: "c",
+ *     Weight: 50.0
+ *   },
+ *   CreatedAt: "2026-06-16T17:54:55.847Z",
+ *   EnvironmentId: "54j1r29",
+ *   FlagKey: "my-feature-flag",
+ *   Hypothesis: "Enabling the feature will increase conversion by 10%",
+ *   Id: "bsxyd7k",
+ *   Name: "Example-Experiment-Definition",
+ *   Status: "IDLE",
+ *   Treatments: [
+ *     {
+ *       FlagValue: {
+ *         Enabled: true
+ *       },
+ *       Key: "t1",
+ *       Weight: 50.0
+ *     }
+ *   ],
+ *   UpdatedAt: "2026-06-16T18:04:33.632Z"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateExperimentDefinitionCommand extends UpdateExperimentDefinitionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateExperimentDefinitionRequest;
+            output: ExperimentDefinition;
+        };
+        sdk: {
+            input: UpdateExperimentDefinitionCommandInput;
+            output: UpdateExperimentDefinitionCommandOutput;
+        };
+    };
+}