cdk-comprehend-s3olap 2.0.41 → 2.0.44
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 +20 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +117 -6
- package/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +174 -35
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.paginators.json +17 -0
- package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +11 -0
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +249 -94
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +56 -47
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +260 -59
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +73 -72
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +54 -29
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +91 -48
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +0 -3
- package/node_modules/aws-sdk/apis/sagemaker-edge-2020-09-23.min.json +84 -4
- package/node_modules/aws-sdk/clients/acmpca.d.ts +2 -2
- package/node_modules/aws-sdk/clients/athena.d.ts +127 -0
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +40 -1
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +188 -0
- package/node_modules/aws-sdk/clients/dms.d.ts +2 -2
- package/node_modules/aws-sdk/clients/docdb.d.ts +20 -0
- package/node_modules/aws-sdk/clients/frauddetector.d.ts +176 -5
- package/node_modules/aws-sdk/clients/glue.d.ts +3 -3
- package/node_modules/aws-sdk/clients/iot.d.ts +14 -2
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +192 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +12 -7
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +53 -2
- package/node_modules/aws-sdk/clients/rds.d.ts +87 -87
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +1 -1
- package/node_modules/aws-sdk/clients/sagemakeredge.d.ts +146 -0
- 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 +15 -15
- package/node_modules/aws-sdk/dist/aws-sdk.js +235 -85
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +93 -93
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +5 -5
@@ -100,6 +100,14 @@ declare class IoTSiteWise extends Service {
|
|
100
100
|
* Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
|
101
101
|
*/
|
102
102
|
createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
|
103
|
+
/**
|
104
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
|
105
|
+
*/
|
106
|
+
createBulkImportJob(params: IoTSiteWise.Types.CreateBulkImportJobRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
|
107
|
+
/**
|
108
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
|
109
|
+
*/
|
110
|
+
createBulkImportJob(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
|
103
111
|
/**
|
104
112
|
* Creates a dashboard in an IoT SiteWise Monitor project.
|
105
113
|
*/
|
@@ -228,6 +236,14 @@ declare class IoTSiteWise extends Service {
|
|
228
236
|
* Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
|
229
237
|
*/
|
230
238
|
describeAssetProperty(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
|
239
|
+
/**
|
240
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
|
241
|
+
*/
|
242
|
+
describeBulkImportJob(params: IoTSiteWise.Types.DescribeBulkImportJobRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeBulkImportJobResponse) => void): Request<IoTSiteWise.Types.DescribeBulkImportJobResponse, AWSError>;
|
243
|
+
/**
|
244
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
|
245
|
+
*/
|
246
|
+
describeBulkImportJob(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeBulkImportJobResponse) => void): Request<IoTSiteWise.Types.DescribeBulkImportJobResponse, AWSError>;
|
231
247
|
/**
|
232
248
|
* Retrieves information about a dashboard.
|
233
249
|
*/
|
@@ -388,6 +404,14 @@ declare class IoTSiteWise extends Service {
|
|
388
404
|
* Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
|
389
405
|
*/
|
390
406
|
listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
|
407
|
+
/**
|
408
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the Amazon Simple Storage Service User Guide.
|
409
|
+
*/
|
410
|
+
listBulkImportJobs(params: IoTSiteWise.Types.ListBulkImportJobsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListBulkImportJobsResponse) => void): Request<IoTSiteWise.Types.ListBulkImportJobsResponse, AWSError>;
|
411
|
+
/**
|
412
|
+
* This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the Amazon Simple Storage Service User Guide.
|
413
|
+
*/
|
414
|
+
listBulkImportJobs(callback?: (err: AWSError, data: IoTSiteWise.Types.ListBulkImportJobsResponse) => void): Request<IoTSiteWise.Types.ListBulkImportJobsResponse, AWSError>;
|
391
415
|
/**
|
392
416
|
* Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
|
393
417
|
*/
|
@@ -1520,10 +1544,13 @@ declare namespace IoTSiteWise {
|
|
1520
1544
|
*/
|
1521
1545
|
errorEntries: BatchPutAssetPropertyErrorEntries;
|
1522
1546
|
}
|
1547
|
+
export type Bucket = string;
|
1523
1548
|
export type CapabilityConfiguration = string;
|
1524
1549
|
export type CapabilityNamespace = string;
|
1525
1550
|
export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string;
|
1526
1551
|
export type ClientToken = string;
|
1552
|
+
export type ColumnName = "ALIAS"|"ASSET_ID"|"PROPERTY_ID"|"DATA_TYPE"|"TIMESTAMP_SECONDS"|"TIMESTAMP_NANO_OFFSET"|"QUALITY"|"VALUE"|string;
|
1553
|
+
export type ColumnNames = ColumnName[];
|
1527
1554
|
export interface CompositeModelProperty {
|
1528
1555
|
/**
|
1529
1556
|
* The name of the property.
|
@@ -1670,6 +1697,42 @@ declare namespace IoTSiteWise {
|
|
1670
1697
|
*/
|
1671
1698
|
assetStatus: AssetStatus;
|
1672
1699
|
}
|
1700
|
+
export interface CreateBulkImportJobRequest {
|
1701
|
+
/**
|
1702
|
+
* The unique name that helps identify the job request.
|
1703
|
+
*/
|
1704
|
+
jobName: Name;
|
1705
|
+
/**
|
1706
|
+
* The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
|
1707
|
+
*/
|
1708
|
+
jobRoleArn: ARN;
|
1709
|
+
/**
|
1710
|
+
* The files in the specified Amazon S3 bucket that contain your data.
|
1711
|
+
*/
|
1712
|
+
files: Files;
|
1713
|
+
/**
|
1714
|
+
* The Amazon S3 destination where errors associated with the job creation request are saved.
|
1715
|
+
*/
|
1716
|
+
errorReportLocation: ErrorReportLocation;
|
1717
|
+
/**
|
1718
|
+
* Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
|
1719
|
+
*/
|
1720
|
+
jobConfiguration: JobConfiguration;
|
1721
|
+
}
|
1722
|
+
export interface CreateBulkImportJobResponse {
|
1723
|
+
/**
|
1724
|
+
* The ID of the job.
|
1725
|
+
*/
|
1726
|
+
jobId: ID;
|
1727
|
+
/**
|
1728
|
+
* The unique name that helps identify the job request.
|
1729
|
+
*/
|
1730
|
+
jobName: Name;
|
1731
|
+
/**
|
1732
|
+
* The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
|
1733
|
+
*/
|
1734
|
+
jobStatus: JobStatus;
|
1735
|
+
}
|
1673
1736
|
export interface CreateDashboardRequest {
|
1674
1737
|
/**
|
1675
1738
|
* The ID of the project in which to create the dashboard.
|
@@ -1826,6 +1889,12 @@ declare namespace IoTSiteWise {
|
|
1826
1889
|
*/
|
1827
1890
|
projectArn: ARN;
|
1828
1891
|
}
|
1892
|
+
export interface Csv {
|
1893
|
+
/**
|
1894
|
+
* The column names specified in the .csv file.
|
1895
|
+
*/
|
1896
|
+
columnNames?: ColumnNames;
|
1897
|
+
}
|
1829
1898
|
export interface CustomerManagedS3Storage {
|
1830
1899
|
/**
|
1831
1900
|
* The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
|
@@ -2137,6 +2206,50 @@ declare namespace IoTSiteWise {
|
|
2137
2206
|
*/
|
2138
2207
|
assetDescription?: Description;
|
2139
2208
|
}
|
2209
|
+
export interface DescribeBulkImportJobRequest {
|
2210
|
+
/**
|
2211
|
+
* The ID of the job.
|
2212
|
+
*/
|
2213
|
+
jobId: ID;
|
2214
|
+
}
|
2215
|
+
export interface DescribeBulkImportJobResponse {
|
2216
|
+
/**
|
2217
|
+
* The ID of the job.
|
2218
|
+
*/
|
2219
|
+
jobId: ID;
|
2220
|
+
/**
|
2221
|
+
* The unique name that helps identify the job request.
|
2222
|
+
*/
|
2223
|
+
jobName: Name;
|
2224
|
+
/**
|
2225
|
+
* The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
|
2226
|
+
*/
|
2227
|
+
jobStatus: JobStatus;
|
2228
|
+
/**
|
2229
|
+
* The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
|
2230
|
+
*/
|
2231
|
+
jobRoleArn: ARN;
|
2232
|
+
/**
|
2233
|
+
* The files in the specified Amazon S3 bucket that contain your data.
|
2234
|
+
*/
|
2235
|
+
files: Files;
|
2236
|
+
/**
|
2237
|
+
* The Amazon S3 destination where errors associated with the job creation request are saved.
|
2238
|
+
*/
|
2239
|
+
errorReportLocation: ErrorReportLocation;
|
2240
|
+
/**
|
2241
|
+
* Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
|
2242
|
+
*/
|
2243
|
+
jobConfiguration: JobConfiguration;
|
2244
|
+
/**
|
2245
|
+
* The date the job was created, in Unix epoch TIME.
|
2246
|
+
*/
|
2247
|
+
jobCreationDate: Timestamp;
|
2248
|
+
/**
|
2249
|
+
* The date the job was last updated, in Unix epoch time.
|
2250
|
+
*/
|
2251
|
+
jobLastUpdateDate: Timestamp;
|
2252
|
+
}
|
2140
2253
|
export interface DescribeDashboardRequest {
|
2141
2254
|
/**
|
2142
2255
|
* The ID of the dashboard.
|
@@ -2512,6 +2625,16 @@ declare namespace IoTSiteWise {
|
|
2512
2625
|
details?: DetailedErrors;
|
2513
2626
|
}
|
2514
2627
|
export type ErrorMessage = string;
|
2628
|
+
export interface ErrorReportLocation {
|
2629
|
+
/**
|
2630
|
+
* The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
|
2631
|
+
*/
|
2632
|
+
bucket: Bucket;
|
2633
|
+
/**
|
2634
|
+
* Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
|
2635
|
+
*/
|
2636
|
+
prefix: String;
|
2637
|
+
}
|
2515
2638
|
export type Expression = string;
|
2516
2639
|
export interface ExpressionVariable {
|
2517
2640
|
/**
|
@@ -2524,6 +2647,27 @@ declare namespace IoTSiteWise {
|
|
2524
2647
|
value: VariableValue;
|
2525
2648
|
}
|
2526
2649
|
export type ExpressionVariables = ExpressionVariable[];
|
2650
|
+
export interface File {
|
2651
|
+
/**
|
2652
|
+
* The name of the Amazon S3 bucket from which data is imported.
|
2653
|
+
*/
|
2654
|
+
bucket: Bucket;
|
2655
|
+
/**
|
2656
|
+
* The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
|
2657
|
+
*/
|
2658
|
+
key: String;
|
2659
|
+
/**
|
2660
|
+
* The version ID to identify a specific version of the Amazon S3 object that contains your data.
|
2661
|
+
*/
|
2662
|
+
versionId?: String;
|
2663
|
+
}
|
2664
|
+
export interface FileFormat {
|
2665
|
+
/**
|
2666
|
+
* The .csv file format.
|
2667
|
+
*/
|
2668
|
+
csv?: Csv;
|
2669
|
+
}
|
2670
|
+
export type Files = File[];
|
2527
2671
|
export interface ForwardingConfig {
|
2528
2672
|
/**
|
2529
2673
|
* The forwarding state for the given property.
|
@@ -2854,6 +2998,28 @@ declare namespace IoTSiteWise {
|
|
2854
2998
|
export type Interval = string;
|
2855
2999
|
export type IntervalInSeconds = number;
|
2856
3000
|
export type IntervalWindowInSeconds = number;
|
3001
|
+
export interface JobConfiguration {
|
3002
|
+
/**
|
3003
|
+
* The file format of the data in Amazon S3.
|
3004
|
+
*/
|
3005
|
+
fileFormat: FileFormat;
|
3006
|
+
}
|
3007
|
+
export type JobStatus = "PENDING"|"CANCELLED"|"RUNNING"|"COMPLETED"|"FAILED"|"COMPLETED_WITH_FAILURES"|string;
|
3008
|
+
export type JobSummaries = JobSummary[];
|
3009
|
+
export interface JobSummary {
|
3010
|
+
/**
|
3011
|
+
* The ID of the job.
|
3012
|
+
*/
|
3013
|
+
id: ID;
|
3014
|
+
/**
|
3015
|
+
* The unique name that helps identify the job request.
|
3016
|
+
*/
|
3017
|
+
name: Name;
|
3018
|
+
/**
|
3019
|
+
* The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
|
3020
|
+
*/
|
3021
|
+
status: JobStatus;
|
3022
|
+
}
|
2857
3023
|
export type KmsKeyId = string;
|
2858
3024
|
export interface ListAccessPoliciesRequest {
|
2859
3025
|
/**
|
@@ -3004,6 +3170,31 @@ declare namespace IoTSiteWise {
|
|
3004
3170
|
*/
|
3005
3171
|
nextToken?: NextToken;
|
3006
3172
|
}
|
3173
|
+
export type ListBulkImportJobsFilter = "ALL"|"PENDING"|"RUNNING"|"CANCELLED"|"FAILED"|"COMPLETED_WITH_FAILURES"|"COMPLETED"|string;
|
3174
|
+
export interface ListBulkImportJobsRequest {
|
3175
|
+
/**
|
3176
|
+
* The token to be used for the next set of paginated results.
|
3177
|
+
*/
|
3178
|
+
nextToken?: NextToken;
|
3179
|
+
/**
|
3180
|
+
* The maximum number of results to return for each paginated request.
|
3181
|
+
*/
|
3182
|
+
maxResults?: MaxResults;
|
3183
|
+
/**
|
3184
|
+
* You can use a filter to select the bulk import jobs that you want to retrieve.
|
3185
|
+
*/
|
3186
|
+
filter?: ListBulkImportJobsFilter;
|
3187
|
+
}
|
3188
|
+
export interface ListBulkImportJobsResponse {
|
3189
|
+
/**
|
3190
|
+
* One or more job summaries to list.
|
3191
|
+
*/
|
3192
|
+
jobSummaries: JobSummaries;
|
3193
|
+
/**
|
3194
|
+
* The token for the next set of results, or null if there are no additional results.
|
3195
|
+
*/
|
3196
|
+
nextToken?: NextToken;
|
3197
|
+
}
|
3007
3198
|
export interface ListDashboardsRequest {
|
3008
3199
|
/**
|
3009
3200
|
* The ID of the project.
|
@@ -3495,6 +3686,7 @@ declare namespace IoTSiteWise {
|
|
3495
3686
|
}
|
3496
3687
|
export type SSOApplicationId = string;
|
3497
3688
|
export type StorageType = "SITEWISE_DEFAULT_STORAGE"|"MULTI_LAYER_STORAGE"|string;
|
3689
|
+
export type String = string;
|
3498
3690
|
export type TagKey = string;
|
3499
3691
|
export type TagKeyList = TagKey[];
|
3500
3692
|
export type TagMap = {[key: string]: TagValue};
|
@@ -60,11 +60,11 @@ declare class Kendra extends Service {
|
|
60
60
|
*/
|
61
61
|
clearQuerySuggestions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
62
62
|
/**
|
63
|
-
* Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from
|
63
|
+
* Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
|
64
64
|
*/
|
65
65
|
createAccessControlConfiguration(params: Kendra.Types.CreateAccessControlConfigurationRequest, callback?: (err: AWSError, data: Kendra.Types.CreateAccessControlConfigurationResponse) => void): Request<Kendra.Types.CreateAccessControlConfigurationResponse, AWSError>;
|
66
66
|
/**
|
67
|
-
* Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from
|
67
|
+
* Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
|
68
68
|
*/
|
69
69
|
createAccessControlConfiguration(callback?: (err: AWSError, data: Kendra.Types.CreateAccessControlConfigurationResponse) => void): Request<Kendra.Types.CreateAccessControlConfigurationResponse, AWSError>;
|
70
70
|
/**
|
@@ -436,11 +436,11 @@ declare class Kendra extends Service {
|
|
436
436
|
*/
|
437
437
|
untagResource(callback?: (err: AWSError, data: Kendra.Types.UntagResourceResponse) => void): Request<Kendra.Types.UntagResourceResponse, AWSError>;
|
438
438
|
/**
|
439
|
-
* Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the
|
439
|
+
* Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
|
440
440
|
*/
|
441
441
|
updateAccessControlConfiguration(params: Kendra.Types.UpdateAccessControlConfigurationRequest, callback?: (err: AWSError, data: Kendra.Types.UpdateAccessControlConfigurationResponse) => void): Request<Kendra.Types.UpdateAccessControlConfigurationResponse, AWSError>;
|
442
442
|
/**
|
443
|
-
* Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the
|
443
|
+
* Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
|
444
444
|
*/
|
445
445
|
updateAccessControlConfiguration(callback?: (err: AWSError, data: Kendra.Types.UpdateAccessControlConfigurationResponse) => void): Request<Kendra.Types.UpdateAccessControlConfigurationResponse, AWSError>;
|
446
446
|
/**
|
@@ -3165,7 +3165,7 @@ declare namespace Kendra {
|
|
3165
3165
|
*/
|
3166
3166
|
IndexId: IndexId;
|
3167
3167
|
/**
|
3168
|
-
* If the previous response was incomplete (because there
|
3168
|
+
* If the previous response was incomplete (because there's more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of access control configurations.
|
3169
3169
|
*/
|
3170
3170
|
NextToken?: String;
|
3171
3171
|
/**
|
@@ -3175,7 +3175,7 @@ declare namespace Kendra {
|
|
3175
3175
|
}
|
3176
3176
|
export interface ListAccessControlConfigurationsResponse {
|
3177
3177
|
/**
|
3178
|
-
* If the response is truncated, Amazon Kendra returns this token
|
3178
|
+
* If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.
|
3179
3179
|
*/
|
3180
3180
|
NextToken?: String;
|
3181
3181
|
/**
|
@@ -4218,7 +4218,7 @@ declare namespace Kendra {
|
|
4218
4218
|
*/
|
4219
4219
|
Urls: SharePointUrlList;
|
4220
4220
|
/**
|
4221
|
-
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.
|
4221
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Authentication for a SharePoint data source.
|
4222
4222
|
*/
|
4223
4223
|
SecretArn: SecretArn;
|
4224
4224
|
/**
|
@@ -4257,7 +4257,12 @@ declare namespace Kendra {
|
|
4257
4257
|
* The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint.
|
4258
4258
|
*/
|
4259
4259
|
SslCertificateS3Path?: S3Path;
|
4260
|
+
/**
|
4261
|
+
* Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.
|
4262
|
+
*/
|
4263
|
+
AuthenticationType?: SharePointOnlineAuthenticationType;
|
4260
4264
|
}
|
4265
|
+
export type SharePointOnlineAuthenticationType = "HTTP_BASIC"|"OAUTH2"|string;
|
4261
4266
|
export type SharePointUrlList = Url[];
|
4262
4267
|
export type SharePointVersion = "SHAREPOINT_2013"|"SHAREPOINT_2016"|"SHAREPOINT_ONLINE"|string;
|
4263
4268
|
export type SharedDriveId = string;
|
@@ -367,8 +367,29 @@ declare namespace NetworkFirewall {
|
|
367
367
|
export type AzSubnet = string;
|
368
368
|
export type AzSubnets = AzSubnet[];
|
369
369
|
export type Boolean = boolean;
|
370
|
+
export type CIDRCount = number;
|
371
|
+
export interface CIDRSummary {
|
372
|
+
/**
|
373
|
+
* The number of CIDR blocks available for use by the IP set references in a firewall.
|
374
|
+
*/
|
375
|
+
AvailableCIDRCount?: CIDRCount;
|
376
|
+
/**
|
377
|
+
* The number of CIDR blocks used by the IP set references in a firewall.
|
378
|
+
*/
|
379
|
+
UtilizedCIDRCount?: CIDRCount;
|
380
|
+
/**
|
381
|
+
* The list of the IP set references used by a firewall.
|
382
|
+
*/
|
383
|
+
IPSetReferences?: IPSetMetadataMap;
|
384
|
+
}
|
385
|
+
export interface CapacityUsageSummary {
|
386
|
+
/**
|
387
|
+
* Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
|
388
|
+
*/
|
389
|
+
CIDRs?: CIDRSummary;
|
390
|
+
}
|
370
391
|
export type CollectionMember_String = string;
|
371
|
-
export type ConfigurationSyncState = "PENDING"|"IN_SYNC"|string;
|
392
|
+
export type ConfigurationSyncState = "PENDING"|"IN_SYNC"|"CAPACITY_CONSTRAINED"|string;
|
372
393
|
export interface CreateFirewallPolicyRequest {
|
373
394
|
/**
|
374
395
|
* The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
|
@@ -942,6 +963,10 @@ declare namespace NetworkFirewall {
|
|
942
963
|
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and configuration object.
|
943
964
|
*/
|
944
965
|
SyncStates?: SyncStates;
|
966
|
+
/**
|
967
|
+
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
|
968
|
+
*/
|
969
|
+
CapacityUsageSummary?: CapacityUsageSummary;
|
945
970
|
}
|
946
971
|
export type FirewallStatusValue = "PROVISIONING"|"DELETING"|"READY"|string;
|
947
972
|
export type Firewalls = FirewallMetadata[];
|
@@ -981,6 +1006,22 @@ declare namespace NetworkFirewall {
|
|
981
1006
|
*/
|
982
1007
|
Definition: VariableDefinitionList;
|
983
1008
|
}
|
1009
|
+
export type IPSetArn = string;
|
1010
|
+
export interface IPSetMetadata {
|
1011
|
+
/**
|
1012
|
+
* Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
|
1013
|
+
*/
|
1014
|
+
ResolvedCIDRCount?: CIDRCount;
|
1015
|
+
}
|
1016
|
+
export type IPSetMetadataMap = {[key: string]: IPSetMetadata};
|
1017
|
+
export interface IPSetReference {
|
1018
|
+
/**
|
1019
|
+
* The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
|
1020
|
+
*/
|
1021
|
+
ReferenceArn?: ResourceArn;
|
1022
|
+
}
|
1023
|
+
export type IPSetReferenceMap = {[key: string]: IPSetReference};
|
1024
|
+
export type IPSetReferenceName = string;
|
984
1025
|
export type IPSets = {[key: string]: IPSet};
|
985
1026
|
export type KeyId = string;
|
986
1027
|
export type Keyword = string;
|
@@ -1149,7 +1190,7 @@ declare namespace NetworkFirewall {
|
|
1149
1190
|
*/
|
1150
1191
|
UpdateToken?: UpdateToken;
|
1151
1192
|
}
|
1152
|
-
export type PerObjectSyncStatus = "PENDING"|"IN_SYNC"|string;
|
1193
|
+
export type PerObjectSyncStatus = "PENDING"|"IN_SYNC"|"CAPACITY_CONSTRAINED"|string;
|
1153
1194
|
export type PolicyString = string;
|
1154
1195
|
export type Port = string;
|
1155
1196
|
export interface PortRange {
|
@@ -1192,6 +1233,12 @@ declare namespace NetworkFirewall {
|
|
1192
1233
|
}
|
1193
1234
|
export interface PutResourcePolicyResponse {
|
1194
1235
|
}
|
1236
|
+
export interface ReferenceSets {
|
1237
|
+
/**
|
1238
|
+
* The list of IP set references.
|
1239
|
+
*/
|
1240
|
+
IPSetReferences?: IPSetReferenceMap;
|
1241
|
+
}
|
1195
1242
|
export type ResourceArn = string;
|
1196
1243
|
export type ResourceId = string;
|
1197
1244
|
export type ResourceManagedStatus = "MANAGED"|"ACCOUNT"|string;
|
@@ -1214,6 +1261,10 @@ declare namespace NetworkFirewall {
|
|
1214
1261
|
* Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups.
|
1215
1262
|
*/
|
1216
1263
|
RuleVariables?: RuleVariables;
|
1264
|
+
/**
|
1265
|
+
* The list of a rule group's reference sets.
|
1266
|
+
*/
|
1267
|
+
ReferenceSets?: ReferenceSets;
|
1217
1268
|
/**
|
1218
1269
|
* The stateful rules or stateless rules for the rule group.
|
1219
1270
|
*/
|