cdk-lambda-subminute 2.0.235 → 2.0.237
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 +13 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +276 -79
- package/node_modules/aws-sdk/apis/drs-2020-02-26.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +140 -82
- package/node_modules/aws-sdk/apis/eventbridge-2015-10-07.min.json +83 -58
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +101 -74
- package/node_modules/aws-sdk/apis/guardduty-2017-11-28.min.json +3 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +10 -4
- package/node_modules/aws-sdk/apis/xray-2016-04-12.min.json +3 -0
- package/node_modules/aws-sdk/clients/cloud9.d.ts +1 -1
- package/node_modules/aws-sdk/clients/drs.d.ts +215 -0
- package/node_modules/aws-sdk/clients/ec2.d.ts +66 -0
- package/node_modules/aws-sdk/clients/eventbridge.d.ts +13 -9
- package/node_modules/aws-sdk/clients/firehose.d.ts +38 -7
- package/node_modules/aws-sdk/clients/guardduty.d.ts +29 -24
- package/node_modules/aws-sdk/clients/kendra.d.ts +33 -29
- package/node_modules/aws-sdk/clients/xray.d.ts +4 -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 +9 -9
- package/node_modules/aws-sdk/dist/aws-sdk.js +247 -159
- 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
@@ -12,11 +12,11 @@ declare class Firehose extends Service {
|
|
12
12
|
constructor(options?: Firehose.Types.ClientConfiguration)
|
13
13
|
config: Config & Firehose.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination
|
15
|
+
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
|
16
16
|
*/
|
17
17
|
createDeliveryStream(params: Firehose.Types.CreateDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
|
18
18
|
/**
|
19
|
-
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination
|
19
|
+
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
|
20
20
|
*/
|
21
21
|
createDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
|
22
22
|
/**
|
@@ -100,11 +100,11 @@ declare class Firehose extends Service {
|
|
100
100
|
*/
|
101
101
|
untagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.UntagDeliveryStreamOutput) => void): Request<Firehose.Types.UntagDeliveryStreamOutput, AWSError>;
|
102
102
|
/**
|
103
|
-
* Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon
|
103
|
+
* Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
|
104
104
|
*/
|
105
105
|
updateDestination(params: Firehose.Types.UpdateDestinationInput, callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
|
106
106
|
/**
|
107
|
-
* Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon
|
107
|
+
* Updates the specified destination of the specified delivery stream. Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified. Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
|
108
108
|
*/
|
109
109
|
updateDestination(callback?: (err: AWSError, data: Firehose.Types.UpdateDestinationOutput) => void): Request<Firehose.Types.UpdateDestinationOutput, AWSError>;
|
110
110
|
}
|
@@ -155,7 +155,7 @@ declare namespace Firehose {
|
|
155
155
|
}
|
156
156
|
export interface AmazonOpenSearchServerlessDestinationDescription {
|
157
157
|
/**
|
158
|
-
* The Amazon Resource Name (ARN) of the
|
158
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
|
159
159
|
*/
|
160
160
|
RoleARN?: RoleARN;
|
161
161
|
/**
|
@@ -271,6 +271,10 @@ declare namespace Firehose {
|
|
271
271
|
ProcessingConfiguration?: ProcessingConfiguration;
|
272
272
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
273
273
|
VpcConfiguration?: VpcConfiguration;
|
274
|
+
/**
|
275
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
276
|
+
*/
|
277
|
+
DocumentIdOptions?: DocumentIdOptions;
|
274
278
|
}
|
275
279
|
export interface AmazonopensearchserviceDestinationDescription {
|
276
280
|
/**
|
@@ -313,6 +317,10 @@ declare namespace Firehose {
|
|
313
317
|
ProcessingConfiguration?: ProcessingConfiguration;
|
314
318
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
315
319
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
320
|
+
/**
|
321
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
322
|
+
*/
|
323
|
+
DocumentIdOptions?: DocumentIdOptions;
|
316
324
|
}
|
317
325
|
export interface AmazonopensearchserviceDestinationUpdate {
|
318
326
|
/**
|
@@ -350,6 +358,10 @@ declare namespace Firehose {
|
|
350
358
|
S3Update?: S3DestinationUpdate;
|
351
359
|
ProcessingConfiguration?: ProcessingConfiguration;
|
352
360
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
361
|
+
/**
|
362
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
363
|
+
*/
|
364
|
+
DocumentIdOptions?: DocumentIdOptions;
|
353
365
|
}
|
354
366
|
export type AmazonopensearchserviceDomainARN = string;
|
355
367
|
export type AmazonopensearchserviceIndexName = string;
|
@@ -490,6 +502,7 @@ declare namespace Firehose {
|
|
490
502
|
}
|
491
503
|
export type DataTableColumns = string;
|
492
504
|
export type DataTableName = string;
|
505
|
+
export type DefaultDocumentIdFormat = "FIREHOSE_DEFAULT"|"NO_DOCUMENT_ID"|string;
|
493
506
|
export interface DeleteDeliveryStreamInput {
|
494
507
|
/**
|
495
508
|
* The name of the delivery stream.
|
@@ -660,6 +673,12 @@ declare namespace Firehose {
|
|
660
673
|
}
|
661
674
|
export type DestinationDescriptionList = DestinationDescription[];
|
662
675
|
export type DestinationId = string;
|
676
|
+
export interface DocumentIdOptions {
|
677
|
+
/**
|
678
|
+
* When the FIREHOSE_DEFAULT option is chosen, Kinesis Data Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs. When the NO_DOCUMENT_ID option is chosen, Kinesis Data Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
|
679
|
+
*/
|
680
|
+
DefaultDocumentIdFormat: DefaultDocumentIdFormat;
|
681
|
+
}
|
663
682
|
export interface DynamicPartitioningConfiguration {
|
664
683
|
/**
|
665
684
|
* The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
|
@@ -733,9 +752,13 @@ declare namespace Firehose {
|
|
733
752
|
*/
|
734
753
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
735
754
|
/**
|
736
|
-
* The details of the VPC of the Amazon
|
755
|
+
* The details of the VPC of the Amazon destination.
|
737
756
|
*/
|
738
757
|
VpcConfiguration?: VpcConfiguration;
|
758
|
+
/**
|
759
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
760
|
+
*/
|
761
|
+
DocumentIdOptions?: DocumentIdOptions;
|
739
762
|
}
|
740
763
|
export interface ElasticsearchDestinationDescription {
|
741
764
|
/**
|
@@ -787,9 +810,13 @@ declare namespace Firehose {
|
|
787
810
|
*/
|
788
811
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
789
812
|
/**
|
790
|
-
* The details of the VPC of the Amazon
|
813
|
+
* The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
|
791
814
|
*/
|
792
815
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
816
|
+
/**
|
817
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
818
|
+
*/
|
819
|
+
DocumentIdOptions?: DocumentIdOptions;
|
793
820
|
}
|
794
821
|
export interface ElasticsearchDestinationUpdate {
|
795
822
|
/**
|
@@ -836,6 +863,10 @@ declare namespace Firehose {
|
|
836
863
|
* The CloudWatch logging options for your delivery stream.
|
837
864
|
*/
|
838
865
|
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
866
|
+
/**
|
867
|
+
* Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
|
868
|
+
*/
|
869
|
+
DocumentIdOptions?: DocumentIdOptions;
|
839
870
|
}
|
840
871
|
export type ElasticsearchDomainARN = string;
|
841
872
|
export type ElasticsearchIndexName = string;
|
@@ -180,11 +180,11 @@ declare class GuardDuty extends Service {
|
|
180
180
|
*/
|
181
181
|
describePublishingDestination(callback?: (err: AWSError, data: GuardDuty.Types.DescribePublishingDestinationResponse) => void): Request<GuardDuty.Types.DescribePublishingDestinationResponse, AWSError>;
|
182
182
|
/**
|
183
|
-
*
|
183
|
+
* Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.
|
184
184
|
*/
|
185
185
|
disableOrganizationAdminAccount(params: GuardDuty.Types.DisableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisableOrganizationAdminAccountResponse) => void): Request<GuardDuty.Types.DisableOrganizationAdminAccountResponse, AWSError>;
|
186
186
|
/**
|
187
|
-
*
|
187
|
+
* Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.
|
188
188
|
*/
|
189
189
|
disableOrganizationAdminAccount(callback?: (err: AWSError, data: GuardDuty.Types.DisableOrganizationAdminAccountResponse) => void): Request<GuardDuty.Types.DisableOrganizationAdminAccountResponse, AWSError>;
|
190
190
|
/**
|
@@ -204,27 +204,27 @@ declare class GuardDuty extends Service {
|
|
204
204
|
*/
|
205
205
|
disassociateFromMasterAccount(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateFromMasterAccountResponse) => void): Request<GuardDuty.Types.DisassociateFromMasterAccountResponse, AWSError>;
|
206
206
|
/**
|
207
|
-
* Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your
|
207
|
+
* Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.
|
208
208
|
*/
|
209
209
|
disassociateMembers(params: GuardDuty.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request<GuardDuty.Types.DisassociateMembersResponse, AWSError>;
|
210
210
|
/**
|
211
|
-
* Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your
|
211
|
+
* Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.
|
212
212
|
*/
|
213
213
|
disassociateMembers(callback?: (err: AWSError, data: GuardDuty.Types.DisassociateMembersResponse) => void): Request<GuardDuty.Types.DisassociateMembersResponse, AWSError>;
|
214
214
|
/**
|
215
|
-
*
|
215
|
+
* Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.
|
216
216
|
*/
|
217
217
|
enableOrganizationAdminAccount(params: GuardDuty.Types.EnableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.EnableOrganizationAdminAccountResponse) => void): Request<GuardDuty.Types.EnableOrganizationAdminAccountResponse, AWSError>;
|
218
218
|
/**
|
219
|
-
*
|
219
|
+
* Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.
|
220
220
|
*/
|
221
221
|
enableOrganizationAdminAccount(callback?: (err: AWSError, data: GuardDuty.Types.EnableOrganizationAdminAccountResponse) => void): Request<GuardDuty.Types.EnableOrganizationAdminAccountResponse, AWSError>;
|
222
222
|
/**
|
223
|
-
* Provides the details
|
223
|
+
* Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account. If the organization's management account or a delegated administrator runs this API, it will return success (HTTP 200) but no content.
|
224
224
|
*/
|
225
225
|
getAdministratorAccount(params: GuardDuty.Types.GetAdministratorAccountRequest, callback?: (err: AWSError, data: GuardDuty.Types.GetAdministratorAccountResponse) => void): Request<GuardDuty.Types.GetAdministratorAccountResponse, AWSError>;
|
226
226
|
/**
|
227
|
-
* Provides the details
|
227
|
+
* Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account. If the organization's management account or a delegated administrator runs this API, it will return success (HTTP 200) but no content.
|
228
228
|
*/
|
229
229
|
getAdministratorAccount(callback?: (err: AWSError, data: GuardDuty.Types.GetAdministratorAccountResponse) => void): Request<GuardDuty.Types.GetAdministratorAccountResponse, AWSError>;
|
230
230
|
/**
|
@@ -340,11 +340,11 @@ declare class GuardDuty extends Service {
|
|
340
340
|
*/
|
341
341
|
getUsageStatistics(callback?: (err: AWSError, data: GuardDuty.Types.GetUsageStatisticsResponse) => void): Request<GuardDuty.Types.GetUsageStatisticsResponse, AWSError>;
|
342
342
|
/**
|
343
|
-
* Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using
|
343
|
+
* Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using organizations to manager your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations. To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation. After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.
|
344
344
|
*/
|
345
345
|
inviteMembers(params: GuardDuty.Types.InviteMembersRequest, callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request<GuardDuty.Types.InviteMembersResponse, AWSError>;
|
346
346
|
/**
|
347
|
-
* Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using
|
347
|
+
* Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using organizations to manager your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations. To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation. After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.
|
348
348
|
*/
|
349
349
|
inviteMembers(callback?: (err: AWSError, data: GuardDuty.Types.InviteMembersResponse) => void): Request<GuardDuty.Types.InviteMembersResponse, AWSError>;
|
350
350
|
/**
|
@@ -404,11 +404,11 @@ declare class GuardDuty extends Service {
|
|
404
404
|
*/
|
405
405
|
listMembers(callback?: (err: AWSError, data: GuardDuty.Types.ListMembersResponse) => void): Request<GuardDuty.Types.ListMembersResponse, AWSError>;
|
406
406
|
/**
|
407
|
-
* Lists the accounts configured as GuardDuty delegated administrators.
|
407
|
+
* Lists the accounts configured as GuardDuty delegated administrators. Only the organization's management account can run this API operation.
|
408
408
|
*/
|
409
409
|
listOrganizationAdminAccounts(params: GuardDuty.Types.ListOrganizationAdminAccountsRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListOrganizationAdminAccountsResponse) => void): Request<GuardDuty.Types.ListOrganizationAdminAccountsResponse, AWSError>;
|
410
410
|
/**
|
411
|
-
* Lists the accounts configured as GuardDuty delegated administrators.
|
411
|
+
* Lists the accounts configured as GuardDuty delegated administrators. Only the organization's management account can run this API operation.
|
412
412
|
*/
|
413
413
|
listOrganizationAdminAccounts(callback?: (err: AWSError, data: GuardDuty.Types.ListOrganizationAdminAccountsResponse) => void): Request<GuardDuty.Types.ListOrganizationAdminAccountsResponse, AWSError>;
|
414
414
|
/**
|
@@ -420,11 +420,11 @@ declare class GuardDuty extends Service {
|
|
420
420
|
*/
|
421
421
|
listPublishingDestinations(callback?: (err: AWSError, data: GuardDuty.Types.ListPublishingDestinationsResponse) => void): Request<GuardDuty.Types.ListPublishingDestinationsResponse, AWSError>;
|
422
422
|
/**
|
423
|
-
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per
|
423
|
+
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
|
424
424
|
*/
|
425
425
|
listTagsForResource(params: GuardDuty.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: GuardDuty.Types.ListTagsForResourceResponse) => void): Request<GuardDuty.Types.ListTagsForResourceResponse, AWSError>;
|
426
426
|
/**
|
427
|
-
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per
|
427
|
+
* Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
|
428
428
|
*/
|
429
429
|
listTagsForResource(callback?: (err: AWSError, data: GuardDuty.Types.ListTagsForResourceResponse) => void): Request<GuardDuty.Types.ListTagsForResourceResponse, AWSError>;
|
430
430
|
/**
|
@@ -532,11 +532,11 @@ declare class GuardDuty extends Service {
|
|
532
532
|
*/
|
533
533
|
updateMemberDetectors(callback?: (err: AWSError, data: GuardDuty.Types.UpdateMemberDetectorsResponse) => void): Request<GuardDuty.Types.UpdateMemberDetectorsResponse, AWSError>;
|
534
534
|
/**
|
535
|
-
* Configures the delegated administrator account with the provided values. You must provide
|
535
|
+
* Configures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
|
536
536
|
*/
|
537
537
|
updateOrganizationConfiguration(params: GuardDuty.Types.UpdateOrganizationConfigurationRequest, callback?: (err: AWSError, data: GuardDuty.Types.UpdateOrganizationConfigurationResponse) => void): Request<GuardDuty.Types.UpdateOrganizationConfigurationResponse, AWSError>;
|
538
538
|
/**
|
539
|
-
* Configures the delegated administrator account with the provided values. You must provide
|
539
|
+
* Configures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
|
540
540
|
*/
|
541
541
|
updateOrganizationConfiguration(callback?: (err: AWSError, data: GuardDuty.Types.UpdateOrganizationConfigurationResponse) => void): Request<GuardDuty.Types.UpdateOrganizationConfigurationResponse, AWSError>;
|
542
542
|
/**
|
@@ -940,6 +940,10 @@ declare namespace GuardDuty {
|
|
940
940
|
* Information about the installed EKS add-on.
|
941
941
|
*/
|
942
942
|
AddonDetails?: AddonDetails;
|
943
|
+
/**
|
944
|
+
* Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster. AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource. MANUAL indicates that you are responsible to deploy, update, and manage the Amazon EKS add-on GuardDuty agent for this resource.
|
945
|
+
*/
|
946
|
+
ManagementType?: ManagementType;
|
943
947
|
}
|
944
948
|
export interface CoverageFilterCondition {
|
945
949
|
/**
|
@@ -967,7 +971,7 @@ declare namespace GuardDuty {
|
|
967
971
|
*/
|
968
972
|
FilterCondition?: CoverageFilterCondition;
|
969
973
|
}
|
970
|
-
export type CoverageFilterCriterionKey = "ACCOUNT_ID"|"CLUSTER_NAME"|"RESOURCE_TYPE"|"COVERAGE_STATUS"|"ADDON_VERSION"|string;
|
974
|
+
export type CoverageFilterCriterionKey = "ACCOUNT_ID"|"CLUSTER_NAME"|"RESOURCE_TYPE"|"COVERAGE_STATUS"|"ADDON_VERSION"|"MANAGEMENT_TYPE"|string;
|
971
975
|
export type CoverageFilterCriterionList = CoverageFilterCriterion[];
|
972
976
|
export interface CoverageResource {
|
973
977
|
/**
|
@@ -1491,7 +1495,7 @@ declare namespace GuardDuty {
|
|
1491
1495
|
*/
|
1492
1496
|
NextToken?: String;
|
1493
1497
|
/**
|
1494
|
-
* Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. ALL: Indicates that all accounts in the
|
1498
|
+
* Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
|
1495
1499
|
*/
|
1496
1500
|
AutoEnableOrganizationMembers?: AutoEnableMembers;
|
1497
1501
|
}
|
@@ -2986,6 +2990,7 @@ declare namespace GuardDuty {
|
|
2986
2990
|
*/
|
2987
2991
|
ScanEc2InstanceWithFindings?: DataSourceFreeTrial;
|
2988
2992
|
}
|
2993
|
+
export type ManagementType = "AUTO_MANAGED"|"MANUAL"|string;
|
2989
2994
|
export type MapEquals = ScanConditionPair[];
|
2990
2995
|
export interface Master {
|
2991
2996
|
/**
|
@@ -3222,7 +3227,7 @@ declare namespace GuardDuty {
|
|
3222
3227
|
*/
|
3223
3228
|
Name?: OrgFeatureAdditionalConfiguration;
|
3224
3229
|
/**
|
3225
|
-
* The status of the additional configuration that will be configured for the organization.
|
3230
|
+
* The status of the additional configuration that will be configured for the organization. Use one of the following values to configure the feature status for the entire organization: NEW: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically. ALL: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24 hours to update the configuration for all the member accounts. NONE: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.
|
3226
3231
|
*/
|
3227
3232
|
AutoEnable?: OrgFeatureStatus;
|
3228
3233
|
}
|
@@ -3232,7 +3237,7 @@ declare namespace GuardDuty {
|
|
3232
3237
|
*/
|
3233
3238
|
Name?: OrgFeatureAdditionalConfiguration;
|
3234
3239
|
/**
|
3235
|
-
* Describes
|
3240
|
+
* Describes the status of the additional configuration that is configured for the member accounts within the organization. One of the following values is the status for the entire organization: NEW: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically. ALL: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24 hours to update the configuration for all the member accounts. NONE: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.
|
3236
3241
|
*/
|
3237
3242
|
AutoEnable?: OrgFeatureStatus;
|
3238
3243
|
}
|
@@ -3284,7 +3289,7 @@ declare namespace GuardDuty {
|
|
3284
3289
|
*/
|
3285
3290
|
Name?: OrgFeature;
|
3286
3291
|
/**
|
3287
|
-
* The status of the feature that will be configured for the organization.
|
3292
|
+
* The status of the feature that will be configured for the organization. Use one of the following values to configure the feature status for the entire organization: NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically. ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24 hours to update the configuration for all the member accounts. NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.
|
3288
3293
|
*/
|
3289
3294
|
AutoEnable?: OrgFeatureStatus;
|
3290
3295
|
/**
|
@@ -3298,7 +3303,7 @@ declare namespace GuardDuty {
|
|
3298
3303
|
*/
|
3299
3304
|
Name?: OrgFeature;
|
3300
3305
|
/**
|
3301
|
-
* Describes
|
3306
|
+
* Describes the status of the feature that is configured for the member accounts within the organization. NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically. ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. NONE: Indicates that the feature will not be automatically enabled for any account in the organization. In this case, each account will be managed individually by the administrator.
|
3302
3307
|
*/
|
3303
3308
|
AutoEnable?: OrgFeatureStatus;
|
3304
3309
|
/**
|
@@ -4385,7 +4390,7 @@ declare namespace GuardDuty {
|
|
4385
4390
|
*/
|
4386
4391
|
DetectorId: DetectorId;
|
4387
4392
|
/**
|
4388
|
-
* Indicates whether to automatically enable member accounts in the organization. Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results.
|
4393
|
+
* Indicates whether to automatically enable member accounts in the organization. Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results. You must provide the value for either autoEnableOrganizationMembers or autoEnable.
|
4389
4394
|
*/
|
4390
4395
|
AutoEnable?: Boolean;
|
4391
4396
|
/**
|
@@ -4397,7 +4402,7 @@ declare namespace GuardDuty {
|
|
4397
4402
|
*/
|
4398
4403
|
Features?: OrganizationFeaturesConfigurations;
|
4399
4404
|
/**
|
4400
|
-
* Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization.
|
4405
|
+
* Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable. Use one of the following configuration values for autoEnableOrganizationMembers: NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. It may take up to 24 hours to update the configuration for all the member accounts. NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
|
4401
4406
|
*/
|
4402
4407
|
AutoEnableOrganizationMembers?: AutoEnableMembers;
|
4403
4408
|
}
|
@@ -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;
|