cdk-lambda-subminute 2.0.234 → 2.0.236
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-lambda-subminute.js +3 -3
- package/node_modules/aws-sdk/CHANGELOG.md +11 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +140 -82
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.examples.json +2 -2
- package/node_modules/aws-sdk/apis/ecr-2015-09-21.min.json +4 -0
- package/node_modules/aws-sdk/apis/eventbridge-2015-10-07.min.json +83 -58
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +10 -4
- package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +118 -11
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +462 -414
- package/node_modules/aws-sdk/clients/ec2.d.ts +66 -0
- package/node_modules/aws-sdk/clients/ecr.d.ts +5 -5
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +13 -9
- package/node_modules/aws-sdk/clients/kendra.d.ts +33 -29
- package/node_modules/aws-sdk/clients/medialive.d.ts +110 -0
- package/node_modules/aws-sdk/clients/quicksight.d.ts +68 -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 +7 -7
- package/node_modules/aws-sdk/dist/aws-sdk.js +147 -85
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +69 -69
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -2996,6 +2996,14 @@ declare class EC2 extends Service {
|
|
2996
2996
|
* Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
|
2997
2997
|
*/
|
2998
2998
|
disableFastSnapshotRestores(callback?: (err: AWSError, data: EC2.Types.DisableFastSnapshotRestoresResult) => void): Request<EC2.Types.DisableFastSnapshotRestoresResult, AWSError>;
|
2999
|
+
/**
|
3000
|
+
* Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region. The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing. When the API has completed the configuration, the response will be unblocked. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3001
|
+
*/
|
3002
|
+
disableImageBlockPublicAccess(params: EC2.Types.DisableImageBlockPublicAccessRequest, callback?: (err: AWSError, data: EC2.Types.DisableImageBlockPublicAccessResult) => void): Request<EC2.Types.DisableImageBlockPublicAccessResult, AWSError>;
|
3003
|
+
/**
|
3004
|
+
* Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region. The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing. When the API has completed the configuration, the response will be unblocked. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3005
|
+
*/
|
3006
|
+
disableImageBlockPublicAccess(callback?: (err: AWSError, data: EC2.Types.DisableImageBlockPublicAccessResult) => void): Request<EC2.Types.DisableImageBlockPublicAccessResult, AWSError>;
|
2999
3007
|
/**
|
3000
3008
|
* Cancels the deprecation of the specified AMI. For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
|
3001
3009
|
*/
|
@@ -3204,6 +3212,14 @@ declare class EC2 extends Service {
|
|
3204
3212
|
* Enables fast snapshot restores for the specified snapshots in the specified Availability Zones. You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores. For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
|
3205
3213
|
*/
|
3206
3214
|
enableFastSnapshotRestores(callback?: (err: AWSError, data: EC2.Types.EnableFastSnapshotRestoresResult) => void): Request<EC2.Types.EnableFastSnapshotRestoresResult, AWSError>;
|
3215
|
+
/**
|
3216
|
+
* Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available. The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3217
|
+
*/
|
3218
|
+
enableImageBlockPublicAccess(params: EC2.Types.EnableImageBlockPublicAccessRequest, callback?: (err: AWSError, data: EC2.Types.EnableImageBlockPublicAccessResult) => void): Request<EC2.Types.EnableImageBlockPublicAccessResult, AWSError>;
|
3219
|
+
/**
|
3220
|
+
* Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available. The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3221
|
+
*/
|
3222
|
+
enableImageBlockPublicAccess(callback?: (err: AWSError, data: EC2.Types.EnableImageBlockPublicAccessResult) => void): Request<EC2.Types.EnableImageBlockPublicAccessResult, AWSError>;
|
3207
3223
|
/**
|
3208
3224
|
* Enables deprecation of the specified AMI at the specified date and time. For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
|
3209
3225
|
*/
|
@@ -3412,6 +3428,14 @@ declare class EC2 extends Service {
|
|
3412
3428
|
* Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
|
3413
3429
|
*/
|
3414
3430
|
getHostReservationPurchasePreview(callback?: (err: AWSError, data: EC2.Types.GetHostReservationPurchasePreviewResult) => void): Request<EC2.Types.GetHostReservationPurchasePreviewResult, AWSError>;
|
3431
|
+
/**
|
3432
|
+
* Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3433
|
+
*/
|
3434
|
+
getImageBlockPublicAccessState(params: EC2.Types.GetImageBlockPublicAccessStateRequest, callback?: (err: AWSError, data: EC2.Types.GetImageBlockPublicAccessStateResult) => void): Request<EC2.Types.GetImageBlockPublicAccessStateResult, AWSError>;
|
3435
|
+
/**
|
3436
|
+
* Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
|
3437
|
+
*/
|
3438
|
+
getImageBlockPublicAccessState(callback?: (err: AWSError, data: EC2.Types.GetImageBlockPublicAccessStateResult) => void): Request<EC2.Types.GetImageBlockPublicAccessStateResult, AWSError>;
|
3415
3439
|
/**
|
3416
3440
|
* Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
|
3417
3441
|
*/
|
@@ -18072,6 +18096,18 @@ declare namespace EC2 {
|
|
18072
18096
|
*/
|
18073
18097
|
Unsuccessful?: DisableFastSnapshotRestoreErrorSet;
|
18074
18098
|
}
|
18099
|
+
export interface DisableImageBlockPublicAccessRequest {
|
18100
|
+
/**
|
18101
|
+
* Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
|
18102
|
+
*/
|
18103
|
+
DryRun?: Boolean;
|
18104
|
+
}
|
18105
|
+
export interface DisableImageBlockPublicAccessResult {
|
18106
|
+
/**
|
18107
|
+
* Returns unblocked if the request succeeds; otherwise, it returns an error.
|
18108
|
+
*/
|
18109
|
+
ImageBlockPublicAccessState?: ImageBlockPublicAccessDisabledState;
|
18110
|
+
}
|
18075
18111
|
export interface DisableImageDeprecationRequest {
|
18076
18112
|
/**
|
18077
18113
|
* The ID of the AMI.
|
@@ -19129,6 +19165,22 @@ declare namespace EC2 {
|
|
19129
19165
|
*/
|
19130
19166
|
Unsuccessful?: EnableFastSnapshotRestoreErrorSet;
|
19131
19167
|
}
|
19168
|
+
export interface EnableImageBlockPublicAccessRequest {
|
19169
|
+
/**
|
19170
|
+
* Specify block-new-sharing to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region.
|
19171
|
+
*/
|
19172
|
+
ImageBlockPublicAccessState: ImageBlockPublicAccessEnabledState;
|
19173
|
+
/**
|
19174
|
+
* Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
|
19175
|
+
*/
|
19176
|
+
DryRun?: Boolean;
|
19177
|
+
}
|
19178
|
+
export interface EnableImageBlockPublicAccessResult {
|
19179
|
+
/**
|
19180
|
+
* Returns block-new-sharing if the request succeeds; otherwise, it returns an error.
|
19181
|
+
*/
|
19182
|
+
ImageBlockPublicAccessState?: ImageBlockPublicAccessEnabledState;
|
19183
|
+
}
|
19132
19184
|
export interface EnableImageDeprecationRequest {
|
19133
19185
|
/**
|
19134
19186
|
* The ID of the AMI.
|
@@ -20824,6 +20876,18 @@ declare namespace EC2 {
|
|
20824
20876
|
*/
|
20825
20877
|
TotalUpfrontPrice?: String;
|
20826
20878
|
}
|
20879
|
+
export interface GetImageBlockPublicAccessStateRequest {
|
20880
|
+
/**
|
20881
|
+
* Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
|
20882
|
+
*/
|
20883
|
+
DryRun?: Boolean;
|
20884
|
+
}
|
20885
|
+
export interface GetImageBlockPublicAccessStateResult {
|
20886
|
+
/**
|
20887
|
+
* The current state of block public access for AMIs at the account level in the specified Amazon Web Services Region. Possible values: block-new-sharing - Any attempt to publicly share your AMIs in the specified Region is blocked. unblocked - Your AMIs in the specified Region can be publicly shared.
|
20888
|
+
*/
|
20889
|
+
ImageBlockPublicAccessState?: String;
|
20890
|
+
}
|
20827
20891
|
export interface GetInstanceTypesFromInstanceRequirementsRequest {
|
20828
20892
|
/**
|
20829
20893
|
* Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
|
@@ -22345,6 +22409,8 @@ declare namespace EC2 {
|
|
22345
22409
|
ImdsSupport?: AttributeValue;
|
22346
22410
|
}
|
22347
22411
|
export type ImageAttributeName = "description"|"kernel"|"ramdisk"|"launchPermission"|"productCodes"|"blockDeviceMapping"|"sriovNetSupport"|"bootMode"|"tpmSupport"|"uefiData"|"lastLaunchedTime"|"imdsSupport"|string;
|
22412
|
+
export type ImageBlockPublicAccessDisabledState = "unblocked"|string;
|
22413
|
+
export type ImageBlockPublicAccessEnabledState = "block-new-sharing"|string;
|
22348
22414
|
export interface ImageDiskContainer {
|
22349
22415
|
/**
|
22350
22416
|
* The description of the disk image.
|
@@ -593,7 +593,7 @@ declare namespace ECR {
|
|
593
593
|
*/
|
594
594
|
registryId?: RegistryId;
|
595
595
|
/**
|
596
|
-
* The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).
|
596
|
+
* The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
|
597
597
|
*/
|
598
598
|
repositoryName: RepositoryName;
|
599
599
|
/**
|
@@ -1832,7 +1832,7 @@ declare namespace ECR {
|
|
1832
1832
|
}
|
1833
1833
|
export interface RegistryScanningRule {
|
1834
1834
|
/**
|
1835
|
-
* The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH
|
1835
|
+
* The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.
|
1836
1836
|
*/
|
1837
1837
|
scanFrequency: ScanFrequency;
|
1838
1838
|
/**
|
@@ -1882,7 +1882,7 @@ declare namespace ECR {
|
|
1882
1882
|
export type ReplicationStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
|
1883
1883
|
export interface Repository {
|
1884
1884
|
/**
|
1885
|
-
* The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/
|
1885
|
+
* The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.
|
1886
1886
|
*/
|
1887
1887
|
repositoryArn?: Arn;
|
1888
1888
|
/**
|
@@ -2121,11 +2121,11 @@ declare namespace ECR {
|
|
2121
2121
|
/**
|
2122
2122
|
* One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
|
2123
2123
|
*/
|
2124
|
-
Key
|
2124
|
+
Key: TagKey;
|
2125
2125
|
/**
|
2126
2126
|
* A value acts as a descriptor within a tag category (key).
|
2127
2127
|
*/
|
2128
|
-
Value
|
2128
|
+
Value: TagValue;
|
2129
2129
|
}
|
2130
2130
|
export type TagKey = string;
|
2131
2131
|
export type TagKeyList = TagKey[];
|
@@ -557,6 +557,7 @@ declare namespace EventBridge {
|
|
557
557
|
export type Arn = string;
|
558
558
|
export type AssignPublicIp = "ENABLED"|"DISABLED"|string;
|
559
559
|
export type AuthHeaderParameters = string;
|
560
|
+
export type AuthHeaderParametersSensitive = string;
|
560
561
|
export interface AwsVpcConfiguration {
|
561
562
|
/**
|
562
563
|
* Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
|
@@ -728,7 +729,7 @@ declare namespace EventBridge {
|
|
728
729
|
/**
|
729
730
|
* The value associated with the key.
|
730
731
|
*/
|
731
|
-
Value?:
|
732
|
+
Value?: SensitiveString;
|
732
733
|
/**
|
733
734
|
* Specified whether the value is secret.
|
734
735
|
*/
|
@@ -744,7 +745,7 @@ declare namespace EventBridge {
|
|
744
745
|
/**
|
745
746
|
* The value associated with the key.
|
746
747
|
*/
|
747
|
-
Value?:
|
748
|
+
Value?: HeaderValueSensitive;
|
748
749
|
/**
|
749
750
|
* Specified whether the value is a secret.
|
750
751
|
*/
|
@@ -799,7 +800,7 @@ declare namespace EventBridge {
|
|
799
800
|
/**
|
800
801
|
* The value associated with the key for the query string parameter.
|
801
802
|
*/
|
802
|
-
Value?:
|
803
|
+
Value?: QueryStringValueSensitive;
|
803
804
|
/**
|
804
805
|
* Specifies whether the value is secret.
|
805
806
|
*/
|
@@ -901,7 +902,7 @@ declare namespace EventBridge {
|
|
901
902
|
/**
|
902
903
|
* The value for the API key to use for authorization.
|
903
904
|
*/
|
904
|
-
ApiKeyValue:
|
905
|
+
ApiKeyValue: AuthHeaderParametersSensitive;
|
905
906
|
}
|
906
907
|
export interface CreateConnectionAuthRequestParameters {
|
907
908
|
/**
|
@@ -929,7 +930,7 @@ declare namespace EventBridge {
|
|
929
930
|
/**
|
930
931
|
* The password associated with the user name to use for Basic authorization.
|
931
932
|
*/
|
932
|
-
Password:
|
933
|
+
Password: AuthHeaderParametersSensitive;
|
933
934
|
}
|
934
935
|
export interface CreateConnectionOAuthClientRequestParameters {
|
935
936
|
/**
|
@@ -939,7 +940,7 @@ declare namespace EventBridge {
|
|
939
940
|
/**
|
940
941
|
* The client secret associated with the client ID to use for OAuth authorization for the connection.
|
941
942
|
*/
|
942
|
-
ClientSecret:
|
943
|
+
ClientSecret: AuthHeaderParametersSensitive;
|
943
944
|
}
|
944
945
|
export interface CreateConnectionOAuthRequestParameters {
|
945
946
|
/**
|
@@ -1818,6 +1819,7 @@ declare namespace EventBridge {
|
|
1818
1819
|
export type HeaderKey = string;
|
1819
1820
|
export type HeaderParametersMap = {[key: string]: HeaderValue};
|
1820
1821
|
export type HeaderValue = string;
|
1822
|
+
export type HeaderValueSensitive = string;
|
1821
1823
|
export type HealthCheck = string;
|
1822
1824
|
export type HomeRegion = string;
|
1823
1825
|
export interface HttpParameters {
|
@@ -2507,6 +2509,7 @@ declare namespace EventBridge {
|
|
2507
2509
|
export type QueryStringKey = string;
|
2508
2510
|
export type QueryStringParametersMap = {[key: string]: QueryStringValue};
|
2509
2511
|
export type QueryStringValue = string;
|
2512
|
+
export type QueryStringValueSensitive = string;
|
2510
2513
|
export interface RedshiftDataParameters {
|
2511
2514
|
/**
|
2512
2515
|
* The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
|
@@ -2766,6 +2769,7 @@ declare namespace EventBridge {
|
|
2766
2769
|
Route: Route;
|
2767
2770
|
}
|
2768
2771
|
export type SecretsManagerSecretArn = string;
|
2772
|
+
export type SensitiveString = string;
|
2769
2773
|
export type Sql = string;
|
2770
2774
|
export type Sqls = Sql[];
|
2771
2775
|
export interface SqsParameters {
|
@@ -3041,7 +3045,7 @@ declare namespace EventBridge {
|
|
3041
3045
|
/**
|
3042
3046
|
* The value associated with teh API key to use for authorization.
|
3043
3047
|
*/
|
3044
|
-
ApiKeyValue?:
|
3048
|
+
ApiKeyValue?: AuthHeaderParametersSensitive;
|
3045
3049
|
}
|
3046
3050
|
export interface UpdateConnectionAuthRequestParameters {
|
3047
3051
|
/**
|
@@ -3069,7 +3073,7 @@ declare namespace EventBridge {
|
|
3069
3073
|
/**
|
3070
3074
|
* The password associated with the user name to use for Basic authorization.
|
3071
3075
|
*/
|
3072
|
-
Password?:
|
3076
|
+
Password?: AuthHeaderParametersSensitive;
|
3073
3077
|
}
|
3074
3078
|
export interface UpdateConnectionOAuthClientRequestParameters {
|
3075
3079
|
/**
|
@@ -3079,7 +3083,7 @@ declare namespace EventBridge {
|
|
3079
3083
|
/**
|
3080
3084
|
* The client secret assciated with the client ID to use for OAuth authorization.
|
3081
3085
|
*/
|
3082
|
-
ClientSecret?:
|
3086
|
+
ClientSecret?: AuthHeaderParametersSensitive;
|
3083
3087
|
}
|
3084
3088
|
export interface UpdateConnectionOAuthRequestParameters {
|
3085
3089
|
/**
|
@@ -28,11 +28,11 @@ declare class Kendra extends Service {
|
|
28
28
|
*/
|
29
29
|
associatePersonasToEntities(callback?: (err: AWSError, data: Kendra.Types.AssociatePersonasToEntitiesResponse) => void): Request<Kendra.Types.AssociatePersonasToEntitiesResponse, AWSError>;
|
30
30
|
/**
|
31
|
-
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to
|
31
|
+
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents. Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.
|
32
32
|
*/
|
33
33
|
batchDeleteDocument(params: Kendra.Types.BatchDeleteDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
34
34
|
/**
|
35
|
-
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to
|
35
|
+
* Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents. Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.
|
36
36
|
*/
|
37
37
|
batchDeleteDocument(callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
38
38
|
/**
|
@@ -52,11 +52,11 @@ declare class Kendra extends Service {
|
|
52
52
|
*/
|
53
53
|
batchGetDocumentStatus(callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
54
54
|
/**
|
55
|
-
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
55
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
56
56
|
*/
|
57
57
|
batchPutDocument(params: Kendra.Types.BatchPutDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
58
58
|
/**
|
59
|
-
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
59
|
+
* Adds one or more documents to an index. The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents. For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
|
60
60
|
*/
|
61
61
|
batchPutDocument(callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
62
62
|
/**
|
@@ -108,11 +108,11 @@ declare class Kendra extends Service {
|
|
108
108
|
*/
|
109
109
|
createFeaturedResultsSet(callback?: (err: AWSError, data: Kendra.Types.CreateFeaturedResultsSetResponse) => void): Request<Kendra.Types.CreateFeaturedResultsSetResponse, AWSError>;
|
110
110
|
/**
|
111
|
-
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
111
|
+
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
112
112
|
*/
|
113
113
|
createIndex(params: Kendra.Types.CreateIndexRequest, callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
114
114
|
/**
|
115
|
-
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
115
|
+
* Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
|
116
116
|
*/
|
117
117
|
createIndex(callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
118
118
|
/**
|
@@ -140,11 +140,11 @@ declare class Kendra extends Service {
|
|
140
140
|
*/
|
141
141
|
deleteAccessControlConfiguration(callback?: (err: AWSError, data: Kendra.Types.DeleteAccessControlConfigurationResponse) => void): Request<Kendra.Types.DeleteAccessControlConfigurationResponse, AWSError>;
|
142
142
|
/**
|
143
|
-
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
|
143
|
+
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources. Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
|
144
144
|
*/
|
145
145
|
deleteDataSource(params: Kendra.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
146
146
|
/**
|
147
|
-
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
|
147
|
+
* Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources. Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
|
148
148
|
*/
|
149
149
|
deleteDataSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
150
150
|
/**
|
@@ -428,19 +428,19 @@ declare class Kendra extends Service {
|
|
428
428
|
*/
|
429
429
|
query(callback?: (err: AWSError, data: Kendra.Types.QueryResult) => void): Request<Kendra.Types.QueryResult, AWSError>;
|
430
430
|
/**
|
431
|
-
* Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce
|
431
|
+
* Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses. You can also do the following: Override boosting at the index level Filter based on document fields or attributes Filter based on the user or their group access to documents You can also include certain fields in the response that might provide useful additional information. The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity.
|
432
432
|
*/
|
433
433
|
retrieve(params: Kendra.Types.RetrieveRequest, callback?: (err: AWSError, data: Kendra.Types.RetrieveResult) => void): Request<Kendra.Types.RetrieveResult, AWSError>;
|
434
434
|
/**
|
435
|
-
* Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce
|
435
|
+
* Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses. You can also do the following: Override boosting at the index level Filter based on document fields or attributes Filter based on the user or their group access to documents You can also include certain fields in the response that might provide useful additional information. The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity.
|
436
436
|
*/
|
437
437
|
retrieve(callback?: (err: AWSError, data: Kendra.Types.RetrieveResult) => void): Request<Kendra.Types.RetrieveResult, AWSError>;
|
438
438
|
/**
|
439
|
-
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
|
439
|
+
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
|
440
440
|
*/
|
441
441
|
startDataSourceSyncJob(params: Kendra.Types.StartDataSourceSyncJobRequest, callback?: (err: AWSError, data: Kendra.Types.StartDataSourceSyncJobResponse) => void): Request<Kendra.Types.StartDataSourceSyncJobResponse, AWSError>;
|
442
442
|
/**
|
443
|
-
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
|
443
|
+
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
|
444
444
|
*/
|
445
445
|
startDataSourceSyncJob(callback?: (err: AWSError, data: Kendra.Types.StartDataSourceSyncJobResponse) => void): Request<Kendra.Types.StartDataSourceSyncJobResponse, AWSError>;
|
446
446
|
/**
|
@@ -684,43 +684,43 @@ declare namespace Kendra {
|
|
684
684
|
}
|
685
685
|
export interface AttributeFilter {
|
686
686
|
/**
|
687
|
-
* Performs a logical AND operation on all
|
687
|
+
* Performs a logical AND operation on all filters that you specify.
|
688
688
|
*/
|
689
689
|
AndAllFilters?: AttributeFilterList;
|
690
690
|
/**
|
691
|
-
* Performs a logical OR operation on all
|
691
|
+
* Performs a logical OR operation on all filters that you specify.
|
692
692
|
*/
|
693
693
|
OrAllFilters?: AttributeFilterList;
|
694
694
|
/**
|
695
|
-
* Performs a logical NOT operation on all
|
695
|
+
* Performs a logical NOT operation on all filters that you specify.
|
696
696
|
*/
|
697
697
|
NotFilter?: AttributeFilter;
|
698
698
|
/**
|
699
|
-
* Performs an equals operation on
|
699
|
+
* Performs an equals operation on document attributes/fields and their values.
|
700
700
|
*/
|
701
701
|
EqualsTo?: DocumentAttribute;
|
702
702
|
/**
|
703
|
-
* Returns true when a document contains all of the specified document attributes
|
703
|
+
* Returns true when a document contains all of the specified document attributes/fields. This filter is only applicable to StringListValue.
|
704
704
|
*/
|
705
705
|
ContainsAll?: DocumentAttribute;
|
706
706
|
/**
|
707
|
-
* Returns true when a document contains any of the specified document attributes
|
707
|
+
* Returns true when a document contains any of the specified document attributes/fields. This filter is only applicable to StringListValue.
|
708
708
|
*/
|
709
709
|
ContainsAny?: DocumentAttribute;
|
710
710
|
/**
|
711
|
-
* Performs a greater than operation on
|
711
|
+
* Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.
|
712
712
|
*/
|
713
713
|
GreaterThan?: DocumentAttribute;
|
714
714
|
/**
|
715
|
-
* Performs a greater or equals than operation on
|
715
|
+
* Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.
|
716
716
|
*/
|
717
717
|
GreaterThanOrEquals?: DocumentAttribute;
|
718
718
|
/**
|
719
|
-
* Performs a less than operation on
|
719
|
+
* Performs a less than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.
|
720
720
|
*/
|
721
721
|
LessThan?: DocumentAttribute;
|
722
722
|
/**
|
723
|
-
* Performs a less than or equals operation on
|
723
|
+
* Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type Date or Long.
|
724
724
|
*/
|
725
725
|
LessThanOrEquals?: DocumentAttribute;
|
726
726
|
}
|
@@ -903,7 +903,7 @@ declare namespace Kendra {
|
|
903
903
|
}
|
904
904
|
export interface BatchPutDocumentResponse {
|
905
905
|
/**
|
906
|
-
* A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index. If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch
|
906
|
+
* A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index. If there was an error adding a document to an index the error is reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch logs.
|
907
907
|
*/
|
908
908
|
FailedDocuments?: BatchPutDocumentResponseFailedDocuments;
|
909
909
|
}
|
@@ -1786,15 +1786,15 @@ declare namespace Kendra {
|
|
1786
1786
|
export type DataSourceSyncJobStatus = "FAILED"|"SUCCEEDED"|"SYNCING"|"INCOMPLETE"|"STOPPING"|"ABORTED"|"SYNCING_INDEXING"|string;
|
1787
1787
|
export interface DataSourceToIndexFieldMapping {
|
1788
1788
|
/**
|
1789
|
-
* The name of the
|
1789
|
+
* The name of the field in the data source. You must first create the index field using the UpdateIndex API.
|
1790
1790
|
*/
|
1791
1791
|
DataSourceFieldName: DataSourceFieldName;
|
1792
1792
|
/**
|
1793
|
-
* The
|
1793
|
+
* The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.
|
1794
1794
|
*/
|
1795
1795
|
DateFieldFormat?: DataSourceDateFieldFormat;
|
1796
1796
|
/**
|
1797
|
-
* The name of the field
|
1797
|
+
* The name of the index field to map to the data source field. The index field type must match the data source field type.
|
1798
1798
|
*/
|
1799
1799
|
IndexFieldName: IndexFieldName;
|
1800
1800
|
}
|
@@ -2603,15 +2603,15 @@ declare namespace Kendra {
|
|
2603
2603
|
}
|
2604
2604
|
export interface DocumentAttributeValueCountPair {
|
2605
2605
|
/**
|
2606
|
-
* The value of the attribute. For example, "HR".
|
2606
|
+
* The value of the attribute/field. For example, "HR".
|
2607
2607
|
*/
|
2608
2608
|
DocumentAttributeValue?: DocumentAttributeValue;
|
2609
2609
|
/**
|
2610
|
-
* The number of documents in the response that have the attribute value for the key.
|
2610
|
+
* The number of documents in the response that have the attribute/field value for the key.
|
2611
2611
|
*/
|
2612
2612
|
Count?: Integer;
|
2613
2613
|
/**
|
2614
|
-
* Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
|
2614
|
+
* Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet. For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
|
2615
2615
|
*/
|
2616
2616
|
FacetResults?: FacetResultList;
|
2617
2617
|
}
|
@@ -4365,6 +4365,10 @@ declare namespace Kendra {
|
|
4365
4365
|
* An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
|
4366
4366
|
*/
|
4367
4367
|
DocumentAttributes?: DocumentAttributeList;
|
4368
|
+
/**
|
4369
|
+
* The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
|
4370
|
+
*/
|
4371
|
+
ScoreAttributes?: ScoreAttributes;
|
4368
4372
|
}
|
4369
4373
|
export type RetrieveResultItemList = RetrieveResultItem[];
|
4370
4374
|
export type RoleArn = string;
|