@aws-sdk/client-appconfig 3.1075.0 → 3.1077.0

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

@@ -0,0 +1,136 @@
+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 { ExperimentRunEvents, ListExperimentRunEventsRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListExperimentRunEventsCommand}.
+ */
+export interface ListExperimentRunEventsCommandInput extends ListExperimentRunEventsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListExperimentRunEventsCommand}.
+ */
+export interface ListExperimentRunEventsCommandOutput extends ExperimentRunEvents, __MetadataBearer {
+}
+declare const ListExperimentRunEventsCommand_base: {
+    new (input: ListExperimentRunEventsCommandInput): import("@smithy/core/client").CommandImpl<ListExperimentRunEventsCommandInput, ListExperimentRunEventsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListExperimentRunEventsCommandInput): import("@smithy/core/client").CommandImpl<ListExperimentRunEventsCommandInput, ListExperimentRunEventsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppConfigClient, ListExperimentRunEventsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
+ * // const { AppConfigClient, ListExperimentRunEventsCommand } = 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 = { // ListExperimentRunEventsRequest
+ *   ApplicationIdentifier: "STRING_VALUE", // required
+ *   ExperimentDefinitionIdentifier: "STRING_VALUE", // required
+ *   Run: Number("int"), // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListExperimentRunEventsCommand(input);
+ * const response = await client.send(command);
+ * // { // ExperimentRunEvents
+ * //   Items: [ // ExperimentRunEventList
+ * //     { // ExperimentRunEvent
+ * //       Description: "STRING_VALUE",
+ * //       AssociatedDeployment: "STRING_VALUE",
+ * //       EventType: "RUN_STARTED" || "EXPOSURE_UPDATED" || "OVERRIDES_UPDATED" || "RUN_STOPPED",
+ * //       OccurredAt: new Date("TIMESTAMP"),
+ * //       TriggeredBy: "USER" || "APPCONFIG" || "CLOUDWATCH_ALARM" || "INTERNAL_ERROR",
+ * //       ExposurePercentage: Number("float"),
+ * //       TreatmentOverrides: { // TreatmentOverrides Union: only one key present
+ * //         Inline: { // TreatmentOverrideMap
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListExperimentRunEventsCommandInput - {@link ListExperimentRunEventsCommandInput}
+ * @returns {@link ListExperimentRunEventsCommandOutput}
+ * @see {@link ListExperimentRunEventsCommandInput} for command's `input` shape.
+ * @see {@link ListExperimentRunEventsCommandOutput} 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 list experiment run events
+ * ```javascript
+ * // The following ListExperimentRunEvents example lists the events for an experiment run.
+ * const input = {
+ *   ApplicationIdentifier: "339ohji",
+ *   ExperimentDefinitionIdentifier: "bsxyd7k",
+ *   Run: 1
+ * };
+ * const command = new ListExperimentRunEventsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Items: [
+ *     {
+ *       Description: "Experiment run stopped",
+ *       EventType: "RUN_STOPPED",
+ *       ExposurePercentage: 50.0,
+ *       OccurredAt: "2026-06-16T17:57:36.083Z",
+ *       TriggeredBy: "USER"
+ *     },
+ *     {
+ *       Description: "Experiment run started",
+ *       EventType: "RUN_STARTED",
+ *       ExposurePercentage: 50.0,
+ *       OccurredAt: "2026-06-16T17:57:10.567Z",
+ *       TriggeredBy: "USER"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListExperimentRunEventsCommand extends ListExperimentRunEventsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListExperimentRunEventsRequest;
+            output: ExperimentRunEvents;
+        };
+        sdk: {
+            input: ListExperimentRunEventsCommandInput;
+            output: ListExperimentRunEventsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,125 @@
+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 { ExperimentRuns, ListExperimentRunsRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListExperimentRunsCommand}.
+ */
+export interface ListExperimentRunsCommandInput extends ListExperimentRunsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListExperimentRunsCommand}.
+ */
+export interface ListExperimentRunsCommandOutput extends ExperimentRuns, __MetadataBearer {
+}
+declare const ListExperimentRunsCommand_base: {
+    new (input: ListExperimentRunsCommandInput): import("@smithy/core/client").CommandImpl<ListExperimentRunsCommandInput, ListExperimentRunsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListExperimentRunsCommandInput): import("@smithy/core/client").CommandImpl<ListExperimentRunsCommandInput, ListExperimentRunsCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Lists the experiment runs for a specified experiment definition. You can filter by status.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppConfigClient, ListExperimentRunsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
+ * // const { AppConfigClient, ListExperimentRunsCommand } = 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 = { // ListExperimentRunsRequest
+ *   ApplicationIdentifier: "STRING_VALUE", // required
+ *   ExperimentDefinitionIdentifier: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   Status: "RUNNING" || "DONE",
+ * };
+ * const command = new ListExperimentRunsCommand(input);
+ * const response = await client.send(command);
+ * // { // ExperimentRuns
+ * //   Items: [ // ExperimentRunSummaryList
+ * //     { // ExperimentRunSummary
+ * //       ExperimentDefinitionId: "STRING_VALUE",
+ * //       Run: Number("int"),
+ * //       Description: "STRING_VALUE",
+ * //       Status: "RUNNING" || "DONE",
+ * //       StartedAt: new Date("TIMESTAMP"),
+ * //       UpdatedAt: new Date("TIMESTAMP"),
+ * //       EndedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListExperimentRunsCommandInput - {@link ListExperimentRunsCommandInput}
+ * @returns {@link ListExperimentRunsCommandOutput}
+ * @see {@link ListExperimentRunsCommandInput} for command's `input` shape.
+ * @see {@link ListExperimentRunsCommandOutput} 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 list experiment runs
+ * ```javascript
+ * // The following ListExperimentRuns example lists the experiment runs for an experiment definition.
+ * const input = {
+ *   ApplicationIdentifier: "339ohji",
+ *   ExperimentDefinitionIdentifier: "bsxyd7k"
+ * };
+ * const command = new ListExperimentRunsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Items: [
+ *     {
+ *       EndedAt: "2026-06-16T17:57:36.083Z",
+ *       ExperimentDefinitionId: "bsxyd7k",
+ *       Run: 1,
+ *       StartedAt: "2026-06-16T17:57:10.046Z",
+ *       Status: "DONE",
+ *       UpdatedAt: "2026-06-16T17:57:36.083Z"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListExperimentRunsCommand extends ListExperimentRunsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListExperimentRunsRequest;
+            output: ExperimentRuns;
+        };
+        sdk: {
+            input: ListExperimentRunsCommandInput;
+            output: ListExperimentRunsCommandOutput;
+        };
+    };
+}

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

@@ -30,6 +30,10 @@ declare const StartDeploymentCommand_base: {
 };
 /**
  * <p>Starts a deployment.</p>
+ *          <note>
+ *             <p>AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-agent-how-to-use.html#appconfig-entity-based-gradual-deployments">Using AppConfig Agent for user-based or entity-based gradual deployments</a>
+ *             </p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,6 +56,7 @@ declare const StartDeploymentCommand_base: {
  *   DynamicExtensionParameters: { // DynamicParameterMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   LatestDeploymentNumber: Number("int"),
  * };
  * const command = new StartDeploymentCommand(input);
  * const response = await client.send(command);

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

@@ -0,0 +1,230 @@
+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, StartExperimentRunRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartExperimentRunCommand}.
+ */
+export interface StartExperimentRunCommandInput extends StartExperimentRunRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartExperimentRunCommand}.
+ */
+export interface StartExperimentRunCommandOutput extends ExperimentRun, __MetadataBearer {
+}
+declare const StartExperimentRunCommand_base: {
+    new (input: StartExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<StartExperimentRunCommandInput, StartExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartExperimentRunCommandInput): import("@smithy/core/client").CommandImpl<StartExperimentRunCommandInput, StartExperimentRunCommandOutput, AppConfigClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Starts an experiment run for the specified experiment definition. An experiment run delivers treatments to the target audience and collects metrics. You can start multiple experiment runs from the same experiment definition.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AppConfigClient, StartExperimentRunCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
+ * // const { AppConfigClient, StartExperimentRunCommand } = 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 = { // StartExperimentRunRequest
+ *   ApplicationIdentifier: "STRING_VALUE", // required
+ *   ExperimentDefinitionIdentifier: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   ExposurePercentage: Number("float"),
+ *   TreatmentOverrides: { // TreatmentOverrides Union: only one key present
+ *     Inline: { // TreatmentOverrideMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
+ *   Tags: { // TagMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   DeploymentParameters: { // DeploymentParameters
+ *     DynamicExtensionParameters: { // DynamicParameterMap
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *     Tags: {
+ *       "<keys>": "STRING_VALUE",
+ *     },
+ *   },
+ * };
+ * const command = new StartExperimentRunCommand(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 StartExperimentRunCommandInput - {@link StartExperimentRunCommandInput}
+ * @returns {@link StartExperimentRunCommandOutput}
+ * @see {@link StartExperimentRunCommandInput} for command's `input` shape.
+ * @see {@link StartExperimentRunCommandOutput} 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 start an experiment run
+ * ```javascript
+ * // The following StartExperimentRun example starts an experiment run with 50% audience exposure.
+ * const input = {
+ *   ApplicationIdentifier: "339ohji",
+ *   ExperimentDefinitionIdentifier: "bsxyd7k",
+ *   ExposurePercentage: 50.0
+ * };
+ * const command = new StartExperimentRunCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   ApplicationId: "339ohji",
+ *   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,
+ *   Run: 1,
+ *   StartedAt: "2026-06-16T17:57:10.046Z",
+ *   Status: "RUNNING",
+ *   UpdatedAt: "2026-06-16T17:57:10.567Z"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class StartExperimentRunCommand extends StartExperimentRunCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartExperimentRunRequest;
+            output: ExperimentRun;
+        };
+        sdk: {
+            input: StartExperimentRunCommandInput;
+            output: StartExperimentRunCommandOutput;
+        };
+    };
+}