aws-sdk 2.953.0 → 2.954.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.
@@ -433,6 +433,10 @@ declare namespace S3Control {
433
433
  * The ARN for the access point.
434
434
  */
435
435
  AccessPointArn?: S3AccessPointArn;
436
+ /**
437
+ * The name or alias of the access point.
438
+ */
439
+ Alias?: Alias;
436
440
  }
437
441
  export type AccessPointList = AccessPoint[];
438
442
  export type AccessPointName = string;
@@ -453,6 +457,7 @@ declare namespace S3Control {
453
457
  */
454
458
  IsEnabled?: IsEnabled;
455
459
  }
460
+ export type Alias = string;
456
461
  export interface AwsLambdaTransformation {
457
462
  /**
458
463
  * The Amazon Resource Name (ARN) of the Lambda function.
@@ -531,6 +536,10 @@ declare namespace S3Control {
531
536
  * The ARN of the access point. This is only supported by Amazon S3 on Outposts.
532
537
  */
533
538
  AccessPointArn?: S3AccessPointArn;
539
+ /**
540
+ * The name or alias of the access point.
541
+ */
542
+ Alias?: Alias;
534
543
  }
535
544
  export interface CreateBucketConfiguration {
536
545
  /**
@@ -778,6 +787,7 @@ declare namespace S3Control {
778
787
  */
779
788
  Job?: JobDescriptor;
780
789
  }
790
+ export type Endpoints = {[key: string]: NonEmptyMaxLength1024String};
781
791
  export interface Exclude {
782
792
  /**
783
793
  * A container for the S3 Storage Lens bucket excludes.
@@ -925,6 +935,18 @@ declare namespace S3Control {
925
935
  * The date and time when the specified access point was created.
926
936
  */
927
937
  CreationDate?: CreationDate;
938
+ /**
939
+ * The name or alias of the access point.
940
+ */
941
+ Alias?: Alias;
942
+ /**
943
+ * The ARN of the access point.
944
+ */
945
+ AccessPointArn?: S3AccessPointArn;
946
+ /**
947
+ * The VPC endpoint for the access point.
948
+ */
949
+ Endpoints?: Endpoints;
928
950
  }
929
951
  export interface GetBucketLifecycleConfigurationRequest {
930
952
  /**
@@ -92,11 +92,11 @@ declare class Synthetics extends Service {
92
92
  */
93
93
  stopCanary(callback?: (err: AWSError, data: Synthetics.Types.StopCanaryResponse) => void): Request<Synthetics.Types.StopCanaryResponse, AWSError>;
94
94
  /**
95
- * Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
95
+ * Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
96
96
  */
97
97
  tagResource(params: Synthetics.Types.TagResourceRequest, callback?: (err: AWSError, data: Synthetics.Types.TagResourceResponse) => void): Request<Synthetics.Types.TagResourceResponse, AWSError>;
98
98
  /**
99
- * Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
99
+ * Assigns one or more tags (key-value pairs) to the specified canary. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary.
100
100
  */
101
101
  tagResource(callback?: (err: AWSError, data: Synthetics.Types.TagResourceResponse) => void): Request<Synthetics.Types.TagResourceResponse, AWSError>;
102
102
  /**
@@ -117,6 +117,13 @@ declare class Synthetics extends Service {
117
117
  updateCanary(callback?: (err: AWSError, data: Synthetics.Types.UpdateCanaryResponse) => void): Request<Synthetics.Types.UpdateCanaryResponse, AWSError>;
118
118
  }
119
119
  declare namespace Synthetics {
120
+ export interface BaseScreenshot {
121
+ ScreenshotName: String;
122
+ IgnoreCoordinates?: BaseScreenshotIgnoreCoordinates;
123
+ }
124
+ export type BaseScreenshotConfigIgnoreCoordinate = string;
125
+ export type BaseScreenshotIgnoreCoordinates = BaseScreenshotConfigIgnoreCoordinate[];
126
+ export type BaseScreenshots = BaseScreenshot[];
120
127
  export type _Blob = Buffer|Uint8Array|Blob|string;
121
128
  export type Canaries = Canary[];
122
129
  export type CanariesLastRun = CanaryLastRun[];
@@ -168,6 +175,7 @@ declare namespace Synthetics {
168
175
  */
169
176
  RuntimeVersion?: String;
170
177
  VpcConfig?: VpcConfigOutput;
178
+ VisualReference?: VisualReferenceOutput;
171
179
  /**
172
180
  * The list of key-value pairs that are associated with the canary.
173
181
  */
@@ -176,7 +184,7 @@ declare namespace Synthetics {
176
184
  export type CanaryArn = string;
177
185
  export interface CanaryCodeInput {
178
186
  /**
179
- * If your canary script is located in S3, specify the full bucket name here. The bucket must already exist. Specify the full bucket name, including s3:// as the start of the bucket name.
187
+ * If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
180
188
  */
181
189
  S3Bucket?: String;
182
190
  /**
@@ -188,11 +196,11 @@ declare namespace Synthetics {
188
196
  */
189
197
  S3Version?: String;
190
198
  /**
191
- * If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the .zip file that contains the script. It can be up to 5 MB.
199
+ * If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It can be up to 5 MB.
192
200
  */
193
201
  ZipFile?: _Blob;
194
202
  /**
195
- * The entry point to use for the source code when running the canary. This value must end with the string .handler.
203
+ * The entry point to use for the source code when running the canary. This value must end with the string .handler. The string is limited to 29 characters or fewer.
196
204
  */
197
205
  Handler: String;
198
206
  }
@@ -249,7 +257,7 @@ declare namespace Synthetics {
249
257
  */
250
258
  MemoryInMB?: MaxSize3008;
251
259
  /**
252
- * Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
260
+ * Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime.
253
261
  */
254
262
  ActiveTracing?: NullableBoolean;
255
263
  /**
@@ -267,7 +275,7 @@ declare namespace Synthetics {
267
275
  */
268
276
  MemoryInMB?: MaxSize3008;
269
277
  /**
270
- * Displays whether this canary run used active AWS X-Ray tracing.
278
+ * Displays whether this canary run used active X-Ray tracing.
271
279
  */
272
280
  ActiveTracing?: NullableBoolean;
273
281
  }
@@ -300,7 +308,7 @@ declare namespace Synthetics {
300
308
  export type CanaryRuns = CanaryRun[];
301
309
  export interface CanaryScheduleInput {
302
310
  /**
303
- * A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
311
+ * A rate expression or a cron expression that defines how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started. Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
304
312
  */
305
313
  Expression: String;
306
314
  /**
@@ -310,7 +318,7 @@ declare namespace Synthetics {
310
318
  }
311
319
  export interface CanaryScheduleOutput {
312
320
  /**
313
- * A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
321
+ * A rate expression or a cron expression that defines how often the canary is to run. For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour. For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour). Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started. Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
314
322
  */
315
323
  Expression?: String;
316
324
  /**
@@ -362,7 +370,7 @@ declare namespace Synthetics {
362
370
  */
363
371
  Code: CanaryCodeInput;
364
372
  /**
365
- * The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files.
373
+ * The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).
366
374
  */
367
375
  ArtifactS3Location: String;
368
376
  /**
@@ -640,9 +648,18 @@ declare namespace Synthetics {
640
648
  * If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
641
649
  */
642
650
  VpcConfig?: VpcConfigInput;
651
+ VisualReference?: VisualReferenceInput;
643
652
  }
644
653
  export interface UpdateCanaryResponse {
645
654
  }
655
+ export interface VisualReferenceInput {
656
+ BaseScreenshots?: BaseScreenshots;
657
+ BaseCanaryRunId: String;
658
+ }
659
+ export interface VisualReferenceOutput {
660
+ BaseScreenshots?: BaseScreenshots;
661
+ BaseCanaryRunId?: String;
662
+ }
646
663
  export interface VpcConfigInput {
647
664
  /**
648
665
  * The IDs of the subnets where this canary is to run.
@@ -19,6 +19,14 @@ declare class Textract extends Service {
19
19
  * Analyzes an input document for relationships between detected items. The types of information returned are as follows: Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value. Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table. Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes). Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status. You can choose which type of analysis to perform by specifying the FeatureTypes list. The output is returned in a list of Block objects. AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis. For more information, see Document Text Analysis.
20
20
  */
21
21
  analyzeDocument(callback?: (err: AWSError, data: Textract.Types.AnalyzeDocumentResponse) => void): Request<Textract.Types.AnalyzeDocumentResponse, AWSError>;
22
+ /**
23
+ * Analyzes an input document for financially related relationships between text. Information is returned as ExpenseDocuments and seperated as follows. LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt. SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
24
+ */
25
+ analyzeExpense(params: Textract.Types.AnalyzeExpenseRequest, callback?: (err: AWSError, data: Textract.Types.AnalyzeExpenseResponse) => void): Request<Textract.Types.AnalyzeExpenseResponse, AWSError>;
26
+ /**
27
+ * Analyzes an input document for financially related relationships between text. Information is returned as ExpenseDocuments and seperated as follows. LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt. SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
28
+ */
29
+ analyzeExpense(callback?: (err: AWSError, data: Textract.Types.AnalyzeExpenseResponse) => void): Request<Textract.Types.AnalyzeExpenseResponse, AWSError>;
22
30
  /**
23
31
  * Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPEG or PNG format. DetectDocumentText returns the detected text in an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection.
24
32
  */
@@ -93,6 +101,16 @@ declare namespace Textract {
93
101
  */
94
102
  AnalyzeDocumentModelVersion?: String;
95
103
  }
104
+ export interface AnalyzeExpenseRequest {
105
+ Document: Document;
106
+ }
107
+ export interface AnalyzeExpenseResponse {
108
+ DocumentMetadata?: DocumentMetadata;
109
+ /**
110
+ * The expenses detected by Amazon Textract.
111
+ */
112
+ ExpenseDocuments?: ExpenseDocumentList;
113
+ }
96
114
  export interface Block {
97
115
  /**
98
116
  * The type of text item that's recognized. In operations for text detection, the following types are returned: PAGE - Contains a list of the LINE Block objects that are detected on a document page. WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child Block objects that are detected on a document page. KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object. WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces. LINE - A string of tab-delimited, contiguous words that are detected on a document page. TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each. CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell. SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
@@ -219,6 +237,61 @@ declare namespace Textract {
219
237
  export type EntityType = "KEY"|"VALUE"|string;
220
238
  export type EntityTypes = EntityType[];
221
239
  export type ErrorCode = string;
240
+ export interface ExpenseDetection {
241
+ /**
242
+ * The word or line of text recognized by Amazon Textract
243
+ */
244
+ Text?: String;
245
+ Geometry?: Geometry;
246
+ /**
247
+ * The confidence in detection, as a percentage
248
+ */
249
+ Confidence?: Percent;
250
+ }
251
+ export interface ExpenseDocument {
252
+ /**
253
+ * Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
254
+ */
255
+ ExpenseIndex?: UInteger;
256
+ /**
257
+ * Any information found outside of a table by Amazon Textract.
258
+ */
259
+ SummaryFields?: ExpenseFieldList;
260
+ /**
261
+ * Information detected on each table of a document, seperated into LineItems.
262
+ */
263
+ LineItemGroups?: LineItemGroupList;
264
+ }
265
+ export type ExpenseDocumentList = ExpenseDocument[];
266
+ export interface ExpenseField {
267
+ /**
268
+ * The implied label of a detected element. Present alongside LabelDetection for explicit elements.
269
+ */
270
+ Type?: ExpenseType;
271
+ /**
272
+ * The explicitly stated label of a detected element.
273
+ */
274
+ LabelDetection?: ExpenseDetection;
275
+ /**
276
+ * The value of a detected element. Present in explicit and implicit elements.
277
+ */
278
+ ValueDetection?: ExpenseDetection;
279
+ /**
280
+ * The page number the value was detected on.
281
+ */
282
+ PageNumber?: UInteger;
283
+ }
284
+ export type ExpenseFieldList = ExpenseField[];
285
+ export interface ExpenseType {
286
+ /**
287
+ * The word or line of text detected by Amazon Textract.
288
+ */
289
+ Text?: String;
290
+ /**
291
+ * The confidence of accuracy, as a percentage.
292
+ */
293
+ Confidence?: Percent;
294
+ }
222
295
  export type FeatureType = "TABLES"|"FORMS"|string;
223
296
  export type FeatureTypes = FeatureType[];
224
297
  export type Float = number;
@@ -366,6 +439,24 @@ declare namespace Textract {
366
439
  export type JobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"PARTIAL_SUCCESS"|string;
367
440
  export type JobTag = string;
368
441
  export type KMSKeyId = string;
442
+ export interface LineItemFields {
443
+ /**
444
+ * ExpenseFields used to show information from detected lines on a table.
445
+ */
446
+ LineItemExpenseFields?: ExpenseFieldList;
447
+ }
448
+ export interface LineItemGroup {
449
+ /**
450
+ * The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.
451
+ */
452
+ LineItemGroupIndex?: UInteger;
453
+ /**
454
+ * The breakdown of information on a particular line of a table.
455
+ */
456
+ LineItems?: LineItemList;
457
+ }
458
+ export type LineItemGroupList = LineItemGroup[];
459
+ export type LineItemList = LineItemFields[];
369
460
  export type MaxResults = number;
370
461
  export type NonEmptyString = string;
371
462
  export interface NotificationChannel {
@@ -418,7 +509,7 @@ declare namespace Textract {
418
509
  export type S3Bucket = string;
419
510
  export interface S3Object {
420
511
  /**
421
- * The name of the S3 bucket.
512
+ * The name of the S3 bucket. Note that the # character is not valid in the file name.
422
513
  */
423
514
  Bucket?: S3Bucket;
424
515
  /**
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.953.0',
86
+ VERSION: '2.954.0',
87
87
 
88
88
  /**
89
89
  * @api private