@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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ActionPoint, DeletionProtectionCheck, DeploymentEventType, DeploymentState, EnvironmentState, GrowthType, ReplicateTo, TriggeredBy, ValidatorType } from "./enums";
|
|
1
|
+
import type { ActionPoint, DeleteType, DeletionProtectionCheck, DeploymentEventType, DeploymentState, DeploymentType, EnvironmentState, ExperimentDefinitionStatus, ExperimentRunEventType, ExperimentRunStatus, GrowthType, ReplicateTo, TriggeredBy, ValidatorType } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>A parameter to configure deletion protection. Deletion protection prevents a user from
|
|
4
4
|
* deleting a configuration profile or an environment if AppConfig has called either
|
|
@@ -26,6 +26,17 @@ export interface DeletionProtectionSettings {
|
|
|
26
26
|
*/
|
|
27
27
|
ProtectionPeriodInMinutes?: number | undefined;
|
|
28
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* <p>Configuration settings for vended metrics.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface VendedMetricsSettings {
|
|
34
|
+
/**
|
|
35
|
+
* <p>Whether vended metrics are enabled for the account.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
Enabled?: boolean | undefined;
|
|
39
|
+
}
|
|
29
40
|
/**
|
|
30
41
|
* @public
|
|
31
42
|
*/
|
|
@@ -39,6 +50,11 @@ export interface AccountSettings {
|
|
|
39
50
|
* @public
|
|
40
51
|
*/
|
|
41
52
|
DeletionProtection?: DeletionProtectionSettings | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>Configuration for vended metrics in the account.</p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
VendedMetrics?: VendedMetricsSettings | undefined;
|
|
42
58
|
}
|
|
43
59
|
/**
|
|
44
60
|
* <p>An action defines the tasks that the extension performs during the AppConfig
|
|
@@ -479,6 +495,10 @@ export interface CreateDeploymentStrategyRequest {
|
|
|
479
495
|
Description?: string | undefined;
|
|
480
496
|
/**
|
|
481
497
|
* <p>Total amount of time for a deployment to last.</p>
|
|
498
|
+
* <note>
|
|
499
|
+
* <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>
|
|
500
|
+
* </p>
|
|
501
|
+
* </note>
|
|
482
502
|
* @public
|
|
483
503
|
*/
|
|
484
504
|
DeploymentDurationInMinutes: number | undefined;
|
|
@@ -677,6 +697,313 @@ export interface Environment {
|
|
|
677
697
|
*/
|
|
678
698
|
Monitors?: Monitor[] | undefined;
|
|
679
699
|
}
|
|
700
|
+
/**
|
|
701
|
+
* <p>A value for a feature flag attribute. Only one of the members can be set.</p>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
export type AttributeValue = AttributeValue.BooleanValueMember | AttributeValue.NumberArrayMember | AttributeValue.NumberValueMember | AttributeValue.StringArrayMember | AttributeValue.StringValueMember | AttributeValue.$UnknownMember;
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
*/
|
|
708
|
+
export declare namespace AttributeValue {
|
|
709
|
+
/**
|
|
710
|
+
* <p>A string value for the attribute.</p>
|
|
711
|
+
* @public
|
|
712
|
+
*/
|
|
713
|
+
interface StringValueMember {
|
|
714
|
+
StringValue: string;
|
|
715
|
+
NumberValue?: never;
|
|
716
|
+
BooleanValue?: never;
|
|
717
|
+
StringArray?: never;
|
|
718
|
+
NumberArray?: never;
|
|
719
|
+
$unknown?: never;
|
|
720
|
+
}
|
|
721
|
+
/**
|
|
722
|
+
* <p>A numeric value for the attribute.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
interface NumberValueMember {
|
|
726
|
+
StringValue?: never;
|
|
727
|
+
NumberValue: number;
|
|
728
|
+
BooleanValue?: never;
|
|
729
|
+
StringArray?: never;
|
|
730
|
+
NumberArray?: never;
|
|
731
|
+
$unknown?: never;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* <p>A Boolean value for the attribute.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
interface BooleanValueMember {
|
|
738
|
+
StringValue?: never;
|
|
739
|
+
NumberValue?: never;
|
|
740
|
+
BooleanValue: boolean;
|
|
741
|
+
StringArray?: never;
|
|
742
|
+
NumberArray?: never;
|
|
743
|
+
$unknown?: never;
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* <p>An array of string values for the attribute.</p>
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
interface StringArrayMember {
|
|
750
|
+
StringValue?: never;
|
|
751
|
+
NumberValue?: never;
|
|
752
|
+
BooleanValue?: never;
|
|
753
|
+
StringArray: string[];
|
|
754
|
+
NumberArray?: never;
|
|
755
|
+
$unknown?: never;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* <p>An array of numeric values for the attribute.</p>
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
interface NumberArrayMember {
|
|
762
|
+
StringValue?: never;
|
|
763
|
+
NumberValue?: never;
|
|
764
|
+
BooleanValue?: never;
|
|
765
|
+
StringArray?: never;
|
|
766
|
+
NumberArray: number[];
|
|
767
|
+
$unknown?: never;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
interface $UnknownMember {
|
|
773
|
+
StringValue?: never;
|
|
774
|
+
NumberValue?: never;
|
|
775
|
+
BooleanValue?: never;
|
|
776
|
+
StringArray?: never;
|
|
777
|
+
NumberArray?: never;
|
|
778
|
+
$unknown: [string, any];
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* @deprecated unused in schema-serde mode.
|
|
782
|
+
*
|
|
783
|
+
*/
|
|
784
|
+
interface Visitor<T> {
|
|
785
|
+
StringValue: (value: string) => T;
|
|
786
|
+
NumberValue: (value: number) => T;
|
|
787
|
+
BooleanValue: (value: boolean) => T;
|
|
788
|
+
StringArray: (value: string[]) => T;
|
|
789
|
+
NumberArray: (value: number[]) => T;
|
|
790
|
+
_: (name: string, value: any) => T;
|
|
791
|
+
}
|
|
792
|
+
}
|
|
793
|
+
/**
|
|
794
|
+
* <p>The feature flag value configuration for a treatment, including the enabled state and attribute values.</p>
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
export interface FlagValue {
|
|
798
|
+
/**
|
|
799
|
+
* <p>Whether the feature flag is enabled for this treatment.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
Enabled: boolean | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* <p>The attribute values associated with this flag value.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
AttributeValues?: Record<string, AttributeValue> | undefined;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* <p>Input structure for defining a treatment when creating or updating an experiment definition.</p>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
export interface TreatmentInput {
|
|
814
|
+
/**
|
|
815
|
+
* <p>The traffic allocation weight for this treatment.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
Weight: number | undefined;
|
|
819
|
+
/**
|
|
820
|
+
* <p>A description of the treatment.</p>
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
Description?: string | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* <p>The feature flag value to serve to users assigned to this treatment.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
FlagValue: FlagValue | undefined;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
export interface CreateExperimentDefinitionRequest {
|
|
834
|
+
/**
|
|
835
|
+
* <p>The application ID or name.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
ApplicationIdentifier: string | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* <p>A name for the experiment definition.</p>
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
Name: string | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* <p>The configuration profile ID or name that stores the feature flag.</p>
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
ConfigurationProfileIdentifier: string | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>The environment ID or name where the experiment will run.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
EnvironmentIdentifier: string | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* <p>The key of the existing feature flag to use with the experiment.</p>
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
FlagKey: string | undefined;
|
|
859
|
+
/**
|
|
860
|
+
* <p>A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.</p>
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
Treatments: TreatmentInput[] | undefined;
|
|
864
|
+
/**
|
|
865
|
+
* <p>The control treatment that represents the baseline experience for comparison.</p>
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
Control: TreatmentInput | undefined;
|
|
869
|
+
/**
|
|
870
|
+
* <p>A rule that defines which users are eligible to be assigned to treatments during the experiment.</p>
|
|
871
|
+
* @public
|
|
872
|
+
*/
|
|
873
|
+
AudienceRule: string | undefined;
|
|
874
|
+
/**
|
|
875
|
+
* <p>A description of the goal or hypothesis the experiment is designed to validate.</p>
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
Hypothesis?: string | undefined;
|
|
879
|
+
/**
|
|
880
|
+
* <p>A description of the intended audience for the experiment.</p>
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
AudienceDescription?: string | undefined;
|
|
884
|
+
/**
|
|
885
|
+
* <p>Information about the conditions under which you would launch the winning treatment.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
LaunchCriteria?: string | undefined;
|
|
889
|
+
/**
|
|
890
|
+
* <p>The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
Tags?: Record<string, string> | undefined;
|
|
894
|
+
}
|
|
895
|
+
/**
|
|
896
|
+
* <p>Describes a treatment in an experiment, including its traffic allocation weight and feature flag value.</p>
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
export interface Treatment {
|
|
900
|
+
/**
|
|
901
|
+
* <p>The unique key that identifies this treatment.</p>
|
|
902
|
+
* @public
|
|
903
|
+
*/
|
|
904
|
+
Key?: string | undefined;
|
|
905
|
+
/**
|
|
906
|
+
* <p>The traffic allocation weight for this treatment.</p>
|
|
907
|
+
* @public
|
|
908
|
+
*/
|
|
909
|
+
Weight: number | undefined;
|
|
910
|
+
/**
|
|
911
|
+
* <p>A description of the treatment.</p>
|
|
912
|
+
* @public
|
|
913
|
+
*/
|
|
914
|
+
Description?: string | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* <p>The feature flag value served to users assigned to this treatment.</p>
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
FlagValue: FlagValue | undefined;
|
|
920
|
+
}
|
|
921
|
+
/**
|
|
922
|
+
* <p>Describes an experiment definition, including the target audience, feature flag, treatments, and current status.</p>
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
export interface ExperimentDefinition {
|
|
926
|
+
/**
|
|
927
|
+
* <p>The application ID.</p>
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
930
|
+
ApplicationId?: string | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The experiment definition ID.</p>
|
|
933
|
+
* @public
|
|
934
|
+
*/
|
|
935
|
+
Id?: string | undefined;
|
|
936
|
+
/**
|
|
937
|
+
* <p>The name of the experiment definition.</p>
|
|
938
|
+
* @public
|
|
939
|
+
*/
|
|
940
|
+
Name?: string | undefined;
|
|
941
|
+
/**
|
|
942
|
+
* <p>The hypothesis that the experiment is designed to validate.</p>
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
Hypothesis?: string | undefined;
|
|
946
|
+
/**
|
|
947
|
+
* <p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>
|
|
948
|
+
* @public
|
|
949
|
+
*/
|
|
950
|
+
Status?: ExperimentDefinitionStatus | undefined;
|
|
951
|
+
/**
|
|
952
|
+
* <p>The configuration profile ID associated with the experiment.</p>
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
ConfigurationProfileId?: string | undefined;
|
|
956
|
+
/**
|
|
957
|
+
* <p>The environment ID where the experiment runs.</p>
|
|
958
|
+
* @public
|
|
959
|
+
*/
|
|
960
|
+
EnvironmentId?: string | undefined;
|
|
961
|
+
/**
|
|
962
|
+
* <p>The key of the feature flag used by the experiment.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
FlagKey?: string | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The rule that defines which users are eligible to be assigned to treatments.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
AudienceRule?: string | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p>A description of the intended audience for the experiment.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
AudienceDescription?: string | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The conditions under which the winning treatment should be launched.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
LaunchCriteria?: string | undefined;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The list of treatments defined for the experiment.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
Treatments?: Treatment[] | undefined;
|
|
986
|
+
/**
|
|
987
|
+
* <p>The control treatment used as the baseline for comparison.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
Control?: Treatment | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
CreatedAt?: Date | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
UpdatedAt?: Date | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
KmsKeyIdentifier?: string | undefined;
|
|
1006
|
+
}
|
|
680
1007
|
/**
|
|
681
1008
|
* <p>A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered
|
|
682
1009
|
* in an extension when invoked. Parameter values are specified in an extension association.
|
|
@@ -876,6 +1203,9 @@ export interface CreateHostedConfigurationVersionRequest {
|
|
|
876
1203
|
ConfigurationProfileId: string | undefined;
|
|
877
1204
|
/**
|
|
878
1205
|
* <p>A description of the configuration.</p>
|
|
1206
|
+
* <note>
|
|
1207
|
+
* <p>Due to HTTP limitations, this field only supports ASCII characters.</p>
|
|
1208
|
+
* </note>
|
|
879
1209
|
* @public
|
|
880
1210
|
*/
|
|
881
1211
|
Description?: string | undefined;
|
|
@@ -1064,6 +1394,26 @@ export interface DeleteEnvironmentRequest {
|
|
|
1064
1394
|
*/
|
|
1065
1395
|
DeletionProtectionCheck?: DeletionProtectionCheck | undefined;
|
|
1066
1396
|
}
|
|
1397
|
+
/**
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
export interface DeleteExperimentDefinitionRequest {
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>The application ID or name.</p>
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
ApplicationIdentifier: string | undefined;
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>The experiment definition ID or name.</p>
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
1411
|
+
/**
|
|
1412
|
+
* <p>The type of deletion to perform. Valid values include archive (hide but preserve) and permanent (delete permanently).</p>
|
|
1413
|
+
* @public
|
|
1414
|
+
*/
|
|
1415
|
+
DeleteType?: DeleteType | undefined;
|
|
1416
|
+
}
|
|
1067
1417
|
/**
|
|
1068
1418
|
* @public
|
|
1069
1419
|
*/
|
|
@@ -1461,71 +1811,292 @@ export interface GetEnvironmentRequest {
|
|
|
1461
1811
|
/**
|
|
1462
1812
|
* @public
|
|
1463
1813
|
*/
|
|
1464
|
-
export interface
|
|
1814
|
+
export interface GetExperimentDefinitionRequest {
|
|
1465
1815
|
/**
|
|
1466
|
-
* <p>The
|
|
1816
|
+
* <p>The application ID or name.</p>
|
|
1467
1817
|
* @public
|
|
1468
1818
|
*/
|
|
1469
|
-
|
|
1819
|
+
ApplicationIdentifier: string | undefined;
|
|
1470
1820
|
/**
|
|
1471
|
-
* <p>The
|
|
1472
|
-
* the highest version.</p>
|
|
1821
|
+
* <p>The experiment definition ID or name.</p>
|
|
1473
1822
|
* @public
|
|
1474
1823
|
*/
|
|
1475
|
-
|
|
1824
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
1476
1825
|
}
|
|
1477
1826
|
/**
|
|
1827
|
+
* <p>A snapshot of the experiment definition captured at the time an experiment run was started. This preserves the configuration that was active during the run.</p>
|
|
1478
1828
|
* @public
|
|
1479
1829
|
*/
|
|
1480
|
-
export interface
|
|
1830
|
+
export interface ExperimentDefinitionSnapshot {
|
|
1481
1831
|
/**
|
|
1482
|
-
* <p>The
|
|
1832
|
+
* <p>The application ID at the time the run was started.</p>
|
|
1483
1833
|
* @public
|
|
1484
1834
|
*/
|
|
1485
|
-
|
|
1486
|
-
}
|
|
1487
|
-
/**
|
|
1488
|
-
* @public
|
|
1489
|
-
*/
|
|
1490
|
-
export interface GetHostedConfigurationVersionRequest {
|
|
1835
|
+
ApplicationId?: string | undefined;
|
|
1491
1836
|
/**
|
|
1492
|
-
* <p>The
|
|
1837
|
+
* <p>The experiment definition ID.</p>
|
|
1493
1838
|
* @public
|
|
1494
1839
|
*/
|
|
1495
|
-
|
|
1840
|
+
Id?: string | undefined;
|
|
1496
1841
|
/**
|
|
1497
|
-
* <p>The
|
|
1842
|
+
* <p>The name of the experiment definition at the time the run was started.</p>
|
|
1498
1843
|
* @public
|
|
1499
1844
|
*/
|
|
1500
|
-
|
|
1845
|
+
Name?: string | undefined;
|
|
1501
1846
|
/**
|
|
1502
|
-
* <p>The
|
|
1847
|
+
* <p>The hypothesis at the time the run was started.</p>
|
|
1503
1848
|
* @public
|
|
1504
1849
|
*/
|
|
1505
|
-
|
|
1506
|
-
}
|
|
1507
|
-
/**
|
|
1508
|
-
* @public
|
|
1509
|
-
*/
|
|
1510
|
-
export interface Applications {
|
|
1850
|
+
Hypothesis?: string | undefined;
|
|
1511
1851
|
/**
|
|
1512
|
-
* <p>The
|
|
1852
|
+
* <p>The configuration profile ID at the time the run was started.</p>
|
|
1513
1853
|
* @public
|
|
1514
1854
|
*/
|
|
1515
|
-
|
|
1855
|
+
ConfigurationProfileId?: string | undefined;
|
|
1516
1856
|
/**
|
|
1517
|
-
* <p>The
|
|
1518
|
-
* results.</p>
|
|
1857
|
+
* <p>The environment ID at the time the run was started.</p>
|
|
1519
1858
|
* @public
|
|
1520
1859
|
*/
|
|
1521
|
-
|
|
1522
|
-
}
|
|
1523
|
-
/**
|
|
1524
|
-
* @public
|
|
1525
|
-
*/
|
|
1526
|
-
export interface ListApplicationsRequest {
|
|
1860
|
+
EnvironmentId?: string | undefined;
|
|
1527
1861
|
/**
|
|
1528
|
-
* <p>The
|
|
1862
|
+
* <p>The feature flag key at the time the run was started.</p>
|
|
1863
|
+
* @public
|
|
1864
|
+
*/
|
|
1865
|
+
FlagKey?: string | undefined;
|
|
1866
|
+
/**
|
|
1867
|
+
* <p>The audience rule at the time the run was started.</p>
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
AudienceRule?: string | undefined;
|
|
1871
|
+
/**
|
|
1872
|
+
* <p>The audience description at the time the run was started.</p>
|
|
1873
|
+
* @public
|
|
1874
|
+
*/
|
|
1875
|
+
AudienceDescription?: string | undefined;
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>The launch criteria at the time the run was started.</p>
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
LaunchCriteria?: string | undefined;
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>The treatments at the time the run was started.</p>
|
|
1883
|
+
* @public
|
|
1884
|
+
*/
|
|
1885
|
+
Treatments?: Treatment[] | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* <p>The control treatment at the time the run was started.</p>
|
|
1888
|
+
* @public
|
|
1889
|
+
*/
|
|
1890
|
+
Control?: Treatment | undefined;
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>The result of an experiment run, including the executive summary and launch decision rationale.</p>
|
|
1894
|
+
* @public
|
|
1895
|
+
*/
|
|
1896
|
+
export interface ExperimentRunResult {
|
|
1897
|
+
/**
|
|
1898
|
+
* <p>A summary of the experiment outcome and key findings.</p>
|
|
1899
|
+
* @public
|
|
1900
|
+
*/
|
|
1901
|
+
ExecutiveSummary?: string | undefined;
|
|
1902
|
+
/**
|
|
1903
|
+
* <p>Evidence in favor of launching the winning treatment.</p>
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1906
|
+
ReasonsToLaunch?: string | undefined;
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>Evidence against launching the treatment.</p>
|
|
1909
|
+
* @public
|
|
1910
|
+
*/
|
|
1911
|
+
ReasonsNotToLaunch?: string | undefined;
|
|
1912
|
+
}
|
|
1913
|
+
/**
|
|
1914
|
+
* <p>Treatment assignment overrides that assign specific entity IDs to treatments, bypassing random assignment.</p>
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
export type TreatmentOverrides = TreatmentOverrides.InlineMember | TreatmentOverrides.$UnknownMember;
|
|
1918
|
+
/**
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
export declare namespace TreatmentOverrides {
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
interface InlineMember {
|
|
1927
|
+
Inline: Record<string, string>;
|
|
1928
|
+
$unknown?: never;
|
|
1929
|
+
}
|
|
1930
|
+
/**
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
interface $UnknownMember {
|
|
1934
|
+
Inline?: never;
|
|
1935
|
+
$unknown: [string, any];
|
|
1936
|
+
}
|
|
1937
|
+
/**
|
|
1938
|
+
* @deprecated unused in schema-serde mode.
|
|
1939
|
+
*
|
|
1940
|
+
*/
|
|
1941
|
+
interface Visitor<T> {
|
|
1942
|
+
Inline: (value: Record<string, string>) => T;
|
|
1943
|
+
_: (name: string, value: any) => T;
|
|
1944
|
+
}
|
|
1945
|
+
}
|
|
1946
|
+
/**
|
|
1947
|
+
* <p>Describes an experiment run, including its status, exposure settings, and treatment overrides.</p>
|
|
1948
|
+
* @public
|
|
1949
|
+
*/
|
|
1950
|
+
export interface ExperimentRun {
|
|
1951
|
+
/**
|
|
1952
|
+
* <p>The application ID.</p>
|
|
1953
|
+
* @public
|
|
1954
|
+
*/
|
|
1955
|
+
ApplicationId?: string | undefined;
|
|
1956
|
+
/**
|
|
1957
|
+
* <p>The experiment definition ID.</p>
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
ExperimentDefinitionId?: string | undefined;
|
|
1961
|
+
/**
|
|
1962
|
+
* <p>The experiment run number.</p>
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
Run?: number | undefined;
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>A description of the experiment run.</p>
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
Description?: string | undefined;
|
|
1971
|
+
/**
|
|
1972
|
+
* <p>The current status of the experiment run. Valid values: <code>RUNNING</code>, <code>DONE</code>.</p>
|
|
1973
|
+
* @public
|
|
1974
|
+
*/
|
|
1975
|
+
Status?: ExperimentRunStatus | undefined;
|
|
1976
|
+
/**
|
|
1977
|
+
* <p>The percentage of the target audience exposed to treatments.</p>
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
ExposurePercentage?: number | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* <p>Treatment assignment overrides that assign specific entity IDs to treatments.</p>
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
TreatmentOverrides?: TreatmentOverrides | undefined;
|
|
1986
|
+
/**
|
|
1987
|
+
* <p>The result of the experiment run, including the executive summary and launch decision rationale.</p>
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
Result?: ExperimentRunResult | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* <p>The date and time the experiment run started, in ISO 8601 format.</p>
|
|
1993
|
+
* @public
|
|
1994
|
+
*/
|
|
1995
|
+
StartedAt?: Date | undefined;
|
|
1996
|
+
/**
|
|
1997
|
+
* <p>The date and time the experiment run was last updated, in ISO 8601 format.</p>
|
|
1998
|
+
* @public
|
|
1999
|
+
*/
|
|
2000
|
+
UpdatedAt?: Date | undefined;
|
|
2001
|
+
/**
|
|
2002
|
+
* <p>The date and time the experiment run ended, in ISO 8601 format.</p>
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
2005
|
+
EndedAt?: Date | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>A snapshot of the experiment definition at the time the run was started.</p>
|
|
2008
|
+
* @public
|
|
2009
|
+
*/
|
|
2010
|
+
ExperimentDefinitionSnapshot?: ExperimentDefinitionSnapshot | undefined;
|
|
2011
|
+
}
|
|
2012
|
+
/**
|
|
2013
|
+
* @public
|
|
2014
|
+
*/
|
|
2015
|
+
export interface GetExperimentRunRequest {
|
|
2016
|
+
/**
|
|
2017
|
+
* <p>The application ID or name.</p>
|
|
2018
|
+
* @public
|
|
2019
|
+
*/
|
|
2020
|
+
ApplicationIdentifier: string | undefined;
|
|
2021
|
+
/**
|
|
2022
|
+
* <p>The experiment definition ID or name.</p>
|
|
2023
|
+
* @public
|
|
2024
|
+
*/
|
|
2025
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
2026
|
+
/**
|
|
2027
|
+
* <p>The run number to retrieve.</p>
|
|
2028
|
+
* @public
|
|
2029
|
+
*/
|
|
2030
|
+
Run: number | undefined;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* @public
|
|
2034
|
+
*/
|
|
2035
|
+
export interface GetExtensionRequest {
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
ExtensionIdentifier: string | undefined;
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>The extension version number. If no version number was defined, AppConfig uses
|
|
2043
|
+
* the highest version.</p>
|
|
2044
|
+
* @public
|
|
2045
|
+
*/
|
|
2046
|
+
VersionNumber?: number | undefined;
|
|
2047
|
+
}
|
|
2048
|
+
/**
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
export interface GetExtensionAssociationRequest {
|
|
2052
|
+
/**
|
|
2053
|
+
* <p>The extension association ID to get.</p>
|
|
2054
|
+
* @public
|
|
2055
|
+
*/
|
|
2056
|
+
ExtensionAssociationId: string | undefined;
|
|
2057
|
+
}
|
|
2058
|
+
/**
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
export interface GetHostedConfigurationVersionRequest {
|
|
2062
|
+
/**
|
|
2063
|
+
* <p>The application ID.</p>
|
|
2064
|
+
* @public
|
|
2065
|
+
*/
|
|
2066
|
+
ApplicationId: string | undefined;
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>The configuration profile ID.</p>
|
|
2069
|
+
* @public
|
|
2070
|
+
*/
|
|
2071
|
+
ConfigurationProfileId: string | undefined;
|
|
2072
|
+
/**
|
|
2073
|
+
* <p>The version.</p>
|
|
2074
|
+
* @public
|
|
2075
|
+
*/
|
|
2076
|
+
VersionNumber: number | undefined;
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
export interface Applications {
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>The elements from this collection.</p>
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
2086
|
+
Items?: Application[] | undefined;
|
|
2087
|
+
/**
|
|
2088
|
+
* <p>The token for the next set of items to return. Use this token to get the next set of
|
|
2089
|
+
* results.</p>
|
|
2090
|
+
* @public
|
|
2091
|
+
*/
|
|
2092
|
+
NextToken?: string | undefined;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* @public
|
|
2096
|
+
*/
|
|
2097
|
+
export interface ListApplicationsRequest {
|
|
2098
|
+
/**
|
|
2099
|
+
* <p>The maximum number of items to return for this call. The call also returns a token that
|
|
1529
2100
|
* you can specify in a subsequent call to get the next set of results.</p>
|
|
1530
2101
|
* @public
|
|
1531
2102
|
*/
|
|
@@ -1638,6 +2209,11 @@ export interface DeploymentSummary {
|
|
|
1638
2209
|
* @public
|
|
1639
2210
|
*/
|
|
1640
2211
|
DeploymentNumber?: number | undefined;
|
|
2212
|
+
/**
|
|
2213
|
+
* <p>The ID of the configuration profile that was deployed.</p>
|
|
2214
|
+
* @public
|
|
2215
|
+
*/
|
|
2216
|
+
ConfigurationProfileId?: string | undefined;
|
|
1641
2217
|
/**
|
|
1642
2218
|
* <p>The name of the configuration.</p>
|
|
1643
2219
|
* @public
|
|
@@ -1695,6 +2271,11 @@ export interface DeploymentSummary {
|
|
|
1695
2271
|
* @public
|
|
1696
2272
|
*/
|
|
1697
2273
|
VersionLabel?: string | undefined;
|
|
2274
|
+
/**
|
|
2275
|
+
* <p>The type of deployment.</p>
|
|
2276
|
+
* @public
|
|
2277
|
+
*/
|
|
2278
|
+
Type?: DeploymentType | undefined;
|
|
1698
2279
|
}
|
|
1699
2280
|
/**
|
|
1700
2281
|
* @public
|
|
@@ -1810,6 +2391,287 @@ export interface ListEnvironmentsRequest {
|
|
|
1810
2391
|
*/
|
|
1811
2392
|
NextToken?: string | undefined;
|
|
1812
2393
|
}
|
|
2394
|
+
/**
|
|
2395
|
+
* <p>Summary information about an experiment definition.</p>
|
|
2396
|
+
* @public
|
|
2397
|
+
*/
|
|
2398
|
+
export interface ExperimentDefinitionSummary {
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>The application ID.</p>
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2403
|
+
ApplicationId?: string | undefined;
|
|
2404
|
+
/**
|
|
2405
|
+
* <p>The experiment definition ID.</p>
|
|
2406
|
+
* @public
|
|
2407
|
+
*/
|
|
2408
|
+
Id?: string | undefined;
|
|
2409
|
+
/**
|
|
2410
|
+
* <p>The name of the experiment definition.</p>
|
|
2411
|
+
* @public
|
|
2412
|
+
*/
|
|
2413
|
+
Name?: string | undefined;
|
|
2414
|
+
/**
|
|
2415
|
+
* <p>The hypothesis that the experiment is designed to validate.</p>
|
|
2416
|
+
* @public
|
|
2417
|
+
*/
|
|
2418
|
+
Hypothesis?: string | undefined;
|
|
2419
|
+
/**
|
|
2420
|
+
* <p>The current status of the experiment definition.</p>
|
|
2421
|
+
* @public
|
|
2422
|
+
*/
|
|
2423
|
+
Status?: ExperimentDefinitionStatus | undefined;
|
|
2424
|
+
/**
|
|
2425
|
+
* <p>The configuration profile ID associated with the experiment.</p>
|
|
2426
|
+
* @public
|
|
2427
|
+
*/
|
|
2428
|
+
ConfigurationProfileId?: string | undefined;
|
|
2429
|
+
/**
|
|
2430
|
+
* <p>The environment ID where the experiment runs.</p>
|
|
2431
|
+
* @public
|
|
2432
|
+
*/
|
|
2433
|
+
EnvironmentId?: string | undefined;
|
|
2434
|
+
/**
|
|
2435
|
+
* <p>The key of the feature flag used by the experiment.</p>
|
|
2436
|
+
* @public
|
|
2437
|
+
*/
|
|
2438
|
+
FlagKey?: string | undefined;
|
|
2439
|
+
/**
|
|
2440
|
+
* <p>The date and time the experiment definition was created, in ISO 8601 format.</p>
|
|
2441
|
+
* @public
|
|
2442
|
+
*/
|
|
2443
|
+
CreatedAt?: Date | undefined;
|
|
2444
|
+
/**
|
|
2445
|
+
* <p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>
|
|
2446
|
+
* @public
|
|
2447
|
+
*/
|
|
2448
|
+
UpdatedAt?: Date | undefined;
|
|
2449
|
+
}
|
|
2450
|
+
/**
|
|
2451
|
+
* <p>The response for a list experiment definitions request.</p>
|
|
2452
|
+
* @public
|
|
2453
|
+
*/
|
|
2454
|
+
export interface ExperimentDefinitions {
|
|
2455
|
+
/**
|
|
2456
|
+
* <p>The list of experiment definitions.</p>
|
|
2457
|
+
* @public
|
|
2458
|
+
*/
|
|
2459
|
+
Items?: ExperimentDefinitionSummary[] | undefined;
|
|
2460
|
+
/**
|
|
2461
|
+
* <p>A token to use for the next set of results.</p>
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2464
|
+
NextToken?: string | undefined;
|
|
2465
|
+
}
|
|
2466
|
+
/**
|
|
2467
|
+
* @public
|
|
2468
|
+
*/
|
|
2469
|
+
export interface ListExperimentDefinitionsRequest {
|
|
2470
|
+
/**
|
|
2471
|
+
* <p>The application ID or name to filter results.</p>
|
|
2472
|
+
* @public
|
|
2473
|
+
*/
|
|
2474
|
+
ApplicationIdentifier?: string | undefined;
|
|
2475
|
+
/**
|
|
2476
|
+
* <p>The configuration profile ID or name to filter results.</p>
|
|
2477
|
+
* @public
|
|
2478
|
+
*/
|
|
2479
|
+
ConfigurationProfileIdentifier?: string | undefined;
|
|
2480
|
+
/**
|
|
2481
|
+
* <p>The environment ID or name to filter results.</p>
|
|
2482
|
+
* @public
|
|
2483
|
+
*/
|
|
2484
|
+
EnvironmentIdentifier?: string | undefined;
|
|
2485
|
+
/**
|
|
2486
|
+
* <p>A filter for the experiment definition status.</p>
|
|
2487
|
+
* @public
|
|
2488
|
+
*/
|
|
2489
|
+
Status?: ExperimentDefinitionStatus | undefined;
|
|
2490
|
+
/**
|
|
2491
|
+
* <p>The maximum number of items to return for this call.</p>
|
|
2492
|
+
* @public
|
|
2493
|
+
*/
|
|
2494
|
+
MaxResults?: number | undefined;
|
|
2495
|
+
/**
|
|
2496
|
+
* <p>A token to start the list from a previously truncated response.</p>
|
|
2497
|
+
* @public
|
|
2498
|
+
*/
|
|
2499
|
+
NextToken?: string | undefined;
|
|
2500
|
+
}
|
|
2501
|
+
/**
|
|
2502
|
+
* <p>Describes an event that occurred during an experiment run.</p>
|
|
2503
|
+
* @public
|
|
2504
|
+
*/
|
|
2505
|
+
export interface ExperimentRunEvent {
|
|
2506
|
+
/**
|
|
2507
|
+
* <p>A description of the event.</p>
|
|
2508
|
+
* @public
|
|
2509
|
+
*/
|
|
2510
|
+
Description?: string | undefined;
|
|
2511
|
+
/**
|
|
2512
|
+
* <p>The Amazon Resource Name (ARN) of the deployment associated with this event.</p>
|
|
2513
|
+
* @public
|
|
2514
|
+
*/
|
|
2515
|
+
AssociatedDeployment?: string | undefined;
|
|
2516
|
+
/**
|
|
2517
|
+
* <p>The type of event. Valid values: <code>RUN_STARTED</code>, <code>EXPOSURE_UPDATED</code>, <code>OVERRIDES_UPDATED</code>, <code>RUN_STOPPED</code>.</p>
|
|
2518
|
+
* @public
|
|
2519
|
+
*/
|
|
2520
|
+
EventType?: ExperimentRunEventType | undefined;
|
|
2521
|
+
/**
|
|
2522
|
+
* <p>The date and time the event occurred, in ISO 8601 format.</p>
|
|
2523
|
+
* @public
|
|
2524
|
+
*/
|
|
2525
|
+
OccurredAt?: Date | undefined;
|
|
2526
|
+
/**
|
|
2527
|
+
* <p>The principal that triggered the event.</p>
|
|
2528
|
+
* @public
|
|
2529
|
+
*/
|
|
2530
|
+
TriggeredBy?: TriggeredBy | undefined;
|
|
2531
|
+
/**
|
|
2532
|
+
* <p>The exposure percentage at the time of the event.</p>
|
|
2533
|
+
* @public
|
|
2534
|
+
*/
|
|
2535
|
+
ExposurePercentage?: number | undefined;
|
|
2536
|
+
/**
|
|
2537
|
+
* <p>The treatment overrides at the time of the event.</p>
|
|
2538
|
+
* @public
|
|
2539
|
+
*/
|
|
2540
|
+
TreatmentOverrides?: TreatmentOverrides | undefined;
|
|
2541
|
+
}
|
|
2542
|
+
/**
|
|
2543
|
+
* <p>The response for a list experiment run events request.</p>
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
export interface ExperimentRunEvents {
|
|
2547
|
+
/**
|
|
2548
|
+
* <p>The list of experiment run events.</p>
|
|
2549
|
+
* @public
|
|
2550
|
+
*/
|
|
2551
|
+
Items?: ExperimentRunEvent[] | undefined;
|
|
2552
|
+
/**
|
|
2553
|
+
* <p>A token to use for the next set of results.</p>
|
|
2554
|
+
* @public
|
|
2555
|
+
*/
|
|
2556
|
+
NextToken?: string | undefined;
|
|
2557
|
+
}
|
|
2558
|
+
/**
|
|
2559
|
+
* @public
|
|
2560
|
+
*/
|
|
2561
|
+
export interface ListExperimentRunEventsRequest {
|
|
2562
|
+
/**
|
|
2563
|
+
* <p>The application ID or name.</p>
|
|
2564
|
+
* @public
|
|
2565
|
+
*/
|
|
2566
|
+
ApplicationIdentifier: string | undefined;
|
|
2567
|
+
/**
|
|
2568
|
+
* <p>The experiment definition ID or name.</p>
|
|
2569
|
+
* @public
|
|
2570
|
+
*/
|
|
2571
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
2572
|
+
/**
|
|
2573
|
+
* <p>The run number.</p>
|
|
2574
|
+
* @public
|
|
2575
|
+
*/
|
|
2576
|
+
Run: number | undefined;
|
|
2577
|
+
/**
|
|
2578
|
+
* <p>The maximum number of items to return.</p>
|
|
2579
|
+
* @public
|
|
2580
|
+
*/
|
|
2581
|
+
MaxResults?: number | undefined;
|
|
2582
|
+
/**
|
|
2583
|
+
* <p>A token to start the list from a previously truncated response.</p>
|
|
2584
|
+
* @public
|
|
2585
|
+
*/
|
|
2586
|
+
NextToken?: string | undefined;
|
|
2587
|
+
}
|
|
2588
|
+
/**
|
|
2589
|
+
* <p>Summary information about an experiment run.</p>
|
|
2590
|
+
* @public
|
|
2591
|
+
*/
|
|
2592
|
+
export interface ExperimentRunSummary {
|
|
2593
|
+
/**
|
|
2594
|
+
* <p>The experiment definition ID.</p>
|
|
2595
|
+
* @public
|
|
2596
|
+
*/
|
|
2597
|
+
ExperimentDefinitionId?: string | undefined;
|
|
2598
|
+
/**
|
|
2599
|
+
* <p>The experiment run number.</p>
|
|
2600
|
+
* @public
|
|
2601
|
+
*/
|
|
2602
|
+
Run?: number | undefined;
|
|
2603
|
+
/**
|
|
2604
|
+
* <p>A description of the experiment run.</p>
|
|
2605
|
+
* @public
|
|
2606
|
+
*/
|
|
2607
|
+
Description?: string | undefined;
|
|
2608
|
+
/**
|
|
2609
|
+
* <p>The current status of the experiment run.</p>
|
|
2610
|
+
* @public
|
|
2611
|
+
*/
|
|
2612
|
+
Status?: ExperimentRunStatus | undefined;
|
|
2613
|
+
/**
|
|
2614
|
+
* <p>The date and time the experiment run started, in ISO 8601 format.</p>
|
|
2615
|
+
* @public
|
|
2616
|
+
*/
|
|
2617
|
+
StartedAt?: Date | undefined;
|
|
2618
|
+
/**
|
|
2619
|
+
* <p>The date and time the experiment run was last updated, in ISO 8601 format.</p>
|
|
2620
|
+
* @public
|
|
2621
|
+
*/
|
|
2622
|
+
UpdatedAt?: Date | undefined;
|
|
2623
|
+
/**
|
|
2624
|
+
* <p>The date and time the experiment run ended, in ISO 8601 format.</p>
|
|
2625
|
+
* @public
|
|
2626
|
+
*/
|
|
2627
|
+
EndedAt?: Date | undefined;
|
|
2628
|
+
}
|
|
2629
|
+
/**
|
|
2630
|
+
* <p>The response for a list experiment runs request.</p>
|
|
2631
|
+
* @public
|
|
2632
|
+
*/
|
|
2633
|
+
export interface ExperimentRuns {
|
|
2634
|
+
/**
|
|
2635
|
+
* <p>The list of experiment runs.</p>
|
|
2636
|
+
* @public
|
|
2637
|
+
*/
|
|
2638
|
+
Items?: ExperimentRunSummary[] | undefined;
|
|
2639
|
+
/**
|
|
2640
|
+
* <p>A token to use for the next set of results.</p>
|
|
2641
|
+
* @public
|
|
2642
|
+
*/
|
|
2643
|
+
NextToken?: string | undefined;
|
|
2644
|
+
}
|
|
2645
|
+
/**
|
|
2646
|
+
* @public
|
|
2647
|
+
*/
|
|
2648
|
+
export interface ListExperimentRunsRequest {
|
|
2649
|
+
/**
|
|
2650
|
+
* <p>The application ID or name.</p>
|
|
2651
|
+
* @public
|
|
2652
|
+
*/
|
|
2653
|
+
ApplicationIdentifier: string | undefined;
|
|
2654
|
+
/**
|
|
2655
|
+
* <p>The experiment definition ID or name.</p>
|
|
2656
|
+
* @public
|
|
2657
|
+
*/
|
|
2658
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
2659
|
+
/**
|
|
2660
|
+
* <p>The maximum number of items to return.</p>
|
|
2661
|
+
* @public
|
|
2662
|
+
*/
|
|
2663
|
+
MaxResults?: number | undefined;
|
|
2664
|
+
/**
|
|
2665
|
+
* <p>A token to start the list from a previously truncated response.</p>
|
|
2666
|
+
* @public
|
|
2667
|
+
*/
|
|
2668
|
+
NextToken?: string | undefined;
|
|
2669
|
+
/**
|
|
2670
|
+
* <p>A filter for the experiment run status.</p>
|
|
2671
|
+
* @public
|
|
2672
|
+
*/
|
|
2673
|
+
Status?: ExperimentRunStatus | undefined;
|
|
2674
|
+
}
|
|
1813
2675
|
/**
|
|
1814
2676
|
* <p>Information about an association between an extension and an AppConfig
|
|
1815
2677
|
* resource such as an application, environment, or configuration profile. Call
|
|
@@ -2125,6 +2987,67 @@ export interface StartDeploymentRequest {
|
|
|
2125
2987
|
* @public
|
|
2126
2988
|
*/
|
|
2127
2989
|
DynamicExtensionParameters?: Record<string, string> | undefined;
|
|
2990
|
+
/**
|
|
2991
|
+
* <p>The number of the latest deployment. Use this value to ensure that the deployment starts from the expected state and to prevent conflicting updates.</p>
|
|
2992
|
+
* @public
|
|
2993
|
+
*/
|
|
2994
|
+
LatestDeploymentNumber?: number | undefined;
|
|
2995
|
+
}
|
|
2996
|
+
/**
|
|
2997
|
+
* <p>Optional deployment parameters for an experiment run, including extension parameters and tags.</p>
|
|
2998
|
+
* @public
|
|
2999
|
+
*/
|
|
3000
|
+
export interface DeploymentParameters {
|
|
3001
|
+
/**
|
|
3002
|
+
* <p>A map of extension parameters for the deployment.</p>
|
|
3003
|
+
* @public
|
|
3004
|
+
*/
|
|
3005
|
+
DynamicExtensionParameters?: Record<string, string> | undefined;
|
|
3006
|
+
/**
|
|
3007
|
+
* <p>The tags to assign to the deployment.</p>
|
|
3008
|
+
* @public
|
|
3009
|
+
*/
|
|
3010
|
+
Tags?: Record<string, string> | undefined;
|
|
3011
|
+
}
|
|
3012
|
+
/**
|
|
3013
|
+
* @public
|
|
3014
|
+
*/
|
|
3015
|
+
export interface StartExperimentRunRequest {
|
|
3016
|
+
/**
|
|
3017
|
+
* <p>The application ID or name.</p>
|
|
3018
|
+
* @public
|
|
3019
|
+
*/
|
|
3020
|
+
ApplicationIdentifier: string | undefined;
|
|
3021
|
+
/**
|
|
3022
|
+
* <p>The experiment definition ID or name.</p>
|
|
3023
|
+
* @public
|
|
3024
|
+
*/
|
|
3025
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
3026
|
+
/**
|
|
3027
|
+
* <p>A description of this experiment run.</p>
|
|
3028
|
+
* @public
|
|
3029
|
+
*/
|
|
3030
|
+
Description?: string | undefined;
|
|
3031
|
+
/**
|
|
3032
|
+
* <p>The percentage of the target audience to expose to treatments. Set to 0 to validate the experiment before exposing production users.</p>
|
|
3033
|
+
* @public
|
|
3034
|
+
*/
|
|
3035
|
+
ExposurePercentage?: number | undefined;
|
|
3036
|
+
/**
|
|
3037
|
+
* <p>Treatment assignment overrides that assign specific entity IDs to treatments directly, bypassing random assignment.</p>
|
|
3038
|
+
* @public
|
|
3039
|
+
*/
|
|
3040
|
+
TreatmentOverrides?: TreatmentOverrides | undefined;
|
|
3041
|
+
/**
|
|
3042
|
+
* <p>The tags to assign to the experiment run.</p>
|
|
3043
|
+
* @public
|
|
3044
|
+
*/
|
|
3045
|
+
Tags?: Record<string, string> | undefined;
|
|
3046
|
+
/**
|
|
3047
|
+
* <p>Optional deployment parameters including a KMS key for encryption.</p>
|
|
3048
|
+
* @public
|
|
3049
|
+
*/
|
|
3050
|
+
DeploymentParameters?: DeploymentParameters | undefined;
|
|
2128
3051
|
}
|
|
2129
3052
|
/**
|
|
2130
3053
|
* @public
|
|
@@ -2153,6 +3076,36 @@ export interface StopDeploymentRequest {
|
|
|
2153
3076
|
*/
|
|
2154
3077
|
AllowRevert?: boolean | undefined;
|
|
2155
3078
|
}
|
|
3079
|
+
/**
|
|
3080
|
+
* @public
|
|
3081
|
+
*/
|
|
3082
|
+
export interface StopExperimentRunRequest {
|
|
3083
|
+
/**
|
|
3084
|
+
* <p>The application ID or name.</p>
|
|
3085
|
+
* @public
|
|
3086
|
+
*/
|
|
3087
|
+
ApplicationIdentifier: string | undefined;
|
|
3088
|
+
/**
|
|
3089
|
+
* <p>The experiment definition ID or name.</p>
|
|
3090
|
+
* @public
|
|
3091
|
+
*/
|
|
3092
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The run number to stop.</p>
|
|
3095
|
+
* @public
|
|
3096
|
+
*/
|
|
3097
|
+
Run: number | undefined;
|
|
3098
|
+
/**
|
|
3099
|
+
* <p>The result of the experiment run, including an executive summary and reasons for or against launching.</p>
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
3102
|
+
Result?: ExperimentRunResult | undefined;
|
|
3103
|
+
/**
|
|
3104
|
+
* <p>Optional deployment parameters for the stop operation.</p>
|
|
3105
|
+
* @public
|
|
3106
|
+
*/
|
|
3107
|
+
DeploymentParameters?: DeploymentParameters | undefined;
|
|
3108
|
+
}
|
|
2156
3109
|
/**
|
|
2157
3110
|
* @public
|
|
2158
3111
|
*/
|
|
@@ -2198,6 +3151,11 @@ export interface UpdateAccountSettingsRequest {
|
|
|
2198
3151
|
* @public
|
|
2199
3152
|
*/
|
|
2200
3153
|
DeletionProtection?: DeletionProtectionSettings | undefined;
|
|
3154
|
+
/**
|
|
3155
|
+
* <p>Configuration for vended metrics in the account.</p>
|
|
3156
|
+
* @public
|
|
3157
|
+
*/
|
|
3158
|
+
VendedMetrics?: VendedMetricsSettings | undefined;
|
|
2201
3159
|
}
|
|
2202
3160
|
/**
|
|
2203
3161
|
* @public
|
|
@@ -2362,6 +3320,91 @@ export interface UpdateEnvironmentRequest {
|
|
|
2362
3320
|
*/
|
|
2363
3321
|
Monitors?: Monitor[] | undefined;
|
|
2364
3322
|
}
|
|
3323
|
+
/**
|
|
3324
|
+
* @public
|
|
3325
|
+
*/
|
|
3326
|
+
export interface UpdateExperimentDefinitionRequest {
|
|
3327
|
+
/**
|
|
3328
|
+
* <p>The application ID or name.</p>
|
|
3329
|
+
* @public
|
|
3330
|
+
*/
|
|
3331
|
+
ApplicationIdentifier: string | undefined;
|
|
3332
|
+
/**
|
|
3333
|
+
* <p>The experiment definition ID or name.</p>
|
|
3334
|
+
* @public
|
|
3335
|
+
*/
|
|
3336
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
3337
|
+
/**
|
|
3338
|
+
* <p>An updated list of treatments.</p>
|
|
3339
|
+
* @public
|
|
3340
|
+
*/
|
|
3341
|
+
Treatments?: TreatmentInput[] | undefined;
|
|
3342
|
+
/**
|
|
3343
|
+
* <p>An updated control treatment.</p>
|
|
3344
|
+
* @public
|
|
3345
|
+
*/
|
|
3346
|
+
Control?: TreatmentInput | undefined;
|
|
3347
|
+
/**
|
|
3348
|
+
* <p>An updated hypothesis.</p>
|
|
3349
|
+
* @public
|
|
3350
|
+
*/
|
|
3351
|
+
Hypothesis?: string | undefined;
|
|
3352
|
+
/**
|
|
3353
|
+
* <p>An updated audience rule.</p>
|
|
3354
|
+
* @public
|
|
3355
|
+
*/
|
|
3356
|
+
AudienceRule?: string | undefined;
|
|
3357
|
+
/**
|
|
3358
|
+
* <p>An updated audience description.</p>
|
|
3359
|
+
* @public
|
|
3360
|
+
*/
|
|
3361
|
+
AudienceDescription?: string | undefined;
|
|
3362
|
+
/**
|
|
3363
|
+
* <p>Updated launch criteria.</p>
|
|
3364
|
+
* @public
|
|
3365
|
+
*/
|
|
3366
|
+
LaunchCriteria?: string | undefined;
|
|
3367
|
+
}
|
|
3368
|
+
/**
|
|
3369
|
+
* @public
|
|
3370
|
+
*/
|
|
3371
|
+
export interface UpdateExperimentRunRequest {
|
|
3372
|
+
/**
|
|
3373
|
+
* <p>The application ID or name.</p>
|
|
3374
|
+
* @public
|
|
3375
|
+
*/
|
|
3376
|
+
ApplicationIdentifier: string | undefined;
|
|
3377
|
+
/**
|
|
3378
|
+
* <p>The experiment definition ID or name.</p>
|
|
3379
|
+
* @public
|
|
3380
|
+
*/
|
|
3381
|
+
ExperimentDefinitionIdentifier: string | undefined;
|
|
3382
|
+
/**
|
|
3383
|
+
* <p>The run number to update.</p>
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3386
|
+
Run: number | undefined;
|
|
3387
|
+
/**
|
|
3388
|
+
* <p>An updated description for the experiment run.</p>
|
|
3389
|
+
* @public
|
|
3390
|
+
*/
|
|
3391
|
+
Description?: string | undefined;
|
|
3392
|
+
/**
|
|
3393
|
+
* <p>The new exposure percentage. This value can only be increased from the current setting.</p>
|
|
3394
|
+
* @public
|
|
3395
|
+
*/
|
|
3396
|
+
ExposurePercentage?: number | undefined;
|
|
3397
|
+
/**
|
|
3398
|
+
* <p>Updated treatment assignment overrides.</p>
|
|
3399
|
+
* @public
|
|
3400
|
+
*/
|
|
3401
|
+
TreatmentOverrides?: TreatmentOverrides | undefined;
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>Updated deployment parameters.</p>
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3406
|
+
DeploymentParameters?: DeploymentParameters | undefined;
|
|
3407
|
+
}
|
|
2365
3408
|
/**
|
|
2366
3409
|
* @public
|
|
2367
3410
|
*/
|