cdk-comprehend-s3olap 2.0.37 → 2.0.40
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/.jsii +3 -3
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +6 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +1 -0
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +346 -70
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +121 -120
- package/node_modules/aws-sdk/clients/datasync.d.ts +16 -16
- package/node_modules/aws-sdk/clients/drs.d.ts +6 -2
- package/node_modules/aws-sdk/clients/evidently.d.ts +281 -8
- package/node_modules/aws-sdk/clients/wafv2.d.ts +26 -21
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +5 -5
- package/node_modules/aws-sdk/dist/aws-sdk.js +3 -3
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +2 -2
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +5 -5
@@ -108,11 +108,11 @@ declare class DataSync extends Service {
|
|
108
108
|
*/
|
109
109
|
createLocationSmb(callback?: (err: AWSError, data: DataSync.Types.CreateLocationSmbResponse) => void): Request<DataSync.Types.CreateLocationSmbResponse, AWSError>;
|
110
110
|
/**
|
111
|
-
*
|
111
|
+
* Configures a task, which defines where and how DataSync transfers your data. A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options). When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync. For more information, see the following topics: Working with DataSync locations Configure DataSync task settings
|
112
112
|
*/
|
113
113
|
createTask(params: DataSync.Types.CreateTaskRequest, callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request<DataSync.Types.CreateTaskResponse, AWSError>;
|
114
114
|
/**
|
115
|
-
*
|
115
|
+
* Configures a task, which defines where and how DataSync transfers your data. A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options). When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync. For more information, see the following topics: Working with DataSync locations Configure DataSync task settings
|
116
116
|
*/
|
117
117
|
createTask(callback?: (err: AWSError, data: DataSync.Types.CreateTaskResponse) => void): Request<DataSync.Types.CreateTaskResponse, AWSError>;
|
118
118
|
/**
|
@@ -276,11 +276,11 @@ declare class DataSync extends Service {
|
|
276
276
|
*/
|
277
277
|
listTaskExecutions(callback?: (err: AWSError, data: DataSync.Types.ListTaskExecutionsResponse) => void): Request<DataSync.Types.ListTaskExecutionsResponse, AWSError>;
|
278
278
|
/**
|
279
|
-
* Returns a list of
|
279
|
+
* Returns a list of the DataSync tasks you created.
|
280
280
|
*/
|
281
281
|
listTasks(params: DataSync.Types.ListTasksRequest, callback?: (err: AWSError, data: DataSync.Types.ListTasksResponse) => void): Request<DataSync.Types.ListTasksResponse, AWSError>;
|
282
282
|
/**
|
283
|
-
* Returns a list of
|
283
|
+
* Returns a list of the DataSync tasks you created.
|
284
284
|
*/
|
285
285
|
listTasks(callback?: (err: AWSError, data: DataSync.Types.ListTasksResponse) => void): Request<DataSync.Types.ListTasksResponse, AWSError>;
|
286
286
|
/**
|
@@ -489,7 +489,7 @@ declare namespace DataSync {
|
|
489
489
|
export interface CreateLocationFsxOntapRequest {
|
490
490
|
Protocol: FsxProtocol;
|
491
491
|
/**
|
492
|
-
* Specifies the security groups that
|
492
|
+
* Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet. The security groups must allow outbound traffic on the following ports (depending on the protocol you use): Network File System (NFS): TCP ports 111, 635, and 2049 Server Message Block (SMB): TCP port 445 Your file system's security groups must also allow inbound traffic on the same ports.
|
493
493
|
*/
|
494
494
|
SecurityGroupArns: Ec2SecurityGroupArnList;
|
495
495
|
/**
|
@@ -541,37 +541,37 @@ declare namespace DataSync {
|
|
541
541
|
}
|
542
542
|
export interface CreateLocationFsxWindowsRequest {
|
543
543
|
/**
|
544
|
-
*
|
544
|
+
* Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
|
545
545
|
*/
|
546
546
|
Subdirectory?: FsxWindowsSubdirectory;
|
547
547
|
/**
|
548
|
-
*
|
548
|
+
* Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
|
549
549
|
*/
|
550
550
|
FsxFilesystemArn: FsxFilesystemArn;
|
551
551
|
/**
|
552
|
-
*
|
552
|
+
* Specifies the ARNs of the security groups that provide access to your file system's preferred subnet. If you choose a security group that doesn't allow connections from within itself, do one of the following: Configure the security group to allow it to communicate within itself. Choose a different security group that can communicate with the mount target's security group.
|
553
553
|
*/
|
554
554
|
SecurityGroupArns: Ec2SecurityGroupArnList;
|
555
555
|
/**
|
556
|
-
*
|
556
|
+
* Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
|
557
557
|
*/
|
558
558
|
Tags?: InputTagList;
|
559
559
|
/**
|
560
|
-
*
|
560
|
+
* Specifies the user who has the permissions to access files and folders in the file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
|
561
561
|
*/
|
562
562
|
User: SmbUser;
|
563
563
|
/**
|
564
|
-
*
|
564
|
+
* Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.
|
565
565
|
*/
|
566
566
|
Domain?: SmbDomain;
|
567
567
|
/**
|
568
|
-
*
|
568
|
+
* Specifies the password of the user who has the permissions to access files and folders in the file system.
|
569
569
|
*/
|
570
570
|
Password: SmbPassword;
|
571
571
|
}
|
572
572
|
export interface CreateLocationFsxWindowsResponse {
|
573
573
|
/**
|
574
|
-
* The
|
574
|
+
* The ARN of the FSx for Windows File Server file system location you created.
|
575
575
|
*/
|
576
576
|
LocationArn?: LocationArn;
|
577
577
|
}
|
@@ -1401,7 +1401,7 @@ declare namespace DataSync {
|
|
1401
1401
|
*/
|
1402
1402
|
Password: SmbPassword;
|
1403
1403
|
/**
|
1404
|
-
* Specifies a user
|
1404
|
+
* Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM. If you provide a user in your Active Directory, note the following: If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group. If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system. Make sure that the user has the permissions it needs to copy the data you want: SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs). SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
|
1405
1405
|
*/
|
1406
1406
|
User: SmbUser;
|
1407
1407
|
}
|
@@ -1560,7 +1560,7 @@ declare namespace DataSync {
|
|
1560
1560
|
*/
|
1561
1561
|
Values: FilterValues;
|
1562
1562
|
/**
|
1563
|
-
* The operator that is used to compare filter values (for example, Equals or Contains).
|
1563
|
+
* The operator that is used to compare filter values (for example, Equals or Contains).
|
1564
1564
|
*/
|
1565
1565
|
Operator: Operator;
|
1566
1566
|
}
|
@@ -1837,7 +1837,7 @@ declare namespace DataSync {
|
|
1837
1837
|
*/
|
1838
1838
|
Values: FilterValues;
|
1839
1839
|
/**
|
1840
|
-
* The operator that is used to compare filter values (for example, Equals or Contains).
|
1840
|
+
* The operator that is used to compare filter values (for example, Equals or Contains).
|
1841
1841
|
*/
|
1842
1842
|
Operator: Operator;
|
1843
1843
|
}
|
@@ -487,7 +487,7 @@ declare namespace Drs {
|
|
487
487
|
}
|
488
488
|
export interface DeleteRecoveryInstanceRequest {
|
489
489
|
/**
|
490
|
-
*
|
490
|
+
* The ID of the Recovery Instance to be deleted.
|
491
491
|
*/
|
492
492
|
recoveryInstanceID: RecoveryInstanceID;
|
493
493
|
}
|
@@ -1400,7 +1400,7 @@ declare namespace Drs {
|
|
1400
1400
|
useDedicatedReplicationServer?: Boolean;
|
1401
1401
|
}
|
1402
1402
|
export type ReplicationConfigurationDataPlaneRouting = "PRIVATE_IP"|"PUBLIC_IP"|string;
|
1403
|
-
export type ReplicationConfigurationDefaultLargeStagingDiskType = "GP2"|"GP3"|"ST1"|string;
|
1403
|
+
export type ReplicationConfigurationDefaultLargeStagingDiskType = "GP2"|"GP3"|"ST1"|"AUTO"|string;
|
1404
1404
|
export type ReplicationConfigurationEbsEncryption = "DEFAULT"|"CUSTOM"|string;
|
1405
1405
|
export interface ReplicationConfigurationReplicatedDisk {
|
1406
1406
|
/**
|
@@ -1415,6 +1415,10 @@ declare namespace Drs {
|
|
1415
1415
|
* Whether to boot from this disk or not.
|
1416
1416
|
*/
|
1417
1417
|
isBootDisk?: Boolean;
|
1418
|
+
/**
|
1419
|
+
* The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.
|
1420
|
+
*/
|
1421
|
+
optimizedStagingDiskType?: ReplicationConfigurationReplicatedDiskStagingDiskType;
|
1418
1422
|
/**
|
1419
1423
|
* The Staging Disk EBS volume type to be used during replication.
|
1420
1424
|
*/
|
@@ -20,11 +20,11 @@ declare class Evidently extends Service {
|
|
20
20
|
*/
|
21
21
|
batchEvaluateFeature(callback?: (err: AWSError, data: Evidently.Types.BatchEvaluateFeatureResponse) => void): Request<Evidently.Types.BatchEvaluateFeatureResponse, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
|
23
|
+
* Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
|
24
24
|
*/
|
25
25
|
createExperiment(params: Evidently.Types.CreateExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.CreateExperimentResponse) => void): Request<Evidently.Types.CreateExperimentResponse, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
|
27
|
+
* Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
|
28
28
|
*/
|
29
29
|
createExperiment(callback?: (err: AWSError, data: Evidently.Types.CreateExperimentResponse) => void): Request<Evidently.Types.CreateExperimentResponse, AWSError>;
|
30
30
|
/**
|
@@ -51,6 +51,14 @@ declare class Evidently extends Service {
|
|
51
51
|
* Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together. To update an existing project, use UpdateProject.
|
52
52
|
*/
|
53
53
|
createProject(callback?: (err: AWSError, data: Evidently.Types.CreateProjectResponse) => void): Request<Evidently.Types.CreateProjectResponse, AWSError>;
|
54
|
+
/**
|
55
|
+
* Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allow you to define different traffic splits for the different audience segments. <p>For more information about segment pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html"> Segment rule pattern syntax</a>.</p> <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation, when Evidently assigns a feature variation to a user.</p>
|
56
|
+
*/
|
57
|
+
createSegment(params: Evidently.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.CreateSegmentResponse) => void): Request<Evidently.Types.CreateSegmentResponse, AWSError>;
|
58
|
+
/**
|
59
|
+
* Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allow you to define different traffic splits for the different audience segments. <p>For more information about segment pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html"> Segment rule pattern syntax</a>.</p> <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation, when Evidently assigns a feature variation to a user.</p>
|
60
|
+
*/
|
61
|
+
createSegment(callback?: (err: AWSError, data: Evidently.Types.CreateSegmentResponse) => void): Request<Evidently.Types.CreateSegmentResponse, AWSError>;
|
54
62
|
/**
|
55
63
|
* Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment.
|
56
64
|
*/
|
@@ -84,11 +92,19 @@ declare class Evidently extends Service {
|
|
84
92
|
*/
|
85
93
|
deleteProject(callback?: (err: AWSError, data: Evidently.Types.DeleteProjectResponse) => void): Request<Evidently.Types.DeleteProjectResponse, AWSError>;
|
86
94
|
/**
|
87
|
-
*
|
95
|
+
* Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.
|
96
|
+
*/
|
97
|
+
deleteSegment(params: Evidently.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteSegmentResponse) => void): Request<Evidently.Types.DeleteSegmentResponse, AWSError>;
|
98
|
+
/**
|
99
|
+
* Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.
|
100
|
+
*/
|
101
|
+
deleteSegment(callback?: (err: AWSError, data: Evidently.Types.DeleteSegmentResponse) => void): Request<Evidently.Types.DeleteSegmentResponse, AWSError>;
|
102
|
+
/**
|
103
|
+
* This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. <p>If there is a current launch with this feature that uses segment overrides, and if the user session's <code>evaluationContext</code> matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html">CreateSegment</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html">Use segments to focus your audience</a>.</p> <p>If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.</p> <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment.</p> <p>If the experiment uses a segment, then only user sessions with <code>evaluationContext</code> values that match the segment rule are used in the experiment.</p> <p>If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. </p> <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
|
88
104
|
*/
|
89
105
|
evaluateFeature(params: Evidently.Types.EvaluateFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.EvaluateFeatureResponse) => void): Request<Evidently.Types.EvaluateFeatureResponse, AWSError>;
|
90
106
|
/**
|
91
|
-
* This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule.
|
107
|
+
* This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. <p>If there is a current launch with this feature that uses segment overrides, and if the user session's <code>evaluationContext</code> matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html">CreateSegment</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html">Use segments to focus your audience</a>.</p> <p>If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.</p> <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment.</p> <p>If the experiment uses a segment, then only user sessions with <code>evaluationContext</code> values that match the segment rule are used in the experiment.</p> <p>If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. </p> <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
|
92
108
|
*/
|
93
109
|
evaluateFeature(callback?: (err: AWSError, data: Evidently.Types.EvaluateFeatureResponse) => void): Request<Evidently.Types.EvaluateFeatureResponse, AWSError>;
|
94
110
|
/**
|
@@ -131,6 +147,14 @@ declare class Evidently extends Service {
|
|
131
147
|
* Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.
|
132
148
|
*/
|
133
149
|
getProject(callback?: (err: AWSError, data: Evidently.Types.GetProjectResponse) => void): Request<Evidently.Types.GetProjectResponse, AWSError>;
|
150
|
+
/**
|
151
|
+
* Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
|
152
|
+
*/
|
153
|
+
getSegment(params: Evidently.Types.GetSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.GetSegmentResponse) => void): Request<Evidently.Types.GetSegmentResponse, AWSError>;
|
154
|
+
/**
|
155
|
+
* Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
|
156
|
+
*/
|
157
|
+
getSegment(callback?: (err: AWSError, data: Evidently.Types.GetSegmentResponse) => void): Request<Evidently.Types.GetSegmentResponse, AWSError>;
|
134
158
|
/**
|
135
159
|
* Returns configuration details about all the experiments in the specified project.
|
136
160
|
*/
|
@@ -163,6 +187,22 @@ declare class Evidently extends Service {
|
|
163
187
|
* Returns configuration details about all the projects in the current Region in your account.
|
164
188
|
*/
|
165
189
|
listProjects(callback?: (err: AWSError, data: Evidently.Types.ListProjectsResponse) => void): Request<Evidently.Types.ListProjectsResponse, AWSError>;
|
190
|
+
/**
|
191
|
+
* Use this operation to find which experiments or launches are using a specified segment.
|
192
|
+
*/
|
193
|
+
listSegmentReferences(params: Evidently.Types.ListSegmentReferencesRequest, callback?: (err: AWSError, data: Evidently.Types.ListSegmentReferencesResponse) => void): Request<Evidently.Types.ListSegmentReferencesResponse, AWSError>;
|
194
|
+
/**
|
195
|
+
* Use this operation to find which experiments or launches are using a specified segment.
|
196
|
+
*/
|
197
|
+
listSegmentReferences(callback?: (err: AWSError, data: Evidently.Types.ListSegmentReferencesResponse) => void): Request<Evidently.Types.ListSegmentReferencesResponse, AWSError>;
|
198
|
+
/**
|
199
|
+
* Returns a list of audience segments that you have created in your account in this Region.
|
200
|
+
*/
|
201
|
+
listSegments(params: Evidently.Types.ListSegmentsRequest, callback?: (err: AWSError, data: Evidently.Types.ListSegmentsResponse) => void): Request<Evidently.Types.ListSegmentsResponse, AWSError>;
|
202
|
+
/**
|
203
|
+
* Returns a list of audience segments that you have created in your account in this Region.
|
204
|
+
*/
|
205
|
+
listSegments(callback?: (err: AWSError, data: Evidently.Types.ListSegmentsResponse) => void): Request<Evidently.Types.ListSegmentsResponse, AWSError>;
|
166
206
|
/**
|
167
207
|
* Displays the tags associated with an Evidently resource.
|
168
208
|
*/
|
@@ -219,6 +259,14 @@ declare class Evidently extends Service {
|
|
219
259
|
* Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources.
|
220
260
|
*/
|
221
261
|
tagResource(callback?: (err: AWSError, data: Evidently.Types.TagResourceResponse) => void): Request<Evidently.Types.TagResourceResponse, AWSError>;
|
262
|
+
/**
|
263
|
+
* Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment.
|
264
|
+
*/
|
265
|
+
testSegmentPattern(params: Evidently.Types.TestSegmentPatternRequest, callback?: (err: AWSError, data: Evidently.Types.TestSegmentPatternResponse) => void): Request<Evidently.Types.TestSegmentPatternResponse, AWSError>;
|
266
|
+
/**
|
267
|
+
* Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment.
|
268
|
+
*/
|
269
|
+
testSegmentPattern(callback?: (err: AWSError, data: Evidently.Types.TestSegmentPatternResponse) => void): Request<Evidently.Types.TestSegmentPatternResponse, AWSError>;
|
222
270
|
/**
|
223
271
|
* Removes one or more tags from the specified resource.
|
224
272
|
*/
|
@@ -329,6 +377,10 @@ declare namespace Evidently {
|
|
329
377
|
* The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature. This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
|
330
378
|
*/
|
331
379
|
samplingRate?: SplitWeight;
|
380
|
+
/**
|
381
|
+
* Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
|
382
|
+
*/
|
383
|
+
segment?: SegmentRef;
|
332
384
|
/**
|
333
385
|
* Assigns one or more tags (key-value pairs) to the experiment. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. <p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
334
386
|
*/
|
@@ -406,7 +458,7 @@ declare namespace Evidently {
|
|
406
458
|
*/
|
407
459
|
project: ProjectRef;
|
408
460
|
/**
|
409
|
-
* When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the
|
461
|
+
* When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.
|
410
462
|
*/
|
411
463
|
randomizationSalt?: RandomizationSalt;
|
412
464
|
/**
|
@@ -448,6 +500,30 @@ declare namespace Evidently {
|
|
448
500
|
*/
|
449
501
|
project: Project;
|
450
502
|
}
|
503
|
+
export interface CreateSegmentRequest {
|
504
|
+
/**
|
505
|
+
* An optional description for this segment.
|
506
|
+
*/
|
507
|
+
description?: Description;
|
508
|
+
/**
|
509
|
+
* A name for the segment.
|
510
|
+
*/
|
511
|
+
name: SegmentName;
|
512
|
+
/**
|
513
|
+
* The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
|
514
|
+
*/
|
515
|
+
pattern: SegmentPattern;
|
516
|
+
/**
|
517
|
+
* Assigns one or more tags (key-value pairs) to the segment. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. <p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
|
518
|
+
*/
|
519
|
+
tags?: TagMap;
|
520
|
+
}
|
521
|
+
export interface CreateSegmentResponse {
|
522
|
+
/**
|
523
|
+
* A structure that contains the complete information about the segment that was just created.
|
524
|
+
*/
|
525
|
+
segment: Segment;
|
526
|
+
}
|
451
527
|
export type CwDimensionSafeName = string;
|
452
528
|
export type CwLogGroupSafeName = string;
|
453
529
|
export interface DeleteExperimentRequest {
|
@@ -494,6 +570,14 @@ declare namespace Evidently {
|
|
494
570
|
}
|
495
571
|
export interface DeleteProjectResponse {
|
496
572
|
}
|
573
|
+
export interface DeleteSegmentRequest {
|
574
|
+
/**
|
575
|
+
* Specifies the segment to delete.
|
576
|
+
*/
|
577
|
+
segment: SegmentRef;
|
578
|
+
}
|
579
|
+
export interface DeleteSegmentResponse {
|
580
|
+
}
|
497
581
|
export type Description = string;
|
498
582
|
export type Double = number;
|
499
583
|
export type DoubleValueList = Double[];
|
@@ -507,7 +591,7 @@ declare namespace Evidently {
|
|
507
591
|
*/
|
508
592
|
entityId: EntityId;
|
509
593
|
/**
|
510
|
-
* A JSON
|
594
|
+
* A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience. <p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
|
511
595
|
*/
|
512
596
|
evaluationContext?: JsonValue;
|
513
597
|
/**
|
@@ -659,6 +743,10 @@ declare namespace Evidently {
|
|
659
743
|
* A structure that contains the time and date that Evidently completed the analysis of the experiment.
|
660
744
|
*/
|
661
745
|
schedule?: ExperimentSchedule;
|
746
|
+
/**
|
747
|
+
* The audience segment being used for the experiment, if a segment is being used.
|
748
|
+
*/
|
749
|
+
segment?: SegmentArn;
|
662
750
|
/**
|
663
751
|
* The current state of the experiment.
|
664
752
|
*/
|
@@ -972,6 +1060,18 @@ declare namespace Evidently {
|
|
972
1060
|
*/
|
973
1061
|
project: Project;
|
974
1062
|
}
|
1063
|
+
export interface GetSegmentRequest {
|
1064
|
+
/**
|
1065
|
+
* The ARN of the segment to return information for.
|
1066
|
+
*/
|
1067
|
+
segment: SegmentRef;
|
1068
|
+
}
|
1069
|
+
export interface GetSegmentResponse {
|
1070
|
+
/**
|
1071
|
+
* A structure that contains the complete information about the segment.
|
1072
|
+
*/
|
1073
|
+
segment: Segment;
|
1074
|
+
}
|
975
1075
|
export type GroupName = string;
|
976
1076
|
export type GroupToWeightMap = {[key: string]: SplitWeight};
|
977
1077
|
export type Integer = number;
|
@@ -1189,6 +1289,54 @@ declare namespace Evidently {
|
|
1189
1289
|
*/
|
1190
1290
|
projects?: ProjectSummariesList;
|
1191
1291
|
}
|
1292
|
+
export interface ListSegmentReferencesRequest {
|
1293
|
+
/**
|
1294
|
+
* The maximum number of results to include in the response. If you omit this, the default of 50 is used.
|
1295
|
+
*/
|
1296
|
+
maxResults?: MaxReferences;
|
1297
|
+
/**
|
1298
|
+
* The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.
|
1299
|
+
*/
|
1300
|
+
nextToken?: NextToken;
|
1301
|
+
/**
|
1302
|
+
* The ARN of the segment that you want to view information for.
|
1303
|
+
*/
|
1304
|
+
segment: SegmentRef;
|
1305
|
+
/**
|
1306
|
+
* Specifies whether to return information about launches or experiments that use this segment.
|
1307
|
+
*/
|
1308
|
+
type: SegmentReferenceResourceType;
|
1309
|
+
}
|
1310
|
+
export interface ListSegmentReferencesResponse {
|
1311
|
+
/**
|
1312
|
+
* The token to use in a subsequent ListSegmentReferences operation to return the next set of results.
|
1313
|
+
*/
|
1314
|
+
nextToken?: NextToken;
|
1315
|
+
/**
|
1316
|
+
* An array of structures, where each structure contains information about one experiment or launch that uses this segment.
|
1317
|
+
*/
|
1318
|
+
referencedBy?: RefResourceList;
|
1319
|
+
}
|
1320
|
+
export interface ListSegmentsRequest {
|
1321
|
+
/**
|
1322
|
+
* The maximum number of results to include in the response. If you omit this, the default of 50 is used.
|
1323
|
+
*/
|
1324
|
+
maxResults?: MaxSegments;
|
1325
|
+
/**
|
1326
|
+
* The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.
|
1327
|
+
*/
|
1328
|
+
nextToken?: NextToken;
|
1329
|
+
}
|
1330
|
+
export interface ListSegmentsResponse {
|
1331
|
+
/**
|
1332
|
+
* The token to use in a subsequent ListSegments operation to return the next set of results.
|
1333
|
+
*/
|
1334
|
+
nextToken?: NextToken;
|
1335
|
+
/**
|
1336
|
+
* An array of structures that contain information about the segments in this Region.
|
1337
|
+
*/
|
1338
|
+
segments?: SegmentList;
|
1339
|
+
}
|
1192
1340
|
export interface ListTagsForResourceRequest {
|
1193
1341
|
/**
|
1194
1342
|
* The ARN of the resource that you want to see the tags of.
|
@@ -1206,6 +1354,8 @@ declare namespace Evidently {
|
|
1206
1354
|
export type MaxFeatures = number;
|
1207
1355
|
export type MaxLaunches = number;
|
1208
1356
|
export type MaxProjects = number;
|
1357
|
+
export type MaxReferences = number;
|
1358
|
+
export type MaxSegments = number;
|
1209
1359
|
export interface MetricDefinition {
|
1210
1360
|
/**
|
1211
1361
|
* The entity, such as a user or session, that does an action that causes a metric value to be recorded.
|
@@ -1310,6 +1460,7 @@ declare namespace Evidently {
|
|
1310
1460
|
*/
|
1311
1461
|
treatmentWeights?: TreatmentToWeightMap;
|
1312
1462
|
}
|
1463
|
+
export type PrimitiveBoolean = boolean;
|
1313
1464
|
export interface Project {
|
1314
1465
|
/**
|
1315
1466
|
* The number of ongoing experiments currently in the project.
|
@@ -1475,6 +1626,37 @@ declare namespace Evidently {
|
|
1475
1626
|
}
|
1476
1627
|
export type PutProjectEventsResultEntryList = PutProjectEventsResultEntry[];
|
1477
1628
|
export type RandomizationSalt = string;
|
1629
|
+
export interface RefResource {
|
1630
|
+
/**
|
1631
|
+
* The ARN of the experiment or launch.
|
1632
|
+
*/
|
1633
|
+
arn?: String;
|
1634
|
+
/**
|
1635
|
+
* The day and time that this experiment or launch ended.
|
1636
|
+
*/
|
1637
|
+
endTime?: String;
|
1638
|
+
/**
|
1639
|
+
* The day and time that this experiment or launch was most recently updated.
|
1640
|
+
*/
|
1641
|
+
lastUpdatedOn?: String;
|
1642
|
+
/**
|
1643
|
+
* The name of the experiment or launch.
|
1644
|
+
*/
|
1645
|
+
name: String;
|
1646
|
+
/**
|
1647
|
+
* The day and time that this experiment or launch started.
|
1648
|
+
*/
|
1649
|
+
startTime?: String;
|
1650
|
+
/**
|
1651
|
+
* The status of the experiment or launch.
|
1652
|
+
*/
|
1653
|
+
status?: String;
|
1654
|
+
/**
|
1655
|
+
* Specifies whether the resource that this structure contains information about is an experiment or a launch.
|
1656
|
+
*/
|
1657
|
+
type: String;
|
1658
|
+
}
|
1659
|
+
export type RefResourceList = RefResource[];
|
1478
1660
|
export type ResultsPeriod = number;
|
1479
1661
|
export type RuleName = string;
|
1480
1662
|
export type RuleType = string;
|
@@ -1502,9 +1684,13 @@ declare namespace Evidently {
|
|
1502
1684
|
export type S3PrefixSafeName = string;
|
1503
1685
|
export interface ScheduledSplit {
|
1504
1686
|
/**
|
1505
|
-
* The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
|
1687
|
+
* The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step. The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation. If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.
|
1506
1688
|
*/
|
1507
1689
|
groupWeights?: GroupToWeightMap;
|
1690
|
+
/**
|
1691
|
+
* Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
|
1692
|
+
*/
|
1693
|
+
segmentOverrides?: SegmentOverridesList;
|
1508
1694
|
/**
|
1509
1695
|
* The date and time that this step of the launch starts.
|
1510
1696
|
*/
|
@@ -1512,9 +1698,13 @@ declare namespace Evidently {
|
|
1512
1698
|
}
|
1513
1699
|
export interface ScheduledSplitConfig {
|
1514
1700
|
/**
|
1515
|
-
* The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
|
1701
|
+
* The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step. <p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.</p>
|
1516
1702
|
*/
|
1517
1703
|
groupWeights: GroupToWeightMap;
|
1704
|
+
/**
|
1705
|
+
* Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
|
1706
|
+
*/
|
1707
|
+
segmentOverrides?: SegmentOverridesList;
|
1518
1708
|
/**
|
1519
1709
|
* The date and time that this step of the launch starts.
|
1520
1710
|
*/
|
@@ -1534,6 +1724,65 @@ declare namespace Evidently {
|
|
1534
1724
|
steps?: ScheduledStepList;
|
1535
1725
|
}
|
1536
1726
|
export type ScheduledStepList = ScheduledSplit[];
|
1727
|
+
export interface Segment {
|
1728
|
+
/**
|
1729
|
+
* The ARN of the segment.
|
1730
|
+
*/
|
1731
|
+
arn: SegmentArn;
|
1732
|
+
/**
|
1733
|
+
* The date and time that this segment was created.
|
1734
|
+
*/
|
1735
|
+
createdTime: Timestamp;
|
1736
|
+
/**
|
1737
|
+
* The customer-created description for this segment.
|
1738
|
+
*/
|
1739
|
+
description?: Description;
|
1740
|
+
/**
|
1741
|
+
* The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
|
1742
|
+
*/
|
1743
|
+
experimentCount?: Long;
|
1744
|
+
/**
|
1745
|
+
* The date and time that this segment was most recently updated.
|
1746
|
+
*/
|
1747
|
+
lastUpdatedTime: Timestamp;
|
1748
|
+
/**
|
1749
|
+
* The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
|
1750
|
+
*/
|
1751
|
+
launchCount?: Long;
|
1752
|
+
/**
|
1753
|
+
* The name of the segment.
|
1754
|
+
*/
|
1755
|
+
name: SegmentName;
|
1756
|
+
/**
|
1757
|
+
*
|
1758
|
+
*/
|
1759
|
+
pattern: SegmentPattern;
|
1760
|
+
/**
|
1761
|
+
* The list of tag keys and values associated with this launch.
|
1762
|
+
*/
|
1763
|
+
tags?: TagMap;
|
1764
|
+
}
|
1765
|
+
export type SegmentArn = string;
|
1766
|
+
export type SegmentList = Segment[];
|
1767
|
+
export type SegmentName = string;
|
1768
|
+
export interface SegmentOverride {
|
1769
|
+
/**
|
1770
|
+
* A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
|
1771
|
+
*/
|
1772
|
+
evaluationOrder: Long;
|
1773
|
+
/**
|
1774
|
+
* The ARN of the segment to use.
|
1775
|
+
*/
|
1776
|
+
segment: SegmentRef;
|
1777
|
+
/**
|
1778
|
+
* The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
|
1779
|
+
*/
|
1780
|
+
weights: GroupToWeightMap;
|
1781
|
+
}
|
1782
|
+
export type SegmentOverridesList = SegmentOverride[];
|
1783
|
+
export type SegmentPattern = string;
|
1784
|
+
export type SegmentRef = string;
|
1785
|
+
export type SegmentReferenceResourceType = "EXPERIMENT"|"LAUNCH"|string;
|
1537
1786
|
export type SplitWeight = number;
|
1538
1787
|
export interface StartExperimentRequest {
|
1539
1788
|
/**
|
@@ -1636,6 +1885,22 @@ declare namespace Evidently {
|
|
1636
1885
|
export interface TagResourceResponse {
|
1637
1886
|
}
|
1638
1887
|
export type TagValue = string;
|
1888
|
+
export interface TestSegmentPatternRequest {
|
1889
|
+
/**
|
1890
|
+
* The pattern to test.
|
1891
|
+
*/
|
1892
|
+
pattern: SegmentPattern;
|
1893
|
+
/**
|
1894
|
+
* A sample evaluationContext JSON block to test against the specified pattern.
|
1895
|
+
*/
|
1896
|
+
payload: JsonValue;
|
1897
|
+
}
|
1898
|
+
export interface TestSegmentPatternResponse {
|
1899
|
+
/**
|
1900
|
+
* Returns true if the pattern matches the payload.
|
1901
|
+
*/
|
1902
|
+
match: Boolean;
|
1903
|
+
}
|
1639
1904
|
export type Timestamp = Date;
|
1640
1905
|
export type TimestampList = Timestamp[];
|
1641
1906
|
export interface Treatment {
|
@@ -1712,10 +1977,18 @@ declare namespace Evidently {
|
|
1712
1977
|
* When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
|
1713
1978
|
*/
|
1714
1979
|
randomizationSalt?: RandomizationSalt;
|
1980
|
+
/**
|
1981
|
+
* Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
|
1982
|
+
*/
|
1983
|
+
removeSegment?: PrimitiveBoolean;
|
1715
1984
|
/**
|
1716
1985
|
* The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature. This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
|
1717
1986
|
*/
|
1718
1987
|
samplingRate?: SplitWeight;
|
1988
|
+
/**
|
1989
|
+
* Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
|
1990
|
+
*/
|
1991
|
+
segment?: SegmentRef;
|
1719
1992
|
/**
|
1720
1993
|
* An array of structures that define the variations being tested in the experiment.
|
1721
1994
|
*/
|