aws-sdk 2.1069.0 → 2.1073.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -1
- package/README.md +1 -1
- package/apis/apprunner-2020-05-15.min.json +171 -15
- package/apis/apprunner-2020-05-15.paginators.json +5 -0
- package/apis/auditmanager-2017-07-25.min.json +5 -1
- package/apis/cloudformation-2010-05-15.min.json +86 -25
- package/apis/kendra-2019-02-03.min.json +80 -55
- package/apis/lookoutvision-2020-11-20.min.json +0 -1
- package/apis/pinpoint-2016-12-01.min.json +2 -1
- package/apis/s3control-2018-08-20.min.json +152 -52
- package/apis/sagemaker-2017-07-24.min.json +123 -122
- package/apis/synthetics-2017-10-11.min.json +11 -3
- package/apis/wafv2-2019-07-29.min.json +216 -104
- package/clients/apprunner.d.ts +179 -12
- package/clients/auditmanager.d.ts +2 -2
- package/clients/cloudformation.d.ts +408 -265
- package/clients/eventbridge.d.ts +8 -8
- package/clients/kendra.d.ts +95 -59
- package/clients/lookoutvision.d.ts +4 -4
- package/clients/pinpoint.d.ts +4 -0
- package/clients/s3control.d.ts +137 -10
- package/clients/sagemaker.d.ts +6 -1
- package/clients/sns.d.ts +2 -2
- package/clients/ssmincidents.d.ts +1 -1
- package/clients/synthetics.d.ts +15 -5
- package/clients/wafv2.d.ts +155 -0
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +12 -12
- package/dist/aws-sdk.js +89 -28
- package/dist/aws-sdk.min.js +88 -88
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/kendra.d.ts
CHANGED
|
@@ -28,27 +28,27 @@ 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
|
|
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 you CloudWatch log.
|
|
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
|
|
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 you CloudWatch log.
|
|
36
36
|
*/
|
|
37
37
|
batchDeleteDocument(callback?: (err: AWSError, data: Kendra.Types.BatchDeleteDocumentResponse) => void): Request<Kendra.Types.BatchDeleteDocumentResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Returns the indexing status for one or more documents submitted with the BatchPutDocument
|
|
39
|
+
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
|
|
40
40
|
*/
|
|
41
41
|
batchGetDocumentStatus(params: Kendra.Types.BatchGetDocumentStatusRequest, callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Returns the indexing status for one or more documents submitted with the BatchPutDocument
|
|
43
|
+
* Returns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
|
|
44
44
|
*/
|
|
45
45
|
batchGetDocumentStatus(callback?: (err: AWSError, data: Kendra.Types.BatchGetDocumentStatusResponse) => void): Request<Kendra.Types.BatchGetDocumentStatusResponse, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Adds one or more documents to an index. The BatchPutDocument
|
|
47
|
+
* 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.
|
|
48
48
|
*/
|
|
49
49
|
batchPutDocument(params: Kendra.Types.BatchPutDocumentRequest, callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Adds one or more documents to an index. The BatchPutDocument
|
|
51
|
+
* 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.
|
|
52
52
|
*/
|
|
53
53
|
batchPutDocument(callback?: (err: AWSError, data: Kendra.Types.BatchPutDocumentResponse) => void): Request<Kendra.Types.BatchPutDocumentResponse, AWSError>;
|
|
54
54
|
/**
|
|
@@ -84,11 +84,11 @@ declare class Kendra extends Service {
|
|
|
84
84
|
*/
|
|
85
85
|
createFaq(callback?: (err: AWSError, data: Kendra.Types.CreateFaqResponse) => void): Request<Kendra.Types.CreateFaqResponse, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous
|
|
87
|
+
* Creates a new 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.
|
|
88
88
|
*/
|
|
89
89
|
createIndex(params: Kendra.Types.CreateIndexRequest, callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Creates a new Amazon Kendra index. Index creation is an asynchronous
|
|
91
|
+
* Creates a new 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.
|
|
92
92
|
*/
|
|
93
93
|
createIndex(callback?: (err: AWSError, data: Kendra.Types.CreateIndexResponse) => void): Request<Kendra.Types.CreateIndexResponse, AWSError>;
|
|
94
94
|
/**
|
|
@@ -108,11 +108,11 @@ declare class Kendra extends Service {
|
|
|
108
108
|
*/
|
|
109
109
|
createThesaurus(callback?: (err: AWSError, data: Kendra.Types.CreateThesaurusResponse) => void): Request<Kendra.Types.CreateThesaurusResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* Deletes an Amazon Kendra data source. 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
|
|
111
|
+
* Deletes an Amazon Kendra data source. 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.
|
|
112
112
|
*/
|
|
113
113
|
deleteDataSource(params: Kendra.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* Deletes an Amazon Kendra data source. 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
|
|
115
|
+
* Deletes an Amazon Kendra data source. 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.
|
|
116
116
|
*/
|
|
117
117
|
deleteDataSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
118
118
|
/**
|
|
@@ -132,11 +132,11 @@ declare class Kendra extends Service {
|
|
|
132
132
|
*/
|
|
133
133
|
deleteFaq(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex
|
|
135
|
+
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
|
|
136
136
|
*/
|
|
137
137
|
deleteIndex(params: Kendra.Types.DeleteIndexRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex
|
|
139
|
+
* Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
|
|
140
140
|
*/
|
|
141
141
|
deleteIndex(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
142
142
|
/**
|
|
@@ -164,11 +164,11 @@ declare class Kendra extends Service {
|
|
|
164
164
|
*/
|
|
165
165
|
deleteThesaurus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Gets information about
|
|
167
|
+
* Gets information about an Amazon Kendra data source.
|
|
168
168
|
*/
|
|
169
169
|
describeDataSource(params: Kendra.Types.DescribeDataSourceRequest, callback?: (err: AWSError, data: Kendra.Types.DescribeDataSourceResponse) => void): Request<Kendra.Types.DescribeDataSourceResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Gets information about
|
|
171
|
+
* Gets information about an Amazon Kendra data source.
|
|
172
172
|
*/
|
|
173
173
|
describeDataSource(callback?: (err: AWSError, data: Kendra.Types.DescribeDataSourceResponse) => void): Request<Kendra.Types.DescribeDataSourceResponse, AWSError>;
|
|
174
174
|
/**
|
|
@@ -356,11 +356,11 @@ declare class Kendra extends Service {
|
|
|
356
356
|
*/
|
|
357
357
|
putPrincipalMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
358
358
|
/**
|
|
359
|
-
* Searches an active index. Use this API to search your documents using query. The Query
|
|
359
|
+
* Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results. Relevant passages Matching FAQs Relevant documents You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results.
|
|
360
360
|
*/
|
|
361
361
|
query(params: Kendra.Types.QueryRequest, callback?: (err: AWSError, data: Kendra.Types.QueryResult) => void): Request<Kendra.Types.QueryResult, AWSError>;
|
|
362
362
|
/**
|
|
363
|
-
* Searches an active index. Use this API to search your documents using query. The Query
|
|
363
|
+
* Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results. Relevant passages Matching FAQs Relevant documents You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results.
|
|
364
364
|
*/
|
|
365
365
|
query(callback?: (err: AWSError, data: Kendra.Types.QueryResult) => void): Request<Kendra.Types.QueryResult, AWSError>;
|
|
366
366
|
/**
|
|
@@ -372,11 +372,11 @@ declare class Kendra extends Service {
|
|
|
372
372
|
*/
|
|
373
373
|
startDataSourceSyncJob(callback?: (err: AWSError, data: Kendra.Types.StartDataSourceSyncJobResponse) => void): Request<Kendra.Types.StartDataSourceSyncJobResponse, AWSError>;
|
|
374
374
|
/**
|
|
375
|
-
* Stops a
|
|
375
|
+
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
|
|
376
376
|
*/
|
|
377
377
|
stopDataSourceSyncJob(params: Kendra.Types.StopDataSourceSyncJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
378
378
|
/**
|
|
379
|
-
* Stops a
|
|
379
|
+
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
|
|
380
380
|
*/
|
|
381
381
|
stopDataSourceSyncJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
382
382
|
/**
|
|
@@ -461,7 +461,7 @@ declare namespace Kendra {
|
|
|
461
461
|
}
|
|
462
462
|
export interface AclConfiguration {
|
|
463
463
|
/**
|
|
464
|
-
* A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query
|
|
464
|
+
* A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.
|
|
465
465
|
*/
|
|
466
466
|
AllowedGroupsColumnName: ColumnName;
|
|
467
467
|
}
|
|
@@ -628,7 +628,7 @@ declare namespace Kendra {
|
|
|
628
628
|
export type BatchDeleteDocumentResponseFailedDocuments = BatchDeleteDocumentResponseFailedDocument[];
|
|
629
629
|
export interface BatchGetDocumentStatusRequest {
|
|
630
630
|
/**
|
|
631
|
-
* The identifier of the index to add documents to. The index ID is returned by the
|
|
631
|
+
* The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.
|
|
632
632
|
*/
|
|
633
633
|
IndexId: IndexId;
|
|
634
634
|
/**
|
|
@@ -663,19 +663,19 @@ declare namespace Kendra {
|
|
|
663
663
|
export type BatchGetDocumentStatusResponseErrors = BatchGetDocumentStatusResponseError[];
|
|
664
664
|
export interface BatchPutDocumentRequest {
|
|
665
665
|
/**
|
|
666
|
-
* The identifier of the index to add the documents to. You need to create the index first using the CreateIndex
|
|
666
|
+
* The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
|
|
667
667
|
*/
|
|
668
668
|
IndexId: IndexId;
|
|
669
669
|
/**
|
|
670
|
-
* The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument
|
|
670
|
+
* The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.
|
|
671
671
|
*/
|
|
672
672
|
RoleArn?: RoleArn;
|
|
673
673
|
/**
|
|
674
|
-
* One or more documents to add to the index. Documents
|
|
674
|
+
* One or more documents to add to the index. Documents have the following file size limits. 5 MB total size for inline documents 50 MB total size for files from an S3 bucket 5 MB extracted text for any file For more information about file size and transaction per second quotas, see Quotas.
|
|
675
675
|
*/
|
|
676
676
|
Documents: DocumentList;
|
|
677
677
|
/**
|
|
678
|
-
* Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument
|
|
678
|
+
* Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
|
|
679
679
|
*/
|
|
680
680
|
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
|
|
681
681
|
}
|
|
@@ -746,7 +746,7 @@ declare namespace Kendra {
|
|
|
746
746
|
*/
|
|
747
747
|
DocumentTitleColumnName?: ColumnName;
|
|
748
748
|
/**
|
|
749
|
-
* An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex
|
|
749
|
+
* An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.
|
|
750
750
|
*/
|
|
751
751
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
752
752
|
/**
|
|
@@ -762,7 +762,7 @@ declare namespace Kendra {
|
|
|
762
762
|
*/
|
|
763
763
|
CrawlAttachments?: Boolean;
|
|
764
764
|
/**
|
|
765
|
-
* Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex
|
|
765
|
+
* Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API. If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
|
|
766
766
|
*/
|
|
767
767
|
AttachmentFieldMappings?: ConfluenceAttachmentFieldMappingsList;
|
|
768
768
|
}
|
|
@@ -770,7 +770,7 @@ declare namespace Kendra {
|
|
|
770
770
|
export type ConfluenceAttachmentFieldName = "AUTHOR"|"CONTENT_TYPE"|"CREATED_DATE"|"DISPLAY_URL"|"FILE_SIZE"|"ITEM_TYPE"|"PARENT_ID"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION"|string;
|
|
771
771
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
772
772
|
/**
|
|
773
|
-
* The name of the field in the data source. You must first create the index field using the UpdateIndex
|
|
773
|
+
* The name of the field in the data source. You must first create the index field using the UpdateIndex API.
|
|
774
774
|
*/
|
|
775
775
|
DataSourceFieldName?: ConfluenceAttachmentFieldName;
|
|
776
776
|
/**
|
|
@@ -784,7 +784,7 @@ declare namespace Kendra {
|
|
|
784
784
|
}
|
|
785
785
|
export interface ConfluenceBlogConfiguration {
|
|
786
786
|
/**
|
|
787
|
-
* Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex
|
|
787
|
+
* Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API. If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.
|
|
788
788
|
*/
|
|
789
789
|
BlogFieldMappings?: ConfluenceBlogFieldMappingsList;
|
|
790
790
|
}
|
|
@@ -848,7 +848,7 @@ declare namespace Kendra {
|
|
|
848
848
|
}
|
|
849
849
|
export interface ConfluencePageConfiguration {
|
|
850
850
|
/**
|
|
851
|
-
* Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex
|
|
851
|
+
* Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API. If you specify the PageFieldMappings parameter, you must specify at least one field mapping.
|
|
852
852
|
*/
|
|
853
853
|
PageFieldMappings?: ConfluencePageFieldMappingsList;
|
|
854
854
|
}
|
|
@@ -886,7 +886,7 @@ declare namespace Kendra {
|
|
|
886
886
|
*/
|
|
887
887
|
ExcludeSpaces?: ConfluenceSpaceList;
|
|
888
888
|
/**
|
|
889
|
-
* Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex
|
|
889
|
+
* Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API. If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
|
|
890
890
|
*/
|
|
891
891
|
SpaceFieldMappings?: ConfluenceSpaceFieldMappingsList;
|
|
892
892
|
}
|
|
@@ -941,7 +941,7 @@ declare namespace Kendra {
|
|
|
941
941
|
*/
|
|
942
942
|
FaqIds?: FaqIdsList;
|
|
943
943
|
/**
|
|
944
|
-
* TRUE to use documents you indexed directly using the BatchPutDocument
|
|
944
|
+
* TRUE to use documents you indexed directly using the BatchPutDocument API.
|
|
945
945
|
*/
|
|
946
946
|
DirectPutContent?: Boolean;
|
|
947
947
|
}
|
|
@@ -969,7 +969,7 @@ declare namespace Kendra {
|
|
|
969
969
|
*/
|
|
970
970
|
Description?: Description;
|
|
971
971
|
/**
|
|
972
|
-
* Sets the frequency
|
|
972
|
+
* Sets the frequency for Amazon Kendra to check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
|
|
973
973
|
*/
|
|
974
974
|
Schedule?: ScanSchedule;
|
|
975
975
|
/**
|
|
@@ -981,7 +981,7 @@ declare namespace Kendra {
|
|
|
981
981
|
*/
|
|
982
982
|
Tags?: TagList;
|
|
983
983
|
/**
|
|
984
|
-
* A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource
|
|
984
|
+
* A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource API with the same client token will create only one data source.
|
|
985
985
|
*/
|
|
986
986
|
ClientToken?: ClientTokenName;
|
|
987
987
|
/**
|
|
@@ -1009,7 +1009,7 @@ declare namespace Kendra {
|
|
|
1009
1009
|
*/
|
|
1010
1010
|
IndexId: IndexId;
|
|
1011
1011
|
/**
|
|
1012
|
-
* The Amazon Resource Name (ARN) of a role with permission to access Query
|
|
1012
|
+
* The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
|
|
1013
1013
|
*/
|
|
1014
1014
|
RoleArn?: RoleArn;
|
|
1015
1015
|
/**
|
|
@@ -1021,7 +1021,7 @@ declare namespace Kendra {
|
|
|
1021
1021
|
*/
|
|
1022
1022
|
Description?: Description;
|
|
1023
1023
|
/**
|
|
1024
|
-
* A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience
|
|
1024
|
+
* A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.
|
|
1025
1025
|
*/
|
|
1026
1026
|
ClientToken?: ClientTokenName;
|
|
1027
1027
|
}
|
|
@@ -1061,7 +1061,7 @@ declare namespace Kendra {
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
FileFormat?: FaqFileFormat;
|
|
1063
1063
|
/**
|
|
1064
|
-
* A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest
|
|
1064
|
+
* A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
|
|
1065
1065
|
*/
|
|
1066
1066
|
ClientToken?: ClientTokenName;
|
|
1067
1067
|
/**
|
|
@@ -1085,7 +1085,7 @@ declare namespace Kendra {
|
|
|
1085
1085
|
*/
|
|
1086
1086
|
Edition?: IndexEdition;
|
|
1087
1087
|
/**
|
|
1088
|
-
* An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument
|
|
1088
|
+
* An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument API to index documents from an Amazon S3 bucket.
|
|
1089
1089
|
*/
|
|
1090
1090
|
RoleArn: RoleArn;
|
|
1091
1091
|
/**
|
|
@@ -1097,7 +1097,7 @@ declare namespace Kendra {
|
|
|
1097
1097
|
*/
|
|
1098
1098
|
Description?: Description;
|
|
1099
1099
|
/**
|
|
1100
|
-
* A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex
|
|
1100
|
+
* A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.
|
|
1101
1101
|
*/
|
|
1102
1102
|
ClientToken?: ClientTokenName;
|
|
1103
1103
|
/**
|
|
@@ -1145,7 +1145,7 @@ declare namespace Kendra {
|
|
|
1145
1145
|
*/
|
|
1146
1146
|
ClientToken?: ClientTokenName;
|
|
1147
1147
|
/**
|
|
1148
|
-
* The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket. You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
|
|
1148
|
+
* The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket. You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
|
|
1149
1149
|
*/
|
|
1150
1150
|
RoleArn: RoleArn;
|
|
1151
1151
|
/**
|
|
@@ -1185,7 +1185,7 @@ declare namespace Kendra {
|
|
|
1185
1185
|
*/
|
|
1186
1186
|
SourceS3Path: S3Path;
|
|
1187
1187
|
/**
|
|
1188
|
-
* A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus
|
|
1188
|
+
* A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.
|
|
1189
1189
|
*/
|
|
1190
1190
|
ClientToken?: ClientTokenName;
|
|
1191
1191
|
}
|
|
@@ -1248,9 +1248,13 @@ declare namespace Kendra {
|
|
|
1248
1248
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
1249
1249
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
1250
1250
|
/**
|
|
1251
|
-
* Provides the configuration information to connect to WorkDocs as your data source.
|
|
1251
|
+
* Provides the configuration information to connect to Amazon WorkDocs as your data source.
|
|
1252
1252
|
*/
|
|
1253
1253
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
1254
|
+
/**
|
|
1255
|
+
* Provides the configuration information to connect to Amazon FSx as your data source.
|
|
1256
|
+
*/
|
|
1257
|
+
FsxConfiguration?: FsxConfiguration;
|
|
1254
1258
|
}
|
|
1255
1259
|
export type DataSourceDateFieldFormat = string;
|
|
1256
1260
|
export type DataSourceFieldName = string;
|
|
@@ -1308,11 +1312,11 @@ declare namespace Kendra {
|
|
|
1308
1312
|
*/
|
|
1309
1313
|
ExecutionId?: String;
|
|
1310
1314
|
/**
|
|
1311
|
-
* The UNIX datetime that the synchronization job
|
|
1315
|
+
* The UNIX datetime that the synchronization job started.
|
|
1312
1316
|
*/
|
|
1313
1317
|
StartTime?: Timestamp;
|
|
1314
1318
|
/**
|
|
1315
|
-
* The UNIX datetime that the synchronization job
|
|
1319
|
+
* The UNIX datetime that the synchronization job completed.
|
|
1316
1320
|
*/
|
|
1317
1321
|
EndTime?: Timestamp;
|
|
1318
1322
|
/**
|
|
@@ -1324,7 +1328,7 @@ declare namespace Kendra {
|
|
|
1324
1328
|
*/
|
|
1325
1329
|
ErrorMessage?: ErrorMessage;
|
|
1326
1330
|
/**
|
|
1327
|
-
* If the Status field is set to FAILED, the ErrorCode field
|
|
1331
|
+
* If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
|
|
1328
1332
|
*/
|
|
1329
1333
|
ErrorCode?: ErrorCode;
|
|
1330
1334
|
/**
|
|
@@ -1386,7 +1390,7 @@ declare namespace Kendra {
|
|
|
1386
1390
|
IndexFieldName: IndexFieldName;
|
|
1387
1391
|
}
|
|
1388
1392
|
export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
|
|
1389
|
-
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|string;
|
|
1393
|
+
export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|"FSX"|string;
|
|
1390
1394
|
export interface DataSourceVpcConfiguration {
|
|
1391
1395
|
/**
|
|
1392
1396
|
* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
|
|
@@ -1548,7 +1552,7 @@ declare namespace Kendra {
|
|
|
1548
1552
|
*/
|
|
1549
1553
|
Status?: DataSourceStatus;
|
|
1550
1554
|
/**
|
|
1551
|
-
* The schedule
|
|
1555
|
+
* The schedule for Amazon Kendra to update the index.
|
|
1552
1556
|
*/
|
|
1553
1557
|
Schedule?: ScanSchedule;
|
|
1554
1558
|
/**
|
|
@@ -1616,7 +1620,7 @@ declare namespace Kendra {
|
|
|
1616
1620
|
*/
|
|
1617
1621
|
Status?: ExperienceStatus;
|
|
1618
1622
|
/**
|
|
1619
|
-
* Shows the Amazon Resource Name (ARN) of a role with permission to access Query
|
|
1623
|
+
* Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
|
|
1620
1624
|
*/
|
|
1621
1625
|
RoleArn?: RoleArn;
|
|
1622
1626
|
/**
|
|
@@ -1853,7 +1857,7 @@ declare namespace Kendra {
|
|
|
1853
1857
|
}
|
|
1854
1858
|
export interface DescribeQuerySuggestionsConfigResponse {
|
|
1855
1859
|
/**
|
|
1856
|
-
* Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig
|
|
1860
|
+
* Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.
|
|
1857
1861
|
*/
|
|
1858
1862
|
Mode?: Mode;
|
|
1859
1863
|
/**
|
|
@@ -2002,12 +2006,12 @@ declare namespace Kendra {
|
|
|
2002
2006
|
*/
|
|
2003
2007
|
Title?: Title;
|
|
2004
2008
|
/**
|
|
2005
|
-
* The contents of the document. Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra
|
|
2009
|
+
* The contents of the document. Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
|
|
2006
2010
|
*/
|
|
2007
2011
|
Blob?: _Blob;
|
|
2008
2012
|
S3Path?: S3Path;
|
|
2009
2013
|
/**
|
|
2010
|
-
* Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
|
|
2014
|
+
* Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
|
|
2011
2015
|
*/
|
|
2012
2016
|
Attributes?: DocumentAttributeList;
|
|
2013
2017
|
/**
|
|
@@ -2203,7 +2207,7 @@ declare namespace Kendra {
|
|
|
2203
2207
|
export type ExcludeUserAccountsList = UserAccount[];
|
|
2204
2208
|
export interface ExperienceConfiguration {
|
|
2205
2209
|
/**
|
|
2206
|
-
* The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument
|
|
2210
|
+
* The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.
|
|
2207
2211
|
*/
|
|
2208
2212
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
2209
2213
|
/**
|
|
@@ -2340,6 +2344,38 @@ declare namespace Kendra {
|
|
|
2340
2344
|
}
|
|
2341
2345
|
export type FaqSummaryItems = FaqSummary[];
|
|
2342
2346
|
export type FeedbackToken = string;
|
|
2347
|
+
export type FileSystemId = string;
|
|
2348
|
+
export interface FsxConfiguration {
|
|
2349
|
+
/**
|
|
2350
|
+
* The identifier of the Amazon FSx file system. You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.
|
|
2351
|
+
*/
|
|
2352
|
+
FileSystemId: FileSystemId;
|
|
2353
|
+
/**
|
|
2354
|
+
* The Amazon FSx file system type. Windows is currently the only supported type.
|
|
2355
|
+
*/
|
|
2356
|
+
FileSystemType: FsxFileSystemType;
|
|
2357
|
+
/**
|
|
2358
|
+
* Provides the configuration information for connecting to an Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
|
|
2359
|
+
*/
|
|
2360
|
+
VpcConfiguration: DataSourceVpcConfiguration;
|
|
2361
|
+
/**
|
|
2362
|
+
* The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys: username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows. password—The password of the active directory user with read and mounting access Amazon FSx Windows file system.
|
|
2363
|
+
*/
|
|
2364
|
+
SecretArn?: SecretArn;
|
|
2365
|
+
/**
|
|
2366
|
+
* A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2367
|
+
*/
|
|
2368
|
+
InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2369
|
+
/**
|
|
2370
|
+
* A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
|
|
2371
|
+
*/
|
|
2372
|
+
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2373
|
+
/**
|
|
2374
|
+
* A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names in Amazon Kendra. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
|
|
2375
|
+
*/
|
|
2376
|
+
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2377
|
+
}
|
|
2378
|
+
export type FsxFileSystemType = "WINDOWS"|string;
|
|
2343
2379
|
export interface GetQuerySuggestionsRequest {
|
|
2344
2380
|
/**
|
|
2345
2381
|
* The identifier of the index you want to get query suggestions from.
|
|
@@ -2418,7 +2454,7 @@ declare namespace Kendra {
|
|
|
2418
2454
|
*/
|
|
2419
2455
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
2420
2456
|
/**
|
|
2421
|
-
* Defines mapping between a field in the Google Drive and a Amazon Kendra index field. If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex
|
|
2457
|
+
* Defines mapping between a field in the Google Drive and a Amazon Kendra index field. If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex API.
|
|
2422
2458
|
*/
|
|
2423
2459
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
2424
2460
|
/**
|
|
@@ -2534,7 +2570,7 @@ declare namespace Kendra {
|
|
|
2534
2570
|
*/
|
|
2535
2571
|
Name?: IndexName;
|
|
2536
2572
|
/**
|
|
2537
|
-
* A unique identifier for the index. Use this to identify the index when you are using
|
|
2573
|
+
* A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
|
|
2538
2574
|
*/
|
|
2539
2575
|
Id?: IndexId;
|
|
2540
2576
|
/**
|
|
@@ -2546,7 +2582,7 @@ declare namespace Kendra {
|
|
|
2546
2582
|
*/
|
|
2547
2583
|
CreatedAt: Timestamp;
|
|
2548
2584
|
/**
|
|
2549
|
-
* The Unix timestamp when the index was last updated by the UpdateIndex
|
|
2585
|
+
* The Unix timestamp when the index was last updated by the UpdateIndex API.
|
|
2550
2586
|
*/
|
|
2551
2587
|
UpdatedAt: Timestamp;
|
|
2552
2588
|
/**
|
|
@@ -3081,7 +3117,7 @@ declare namespace Kendra {
|
|
|
3081
3117
|
export type QueryIdentifiersEnclosingOption = "DOUBLE_QUOTES"|"NONE"|string;
|
|
3082
3118
|
export interface QueryRequest {
|
|
3083
3119
|
/**
|
|
3084
|
-
* The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex
|
|
3120
|
+
* The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex API.
|
|
3085
3121
|
*/
|
|
3086
3122
|
IndexId: IndexId;
|
|
3087
3123
|
/**
|
|
@@ -3601,7 +3637,7 @@ declare namespace Kendra {
|
|
|
3601
3637
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
3602
3638
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
3603
3639
|
/**
|
|
3604
|
-
* A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex
|
|
3640
|
+
* A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex API before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
|
|
3605
3641
|
*/
|
|
3606
3642
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
3607
3643
|
/**
|
|
@@ -3697,7 +3733,7 @@ declare namespace Kendra {
|
|
|
3697
3733
|
*/
|
|
3698
3734
|
IndexId: IndexId;
|
|
3699
3735
|
/**
|
|
3700
|
-
* The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query
|
|
3736
|
+
* The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.
|
|
3701
3737
|
*/
|
|
3702
3738
|
QueryId: QueryId;
|
|
3703
3739
|
/**
|
|
@@ -3901,7 +3937,7 @@ declare namespace Kendra {
|
|
|
3901
3937
|
*/
|
|
3902
3938
|
IndexId: IndexId;
|
|
3903
3939
|
/**
|
|
3904
|
-
* The Amazon Resource Name (ARN) of a role with permission to access Query
|
|
3940
|
+
* The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
|
|
3905
3941
|
*/
|
|
3906
3942
|
RoleArn?: RoleArn;
|
|
3907
3943
|
/**
|
|
@@ -4161,7 +4197,7 @@ declare namespace Kendra {
|
|
|
4161
4197
|
*/
|
|
4162
4198
|
ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
|
|
4163
4199
|
/**
|
|
4164
|
-
* A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex
|
|
4200
|
+
* A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
|
|
4165
4201
|
*/
|
|
4166
4202
|
FieldMappings?: DataSourceToIndexFieldMappingList;
|
|
4167
4203
|
}
|
|
@@ -149,11 +149,11 @@ declare class LookoutVision extends Service {
|
|
|
149
149
|
*/
|
|
150
150
|
startModel(callback?: (err: AWSError, data: LookoutVision.Types.StartModelResponse) => void): Request<LookoutVision.Types.StartModelResponse, AWSError>;
|
|
151
151
|
/**
|
|
152
|
-
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API. This operation requires the following permissions: lookoutvision:
|
|
152
|
+
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API. This operation requires the following permissions: lookoutvision:StartModelPackagingJob s3:PutObject s3:GetBucketLocation greengrass:CreateComponentVersion greengrass:DescribeComponent (Optional) greengrass:TagResource. Only required if you want to tag the component. For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
|
|
153
153
|
*/
|
|
154
154
|
startModelPackagingJob(params: LookoutVision.Types.StartModelPackagingJobRequest, callback?: (err: AWSError, data: LookoutVision.Types.StartModelPackagingJobResponse) => void): Request<LookoutVision.Types.StartModelPackagingJobResponse, AWSError>;
|
|
155
155
|
/**
|
|
156
|
-
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API. This operation requires the following permissions: lookoutvision:
|
|
156
|
+
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass. Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API. This operation requires the following permissions: lookoutvision:StartModelPackagingJob s3:PutObject s3:GetBucketLocation greengrass:CreateComponentVersion greengrass:DescribeComponent (Optional) greengrass:TagResource. Only required if you want to tag the component. For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
|
|
157
157
|
*/
|
|
158
158
|
startModelPackagingJob(callback?: (err: AWSError, data: LookoutVision.Types.StartModelPackagingJobResponse) => void): Request<LookoutVision.Types.StartModelPackagingJobResponse, AWSError>;
|
|
159
159
|
/**
|
|
@@ -510,9 +510,9 @@ declare namespace LookoutVision {
|
|
|
510
510
|
export type Float = number;
|
|
511
511
|
export interface GreengrassConfiguration {
|
|
512
512
|
/**
|
|
513
|
-
* Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) are supported. For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.
|
|
513
|
+
* Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) are supported. If you specify TargetPlatform, you must specify CompilerOptions. If you specify TargetDevice, don't specify CompilerOptions. For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.
|
|
514
514
|
*/
|
|
515
|
-
CompilerOptions
|
|
515
|
+
CompilerOptions?: CompilerOptions;
|
|
516
516
|
/**
|
|
517
517
|
* The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.
|
|
518
518
|
*/
|
package/clients/pinpoint.d.ts
CHANGED
|
@@ -1746,6 +1746,10 @@ declare namespace Pinpoint {
|
|
|
1746
1746
|
* A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
|
|
1747
1747
|
*/
|
|
1748
1748
|
tags?: MapOf__string;
|
|
1749
|
+
/**
|
|
1750
|
+
* The date and time when the Application was created.
|
|
1751
|
+
*/
|
|
1752
|
+
CreationDate?: __string;
|
|
1749
1753
|
}
|
|
1750
1754
|
export interface ApplicationSettingsResource {
|
|
1751
1755
|
/**
|