aws-sdk 2.930.0 → 2.931.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.
@@ -796,11 +796,11 @@ declare class Chime extends Service {
796
796
  */
797
797
  getVoiceConnectorEmergencyCallingConfiguration(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorEmergencyCallingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorEmergencyCallingConfigurationResponse, AWSError>;
798
798
  /**
799
- * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .
799
+ * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
800
800
  */
801
801
  getVoiceConnectorGroup(params: Chime.Types.GetVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
802
802
  /**
803
- * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .
803
+ * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.
804
804
  */
805
805
  getVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
806
806
  /**
@@ -980,11 +980,11 @@ declare class Chime extends Service {
980
980
  */
981
981
  listMeetingTags(callback?: (err: AWSError, data: Chime.Types.ListMeetingTagsResponse) => void): Request<Chime.Types.ListMeetingTagsResponse, AWSError>;
982
982
  /**
983
- * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
983
+ * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
984
984
  */
985
985
  listMeetings(params: Chime.Types.ListMeetingsRequest, callback?: (err: AWSError, data: Chime.Types.ListMeetingsResponse) => void): Request<Chime.Types.ListMeetingsResponse, AWSError>;
986
986
  /**
987
- * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
987
+ * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
988
988
  */
989
989
  listMeetings(callback?: (err: AWSError, data: Chime.Types.ListMeetingsResponse) => void): Request<Chime.Types.ListMeetingsResponse, AWSError>;
990
990
  /**
@@ -1124,11 +1124,11 @@ declare class Chime extends Service {
1124
1124
  */
1125
1125
  putEventsConfiguration(callback?: (err: AWSError, data: Chime.Types.PutEventsConfigurationResponse) => void): Request<Chime.Types.PutEventsConfigurationResponse, AWSError>;
1126
1126
  /**
1127
- * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide . To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
1127
+ * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
1128
1128
  */
1129
1129
  putRetentionSettings(params: Chime.Types.PutRetentionSettingsRequest, callback?: (err: AWSError, data: Chime.Types.PutRetentionSettingsResponse) => void): Request<Chime.Types.PutRetentionSettingsResponse, AWSError>;
1130
1130
  /**
1131
- * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide . To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
1131
+ * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
1132
1132
  */
1133
1133
  putRetentionSettings(callback?: (err: AWSError, data: Chime.Types.PutRetentionSettingsResponse) => void): Request<Chime.Types.PutRetentionSettingsResponse, AWSError>;
1134
1134
  /**
@@ -1427,6 +1427,14 @@ declare class Chime extends Service {
1427
1427
  * Updates the details of the specified SIP media application.
1428
1428
  */
1429
1429
  updateSipMediaApplication(callback?: (err: AWSError, data: Chime.Types.UpdateSipMediaApplicationResponse) => void): Request<Chime.Types.UpdateSipMediaApplicationResponse, AWSError>;
1430
+ /**
1431
+ * Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.
1432
+ */
1433
+ updateSipMediaApplicationCall(params: Chime.Types.UpdateSipMediaApplicationCallRequest, callback?: (err: AWSError, data: Chime.Types.UpdateSipMediaApplicationCallResponse) => void): Request<Chime.Types.UpdateSipMediaApplicationCallResponse, AWSError>;
1434
+ /**
1435
+ * Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.
1436
+ */
1437
+ updateSipMediaApplicationCall(callback?: (err: AWSError, data: Chime.Types.UpdateSipMediaApplicationCallResponse) => void): Request<Chime.Types.UpdateSipMediaApplicationCallResponse, AWSError>;
1430
1438
  /**
1431
1439
  * Updates the details of the specified SIP rule.
1432
1440
  */
@@ -5333,6 +5341,7 @@ declare namespace Chime {
5333
5341
  */
5334
5342
  RetentionDays?: RetentionDays;
5335
5343
  }
5344
+ export type SMAUpdateCallArgumentsMap = {[key: string]: SensitiveString};
5336
5345
  export interface SearchAvailablePhoneNumbersRequest {
5337
5346
  /**
5338
5347
  * The area code used to filter results. Only applies to the US.
@@ -5968,6 +5977,23 @@ declare namespace Chime {
5968
5977
  */
5969
5978
  Room?: Room;
5970
5979
  }
5980
+ export interface UpdateSipMediaApplicationCallRequest {
5981
+ /**
5982
+ * The ID of the SIP media application handling the call.
5983
+ */
5984
+ SipMediaApplicationId: NonEmptyString;
5985
+ /**
5986
+ * The ID of the call transaction.
5987
+ */
5988
+ TransactionId: NonEmptyString;
5989
+ /**
5990
+ * Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.
5991
+ */
5992
+ Arguments: SMAUpdateCallArgumentsMap;
5993
+ }
5994
+ export interface UpdateSipMediaApplicationCallResponse {
5995
+ SipMediaApplicationCall?: SipMediaApplicationCall;
5996
+ }
5971
5997
  export interface UpdateSipMediaApplicationRequest {
5972
5998
  /**
5973
5999
  * The SIP media application ID.
@@ -403,6 +403,27 @@ declare namespace Kendra {
403
403
  LessThanOrEquals?: DocumentAttribute;
404
404
  }
405
405
  export type AttributeFilterList = AttributeFilter[];
406
+ export interface AuthenticationConfiguration {
407
+ /**
408
+ * The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host.
409
+ */
410
+ BasicAuthentication?: BasicAuthenticationConfigurationList;
411
+ }
412
+ export interface BasicAuthenticationConfiguration {
413
+ /**
414
+ * The name of the website host you want to connect to using authentication credentials. For example, the host name of https://a.example.com/page1.html is "a.example.com".
415
+ */
416
+ Host: Host;
417
+ /**
418
+ * The port number of the website host you want to connect to using authentication credentials. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
419
+ */
420
+ Port: Port;
421
+ /**
422
+ * Your secret ARN, which you can create in AWS Secrets Manager You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
423
+ */
424
+ Credentials: SecretArn;
425
+ }
426
+ export type BasicAuthenticationConfigurationList = BasicAuthenticationConfiguration[];
406
427
  export interface BatchDeleteDocumentRequest {
407
428
  /**
408
429
  * The identifier of the index that contains the documents to delete.
@@ -509,11 +530,11 @@ declare namespace Kendra {
509
530
  export type Boolean = boolean;
510
531
  export interface CapacityUnitsConfiguration {
511
532
  /**
512
- * The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb of storage space or 500,000 documents, whichever is reached first.
533
+ * The amount of extra storage capacity for an index. A single capacity unit for an index provides 150 GB of storage space or 500,000 documents, whichever is reached first.
513
534
  */
514
535
  StorageCapacityUnits: StorageCapacityUnit;
515
536
  /**
516
- * The amount of extra query capacity for an index. Each capacity unit provides 0.5 queries per second and 40,000 queries per day.
537
+ * The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.5 queries per second or approximately 40,000 queries per day. GetQuerySuggestions capacity is 5 times the provisioned query capacity for an index. For example, the base capacity for an index is 0.5 queries per second, so GetQuerySuggestions capacity is 2.5 calls per second. If adding another 0.5 queries per second to total 1 queries per second for an index, the GetQuerySuggestions capacity is 5 calls per second.
517
538
  */
518
539
  QueryCapacityUnits: QueryCapacityUnit;
519
540
  }
@@ -736,6 +757,7 @@ declare namespace Kendra {
736
757
  SecretArn: SecretArn;
737
758
  }
738
759
  export type ContentType = "PDF"|"HTML"|"MS_WORD"|"PLAIN_TEXT"|"PPT"|string;
760
+ export type CrawlDepth = number;
739
761
  export interface CreateDataSourceRequest {
740
762
  /**
741
763
  * A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.
@@ -969,6 +991,7 @@ declare namespace Kendra {
969
991
  * Provides configuration for data sources that connect to Google Drive.
970
992
  */
971
993
  GoogleDriveConfiguration?: GoogleDriveConfiguration;
994
+ WebCrawlerConfiguration?: WebCrawlerConfiguration;
972
995
  }
973
996
  export type DataSourceDateFieldFormat = string;
974
997
  export type DataSourceFieldName = string;
@@ -1088,7 +1111,7 @@ declare namespace Kendra {
1088
1111
  IndexFieldName: IndexFieldName;
1089
1112
  }
1090
1113
  export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
1091
- export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|string;
1114
+ export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|string;
1092
1115
  export interface DataSourceVpcConfiguration {
1093
1116
  /**
1094
1117
  * 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.
@@ -1783,6 +1806,7 @@ declare namespace Kendra {
1783
1806
  }
1784
1807
  export type HighlightList = Highlight[];
1785
1808
  export type HighlightType = "STANDARD"|"THESAURUS_SYNONYM"|string;
1809
+ export type Host = string;
1786
1810
  export type Importance = number;
1787
1811
  export interface IndexConfigurationSummary {
1788
1812
  /**
@@ -2038,12 +2062,15 @@ declare namespace Kendra {
2038
2062
  ThesaurusSummaryItems?: ThesaurusSummaryItems;
2039
2063
  }
2040
2064
  export type Long = number;
2065
+ export type MaxContentSizePerPageInMegaBytes = number;
2066
+ export type MaxLinksPerPage = number;
2041
2067
  export type MaxResultsIntegerForListDataSourceSyncJobsRequest = number;
2042
2068
  export type MaxResultsIntegerForListDataSourcesRequest = number;
2043
2069
  export type MaxResultsIntegerForListFaqsRequest = number;
2044
2070
  export type MaxResultsIntegerForListIndicesRequest = number;
2045
2071
  export type MaxResultsIntegerForListQuerySuggestionsBlockLists = number;
2046
2072
  export type MaxResultsIntegerForListThesauriRequest = number;
2073
+ export type MaxUrlsPerMinuteCrawlRate = number;
2047
2074
  export type MetricValue = string;
2048
2075
  export type MimeType = string;
2049
2076
  export type MinimumNumberOfQueryingUsers = number;
@@ -2094,6 +2121,7 @@ declare namespace Kendra {
2094
2121
  OneDriveUserS3Path?: S3Path;
2095
2122
  }
2096
2123
  export type Order = "ASCENDING"|"DESCENDING"|string;
2124
+ export type Port = number;
2097
2125
  export interface Principal {
2098
2126
  /**
2099
2127
  * The name of the user or group.
@@ -2111,6 +2139,20 @@ declare namespace Kendra {
2111
2139
  export type PrincipalList = Principal[];
2112
2140
  export type PrincipalName = string;
2113
2141
  export type PrincipalType = "USER"|"GROUP"|string;
2142
+ export interface ProxyConfiguration {
2143
+ /**
2144
+ * The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is "a.example.com".
2145
+ */
2146
+ Host: Host;
2147
+ /**
2148
+ * The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
2149
+ */
2150
+ Port: Port;
2151
+ /**
2152
+ * Your secret ARN, which you can create in AWS Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
2153
+ */
2154
+ Credentials?: SecretArn;
2155
+ }
2114
2156
  export type QueryCapacityUnit = number;
2115
2157
  export type QueryId = string;
2116
2158
  export type QueryIdentifiersEnclosingOption = "DOUBLE_QUOTES"|"NONE"|string;
@@ -2497,6 +2539,18 @@ declare namespace Kendra {
2497
2539
  }
2498
2540
  export type SecretArn = string;
2499
2541
  export type SecurityGroupIdList = VpcSecurityGroupId[];
2542
+ export type SeedUrl = string;
2543
+ export interface SeedUrlConfiguration {
2544
+ /**
2545
+ * The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of 100 seed URLs.
2546
+ */
2547
+ SeedUrls: SeedUrlList;
2548
+ /**
2549
+ * You can choose one of the following modes: HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled. SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled. EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to. The default mode is set to HOST_ONLY.
2550
+ */
2551
+ WebCrawlerMode?: WebCrawlerMode;
2552
+ }
2553
+ export type SeedUrlList = SeedUrl[];
2500
2554
  export interface ServerSideEncryptionConfiguration {
2501
2555
  /**
2502
2556
  * The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
@@ -2635,6 +2689,14 @@ declare namespace Kendra {
2635
2689
  export type SharePointUrlList = Url[];
2636
2690
  export type SharePointVersion = "SHAREPOINT_ONLINE"|string;
2637
2691
  export type SharedDriveId = string;
2692
+ export type SiteMap = string;
2693
+ export interface SiteMapsConfiguration {
2694
+ /**
2695
+ * The list of sitemap URLs of the websites you want to crawl. The list can include a maximum of three sitemap URLs.
2696
+ */
2697
+ SiteMaps: SiteMapsList;
2698
+ }
2699
+ export type SiteMapsList = SiteMap[];
2638
2700
  export type SortOrder = "DESC"|"ASC"|string;
2639
2701
  export interface SortingConfiguration {
2640
2702
  /**
@@ -2993,6 +3055,16 @@ declare namespace Kendra {
2993
3055
  SourceS3Path?: S3Path;
2994
3056
  }
2995
3057
  export type Url = string;
3058
+ export interface Urls {
3059
+ /**
3060
+ * Provides the configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to. You can list up to 100 seed URLs.
3061
+ */
3062
+ SeedUrlConfiguration?: SeedUrlConfiguration;
3063
+ /**
3064
+ * Provides the configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.
3065
+ */
3066
+ SiteMapsConfiguration?: SiteMapsConfiguration;
3067
+ }
2996
3068
  export type UserAccount = string;
2997
3069
  export interface UserContext {
2998
3070
  /**
@@ -3017,6 +3089,45 @@ declare namespace Kendra {
3017
3089
  export type ValueImportanceMapKey = string;
3018
3090
  export type VisitorId = string;
3019
3091
  export type VpcSecurityGroupId = string;
3092
+ export interface WebCrawlerConfiguration {
3093
+ /**
3094
+ * Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs. When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
3095
+ */
3096
+ Urls: Urls;
3097
+ /**
3098
+ * Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to 2.
3099
+ */
3100
+ CrawlDepth?: CrawlDepth;
3101
+ /**
3102
+ * The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage. As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance. The default maximum links per page is 100.
3103
+ */
3104
+ MaxLinksPerPage?: MaxLinksPerPage;
3105
+ /**
3106
+ * The maximum size (in MB) of a webpage or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a webpage or attachment is set to 50 MB.
3107
+ */
3108
+ MaxContentSizePerPageInMegaBytes?: MaxContentSizePerPageInMegaBytes;
3109
+ /**
3110
+ * The maximum number of URLs crawled per website host per minute. A minimum of one URL is required. The default maximum number of URLs crawled per website host per minute is 300.
3111
+ */
3112
+ MaxUrlsPerMinuteCrawlRate?: MaxUrlsPerMinuteCrawlRate;
3113
+ /**
3114
+ * The regular expression pattern to include certain URLs to crawl. If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.
3115
+ */
3116
+ UrlInclusionPatterns?: DataSourceInclusionsExclusionsStrings;
3117
+ /**
3118
+ * The regular expression pattern to exclude certain URLs to crawl. If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.
3119
+ */
3120
+ UrlExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
3121
+ /**
3122
+ * Provides configuration information required to connect to your internal websites via a web proxy. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager.
3123
+ */
3124
+ ProxyConfiguration?: ProxyConfiguration;
3125
+ /**
3126
+ * Provides configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.
3127
+ */
3128
+ AuthenticationConfiguration?: AuthenticationConfiguration;
3129
+ }
3130
+ export type WebCrawlerMode = "HOST_ONLY"|"SUBDOMAINS"|"EVERYTHING"|string;
3020
3131
  /**
3021
3132
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
3022
3133
  */