@aws-sdk/client-sagemaker-geospatial 3.379.1 → 3.385.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.
@@ -166,6 +166,7 @@ export type AlgorithmNameResampling = (typeof AlgorithmNameResampling)[keyof typ
166
166
  */
167
167
  export interface MultiPolygonGeometryInput {
168
168
  /**
169
+ * @public
169
170
  * <p>The coordinates of the multipolygon geometry.</p>
170
171
  */
171
172
  Coordinates: number[][][][] | undefined;
@@ -176,6 +177,7 @@ export interface MultiPolygonGeometryInput {
176
177
  */
177
178
  export interface PolygonGeometryInput {
178
179
  /**
180
+ * @public
179
181
  * <p>Coordinates representing a Polygon based on the <a href="https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6">GeoJson spec</a>.</p>
180
182
  */
181
183
  Coordinates: number[][][] | undefined;
@@ -190,6 +192,7 @@ export type AreaOfInterestGeometry = AreaOfInterestGeometry.MultiPolygonGeometry
190
192
  */
191
193
  export declare namespace AreaOfInterestGeometry {
192
194
  /**
195
+ * @public
193
196
  * <p>The structure representing Polygon Geometry.</p>
194
197
  */
195
198
  interface PolygonGeometryMember {
@@ -198,6 +201,7 @@ export declare namespace AreaOfInterestGeometry {
198
201
  $unknown?: never;
199
202
  }
200
203
  /**
204
+ * @public
201
205
  * <p>The structure representing the MultiPolygon Geometry.</p>
202
206
  */
203
207
  interface MultiPolygonGeometryMember {
@@ -205,6 +209,9 @@ export declare namespace AreaOfInterestGeometry {
205
209
  MultiPolygonGeometry: MultiPolygonGeometryInput;
206
210
  $unknown?: never;
207
211
  }
212
+ /**
213
+ * @public
214
+ */
208
215
  interface $UnknownMember {
209
216
  PolygonGeometry?: never;
210
217
  MultiPolygonGeometry?: never;
@@ -227,12 +234,16 @@ export type AreaOfInterest = AreaOfInterest.AreaOfInterestGeometryMember | AreaO
227
234
  */
228
235
  export declare namespace AreaOfInterest {
229
236
  /**
237
+ * @public
230
238
  * <p>A GeoJSON object representing the geographic extent in the coordinate space.</p>
231
239
  */
232
240
  interface AreaOfInterestGeometryMember {
233
241
  AreaOfInterestGeometry: AreaOfInterestGeometry;
234
242
  $unknown?: never;
235
243
  }
244
+ /**
245
+ * @public
246
+ */
236
247
  interface $UnknownMember {
237
248
  AreaOfInterestGeometry?: never;
238
249
  $unknown: [string, any];
@@ -249,6 +260,7 @@ export declare namespace AreaOfInterest {
249
260
  */
250
261
  export interface AssetValue {
251
262
  /**
263
+ * @public
252
264
  * <p>Link to the asset object.</p>
253
265
  */
254
266
  Href?: string;
@@ -289,14 +301,17 @@ export type OutputType = (typeof OutputType)[keyof typeof OutputType];
289
301
  */
290
302
  export interface Operation {
291
303
  /**
304
+ * @public
292
305
  * <p>The name of the operation.</p>
293
306
  */
294
307
  Name: string | undefined;
295
308
  /**
309
+ * @public
296
310
  * <p>Textual representation of the math operation; Equation used to compute the spectral index.</p>
297
311
  */
298
312
  Equation: string | undefined;
299
313
  /**
314
+ * @public
300
315
  * <p>The type of the operation.</p>
301
316
  */
302
317
  OutputType?: OutputType | string;
@@ -307,6 +322,7 @@ export interface Operation {
307
322
  */
308
323
  export interface CustomIndicesInput {
309
324
  /**
325
+ * @public
310
326
  * <p>A list of BandMath indices to compute.</p>
311
327
  */
312
328
  Operations?: Operation[];
@@ -318,12 +334,14 @@ export interface CustomIndicesInput {
318
334
  */
319
335
  export interface BandMathConfigInput {
320
336
  /**
337
+ * @public
321
338
  * <p>One or many of the supported predefined indices to compute.
322
339
  * Allowed values: <code>NDVI</code>, <code>EVI2</code>, <code>MSAVI</code>,
323
340
  * <code>NDWI</code>, <code>NDMI</code>, <code>NDSI</code>, and <code>WDRVI</code>.</p>
324
341
  */
325
342
  PredefinedIndices?: string[];
326
343
  /**
344
+ * @public
327
345
  * <p>CustomIndices that are computed.</p>
328
346
  */
329
347
  CustomIndices?: CustomIndicesInput;
@@ -340,14 +358,17 @@ export interface CloudMaskingConfigInput {
340
358
  */
341
359
  export interface CloudRemovalConfigInput {
342
360
  /**
361
+ * @public
343
362
  * <p>The name of the algorithm used for cloud removal.</p>
344
363
  */
345
364
  AlgorithmName?: AlgorithmNameCloudRemoval | string;
346
365
  /**
366
+ * @public
347
367
  * <p>The interpolation value you provide for cloud removal.</p>
348
368
  */
349
369
  InterpolationValue?: string;
350
370
  /**
371
+ * @public
351
372
  * <p>TargetBands to be returned in the output of CloudRemoval operation.</p>
352
373
  */
353
374
  TargetBands?: string[];
@@ -383,6 +404,7 @@ export declare class ConflictException extends __BaseException {
383
404
  readonly $fault: "client";
384
405
  Message: string | undefined;
385
406
  /**
407
+ * @public
386
408
  * <p>Identifier of the resource affected.</p>
387
409
  */
388
410
  ResourceId?: string;
@@ -397,18 +419,22 @@ export declare class ConflictException extends __BaseException {
397
419
  */
398
420
  export interface Filter {
399
421
  /**
422
+ * @public
400
423
  * <p>The name of the filter.</p>
401
424
  */
402
425
  Name: string | undefined;
403
426
  /**
427
+ * @public
404
428
  * <p>The type of the filter being used.</p>
405
429
  */
406
430
  Type: string | undefined;
407
431
  /**
432
+ * @public
408
433
  * <p>The minimum value of the filter.</p>
409
434
  */
410
435
  Minimum?: number;
411
436
  /**
437
+ * @public
412
438
  * <p>The maximum value of the filter.</p>
413
439
  */
414
440
  Maximum?: number;
@@ -441,30 +467,37 @@ export type DataCollectionType = (typeof DataCollectionType)[keyof typeof DataCo
441
467
  */
442
468
  export interface RasterDataCollectionMetadata {
443
469
  /**
470
+ * @public
444
471
  * <p>The name of the raster data collection.</p>
445
472
  */
446
473
  Name: string | undefined;
447
474
  /**
475
+ * @public
448
476
  * <p>The Amazon Resource Name (ARN) of the raster data collection.</p>
449
477
  */
450
478
  Arn: string | undefined;
451
479
  /**
480
+ * @public
452
481
  * <p>The type of raster data collection.</p>
453
482
  */
454
483
  Type: DataCollectionType | string | undefined;
455
484
  /**
485
+ * @public
456
486
  * <p>A description of the raster data collection.</p>
457
487
  */
458
488
  Description: string | undefined;
459
489
  /**
490
+ * @public
460
491
  * <p>The description URL of the raster data collection.</p>
461
492
  */
462
493
  DescriptionPageUrl?: string;
463
494
  /**
495
+ * @public
464
496
  * <p>The list of filters supported by the raster data collection.</p>
465
497
  */
466
498
  SupportedFilters: Filter[] | undefined;
467
499
  /**
500
+ * @public
468
501
  * <p>Each tag consists of a key and a value.</p>
469
502
  */
470
503
  Tags?: Record<string, string>;
@@ -474,6 +507,7 @@ export interface RasterDataCollectionMetadata {
474
507
  */
475
508
  export interface DeleteEarthObservationJobInput {
476
509
  /**
510
+ * @public
477
511
  * <p>The Amazon Resource Name (ARN) of the Earth Observation job being deleted.</p>
478
512
  */
479
513
  Arn: string | undefined;
@@ -492,6 +526,7 @@ export declare class InternalServerException extends __BaseException {
492
526
  readonly $fault: "server";
493
527
  Message: string | undefined;
494
528
  /**
529
+ * @public
495
530
  * <p/>
496
531
  */
497
532
  ResourceId?: string;
@@ -509,6 +544,7 @@ export declare class ResourceNotFoundException extends __BaseException {
509
544
  readonly $fault: "client";
510
545
  Message: string | undefined;
511
546
  /**
547
+ * @public
512
548
  * <p>Identifier of the resource that was not found.</p>
513
549
  */
514
550
  ResourceId?: string;
@@ -526,6 +562,7 @@ export declare class ThrottlingException extends __BaseException {
526
562
  readonly $fault: "client";
527
563
  Message: string | undefined;
528
564
  /**
565
+ * @public
529
566
  * <p/>
530
567
  */
531
568
  ResourceId?: string;
@@ -543,6 +580,7 @@ export declare class ValidationException extends __BaseException {
543
580
  readonly $fault: "client";
544
581
  Message: string | undefined;
545
582
  /**
583
+ * @public
546
584
  * <p/>
547
585
  */
548
586
  ResourceId?: string;
@@ -556,6 +594,7 @@ export declare class ValidationException extends __BaseException {
556
594
  */
557
595
  export interface DeleteVectorEnrichmentJobInput {
558
596
  /**
597
+ * @public
559
598
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.</p>
560
599
  */
561
600
  Arn: string | undefined;
@@ -571,10 +610,12 @@ export interface DeleteVectorEnrichmentJobOutput {
571
610
  */
572
611
  export interface ExportS3DataInput {
573
612
  /**
613
+ * @public
574
614
  * <p>The URL to the Amazon S3 data input.</p>
575
615
  */
576
616
  S3Uri: string | undefined;
577
617
  /**
618
+ * @public
578
619
  * <p>The Key Management Service key ID for server-side encryption.</p>
579
620
  */
580
621
  KmsKeyId?: string;
@@ -585,6 +626,7 @@ export interface ExportS3DataInput {
585
626
  */
586
627
  export interface OutputConfigInput {
587
628
  /**
629
+ * @public
588
630
  * <p>Path to Amazon S3 storage location for the output configuration file.</p>
589
631
  */
590
632
  S3Data: ExportS3DataInput | undefined;
@@ -594,22 +636,27 @@ export interface OutputConfigInput {
594
636
  */
595
637
  export interface ExportEarthObservationJobInput {
596
638
  /**
639
+ * @public
597
640
  * <p>The input Amazon Resource Name (ARN) of the Earth Observation job being exported.</p>
598
641
  */
599
642
  Arn: string | undefined;
600
643
  /**
644
+ * @public
601
645
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
602
646
  */
603
647
  ClientToken?: string;
604
648
  /**
649
+ * @public
605
650
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
606
651
  */
607
652
  ExecutionRoleArn: string | undefined;
608
653
  /**
654
+ * @public
609
655
  * <p>An object containing information about the output file.</p>
610
656
  */
611
657
  OutputConfig: OutputConfigInput | undefined;
612
658
  /**
659
+ * @public
613
660
  * <p>The source images provided to the Earth Observation job being exported.</p>
614
661
  */
615
662
  ExportSourceImages?: boolean;
@@ -641,26 +688,32 @@ export type EarthObservationJobExportStatus = (typeof EarthObservationJobExportS
641
688
  */
642
689
  export interface ExportEarthObservationJobOutput {
643
690
  /**
691
+ * @public
644
692
  * <p>The output Amazon Resource Name (ARN) of the Earth Observation job being exported.</p>
645
693
  */
646
694
  Arn: string | undefined;
647
695
  /**
696
+ * @public
648
697
  * <p>The creation time.</p>
649
698
  */
650
699
  CreationTime: Date | undefined;
651
700
  /**
701
+ * @public
652
702
  * <p>The status of the results of the Earth Observation job being exported.</p>
653
703
  */
654
704
  ExportStatus: EarthObservationJobExportStatus | string | undefined;
655
705
  /**
706
+ * @public
656
707
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
657
708
  */
658
709
  ExecutionRoleArn: string | undefined;
659
710
  /**
711
+ * @public
660
712
  * <p>An object containing information about the output file.</p>
661
713
  */
662
714
  OutputConfig: OutputConfigInput | undefined;
663
715
  /**
716
+ * @public
664
717
  * <p>The source images provided to the Earth Observation job being exported.</p>
665
718
  */
666
719
  ExportSourceImages?: boolean;
@@ -674,6 +727,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
674
727
  readonly $fault: "client";
675
728
  Message: string | undefined;
676
729
  /**
730
+ * @public
677
731
  * <p>Identifier of the resource affected.</p>
678
732
  */
679
733
  ResourceId?: string;
@@ -687,6 +741,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
687
741
  */
688
742
  export interface GetEarthObservationJobInput {
689
743
  /**
744
+ * @public
690
745
  * <p>The Amazon Resource Name (ARN) of the Earth Observation job.</p>
691
746
  */
692
747
  Arn: string | undefined;
@@ -715,10 +770,12 @@ export type EarthObservationJobErrorType = (typeof EarthObservationJobErrorType)
715
770
  */
716
771
  export interface EarthObservationJobErrorDetails {
717
772
  /**
773
+ * @public
718
774
  * <p>The type of error in an Earth Observation job.</p>
719
775
  */
720
776
  Type?: EarthObservationJobErrorType | string;
721
777
  /**
778
+ * @public
722
779
  * <p>A detailed message describing the error in an Earth Observation job.</p>
723
780
  */
724
781
  Message?: string;
@@ -747,10 +804,12 @@ export type ExportErrorType = (typeof ExportErrorType)[keyof typeof ExportErrorT
747
804
  */
748
805
  export interface ExportErrorDetailsOutput {
749
806
  /**
807
+ * @public
750
808
  * <p>The type of error in an export EarthObservationJob operation.</p>
751
809
  */
752
810
  Type?: ExportErrorType | string;
753
811
  /**
812
+ * @public
754
813
  * <p>A detailed message describing the error in an export EarthObservationJob operation.</p>
755
814
  */
756
815
  Message?: string;
@@ -761,10 +820,12 @@ export interface ExportErrorDetailsOutput {
761
820
  */
762
821
  export interface ExportErrorDetails {
763
822
  /**
823
+ * @public
764
824
  * <p>The structure for returning the export error details while exporting results of an Earth Observation job.</p>
765
825
  */
766
826
  ExportResults?: ExportErrorDetailsOutput;
767
827
  /**
828
+ * @public
768
829
  * <p>The structure for returning the export error details
769
830
  * while exporting the source images of an Earth Observation job.</p>
770
831
  */
@@ -790,10 +851,12 @@ export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOpera
790
851
  */
791
852
  export interface EoCloudCoverInput {
792
853
  /**
854
+ * @public
793
855
  * <p>Lower bound for EoCloudCover.</p>
794
856
  */
795
857
  LowerBound: number | undefined;
796
858
  /**
859
+ * @public
797
860
  * <p>Upper bound for EoCloudCover.</p>
798
861
  */
799
862
  UpperBound: number | undefined;
@@ -804,11 +867,13 @@ export interface EoCloudCoverInput {
804
867
  */
805
868
  export interface LandsatCloudCoverLandInput {
806
869
  /**
870
+ * @public
807
871
  * <p>The minimum value for Land Cloud Cover property filter. This will filter items
808
872
  * having Land Cloud Cover greater than or equal to this value.</p>
809
873
  */
810
874
  LowerBound: number | undefined;
811
875
  /**
876
+ * @public
812
877
  * <p>The maximum value for Land Cloud Cover property filter.
813
878
  * This will filter items having Land Cloud Cover less than or equal to this value.</p>
814
879
  */
@@ -822,10 +887,12 @@ export interface LandsatCloudCoverLandInput {
822
887
  */
823
888
  export interface PlatformInput {
824
889
  /**
890
+ * @public
825
891
  * <p>The value of the platform.</p>
826
892
  */
827
893
  Value: string | undefined;
828
894
  /**
895
+ * @public
829
896
  * <p>The ComparisonOperator to use with PlatformInput.</p>
830
897
  */
831
898
  ComparisonOperator?: ComparisonOperator | string;
@@ -838,11 +905,13 @@ export interface PlatformInput {
838
905
  */
839
906
  export interface ViewOffNadirInput {
840
907
  /**
908
+ * @public
841
909
  * <p>The minimum value for ViewOffNadir property filter.
842
910
  * This filters items having ViewOffNadir greater than or equal to this value. </p>
843
911
  */
844
912
  LowerBound: number | undefined;
845
913
  /**
914
+ * @public
846
915
  * <p>The maximum value for ViewOffNadir property filter.
847
916
  * This filters items having ViewOffNadir lesser than or equal to this value.</p>
848
917
  */
@@ -858,11 +927,13 @@ export interface ViewOffNadirInput {
858
927
  */
859
928
  export interface ViewSunAzimuthInput {
860
929
  /**
930
+ * @public
861
931
  * <p>The minimum value for ViewSunAzimuth property filter.
862
932
  * This filters items having ViewSunAzimuth greater than or equal to this value.</p>
863
933
  */
864
934
  LowerBound: number | undefined;
865
935
  /**
936
+ * @public
866
937
  * <p>The maximum value for ViewSunAzimuth property filter.
867
938
  * This filters items having ViewSunAzimuth lesser than or equal to this value.</p>
868
939
  */
@@ -874,10 +945,12 @@ export interface ViewSunAzimuthInput {
874
945
  */
875
946
  export interface ViewSunElevationInput {
876
947
  /**
948
+ * @public
877
949
  * <p>The lower bound to view the sun elevation.</p>
878
950
  */
879
951
  LowerBound: number | undefined;
880
952
  /**
953
+ * @public
881
954
  * <p>The upper bound to view the sun elevation.</p>
882
955
  */
883
956
  UpperBound: number | undefined;
@@ -892,6 +965,7 @@ export type Property = Property.EoCloudCoverMember | Property.LandsatCloudCoverL
892
965
  */
893
966
  export declare namespace Property {
894
967
  /**
968
+ * @public
895
969
  * <p>The structure representing EoCloudCover property filter containing a lower bound and upper bound.</p>
896
970
  */
897
971
  interface EoCloudCoverMember {
@@ -904,6 +978,7 @@ export declare namespace Property {
904
978
  $unknown?: never;
905
979
  }
906
980
  /**
981
+ * @public
907
982
  * <p>The structure representing ViewOffNadir property filter containing a lower bound and upper bound.</p>
908
983
  */
909
984
  interface ViewOffNadirMember {
@@ -916,6 +991,7 @@ export declare namespace Property {
916
991
  $unknown?: never;
917
992
  }
918
993
  /**
994
+ * @public
919
995
  * <p>The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.</p>
920
996
  */
921
997
  interface ViewSunAzimuthMember {
@@ -928,6 +1004,7 @@ export declare namespace Property {
928
1004
  $unknown?: never;
929
1005
  }
930
1006
  /**
1007
+ * @public
931
1008
  * <p>The structure representing ViewSunElevation property filter containing a lower bound and upper bound.</p>
932
1009
  */
933
1010
  interface ViewSunElevationMember {
@@ -940,6 +1017,7 @@ export declare namespace Property {
940
1017
  $unknown?: never;
941
1018
  }
942
1019
  /**
1020
+ * @public
943
1021
  * <p>The structure representing Platform property filter consisting of value and comparison operator.</p>
944
1022
  */
945
1023
  interface PlatformMember {
@@ -952,6 +1030,7 @@ export declare namespace Property {
952
1030
  $unknown?: never;
953
1031
  }
954
1032
  /**
1033
+ * @public
955
1034
  * <p>The structure representing Land Cloud Cover property filter
956
1035
  * for Landsat collection containing a lower bound and upper bound.</p>
957
1036
  */
@@ -964,6 +1043,9 @@ export declare namespace Property {
964
1043
  LandsatCloudCoverLand: LandsatCloudCoverLandInput;
965
1044
  $unknown?: never;
966
1045
  }
1046
+ /**
1047
+ * @public
1048
+ */
967
1049
  interface $UnknownMember {
968
1050
  EoCloudCover?: never;
969
1051
  ViewOffNadir?: never;
@@ -990,6 +1072,7 @@ export declare namespace Property {
990
1072
  */
991
1073
  export interface PropertyFilter {
992
1074
  /**
1075
+ * @public
993
1076
  * <p>Represents a single property to match with when searching a raster data collection.</p>
994
1077
  */
995
1078
  Property: Property | undefined;
@@ -1000,10 +1083,12 @@ export interface PropertyFilter {
1000
1083
  */
1001
1084
  export interface PropertyFilters {
1002
1085
  /**
1086
+ * @public
1003
1087
  * <p>A list of Property Filters.</p>
1004
1088
  */
1005
1089
  Properties?: PropertyFilter[];
1006
1090
  /**
1091
+ * @public
1007
1092
  * <p>The Logical Operator used to combine the Property Filters.</p>
1008
1093
  */
1009
1094
  LogicalOperator?: LogicalOperator | string;
@@ -1014,10 +1099,12 @@ export interface PropertyFilters {
1014
1099
  */
1015
1100
  export interface TimeRangeFilterOutput {
1016
1101
  /**
1102
+ * @public
1017
1103
  * <p>The starting time for the time range filter.</p>
1018
1104
  */
1019
1105
  StartTime: Date | undefined;
1020
1106
  /**
1107
+ * @public
1021
1108
  * <p>The ending time for the time range filter.</p>
1022
1109
  */
1023
1110
  EndTime: Date | undefined;
@@ -1029,22 +1116,27 @@ export interface TimeRangeFilterOutput {
1029
1116
  */
1030
1117
  export interface RasterDataCollectionQueryOutput {
1031
1118
  /**
1119
+ * @public
1032
1120
  * <p>The ARN of the Raster Data Collection against which the search is done.</p>
1033
1121
  */
1034
1122
  RasterDataCollectionArn: string | undefined;
1035
1123
  /**
1124
+ * @public
1036
1125
  * <p>The name of the raster data collection.</p>
1037
1126
  */
1038
1127
  RasterDataCollectionName: string | undefined;
1039
1128
  /**
1129
+ * @public
1040
1130
  * <p>The TimeRange filter used in the search.</p>
1041
1131
  */
1042
1132
  TimeRangeFilter: TimeRangeFilterOutput | undefined;
1043
1133
  /**
1134
+ * @public
1044
1135
  * <p>The Area of Interest used in the search.</p>
1045
1136
  */
1046
1137
  AreaOfInterest?: AreaOfInterest;
1047
1138
  /**
1139
+ * @public
1048
1140
  * <p>Property filters used in the search.</p>
1049
1141
  */
1050
1142
  PropertyFilters?: PropertyFilters;
@@ -1055,10 +1147,12 @@ export interface RasterDataCollectionQueryOutput {
1055
1147
  */
1056
1148
  export interface InputConfigOutput {
1057
1149
  /**
1150
+ * @public
1058
1151
  * <p>The Amazon Resource Name (ARN) of the previous Earth Observation job.</p>
1059
1152
  */
1060
1153
  PreviousEarthObservationJobArn?: string;
1061
1154
  /**
1155
+ * @public
1062
1156
  * <p>The structure representing the RasterDataCollection Query consisting of the Area of Interest,
1063
1157
  * RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.</p>
1064
1158
  */
@@ -1070,10 +1164,12 @@ export interface InputConfigOutput {
1070
1164
  */
1071
1165
  export interface GeoMosaicConfigInput {
1072
1166
  /**
1167
+ * @public
1073
1168
  * <p>The name of the algorithm being used for geomosaic.</p>
1074
1169
  */
1075
1170
  AlgorithmName?: AlgorithmNameGeoMosaic | string;
1076
1171
  /**
1172
+ * @public
1077
1173
  * <p>The target bands for geomosaic.</p>
1078
1174
  */
1079
1175
  TargetBands?: string[];
@@ -1105,10 +1201,12 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
1105
1201
  */
1106
1202
  export interface UserDefined {
1107
1203
  /**
1204
+ * @public
1108
1205
  * <p>The value for output resolution of the result.</p>
1109
1206
  */
1110
1207
  Value: number | undefined;
1111
1208
  /**
1209
+ * @public
1112
1210
  * <p>The units for output resolution of the result.</p>
1113
1211
  */
1114
1212
  Unit: Unit | string | undefined;
@@ -1120,6 +1218,7 @@ export interface UserDefined {
1120
1218
  */
1121
1219
  export interface OutputResolutionResamplingInput {
1122
1220
  /**
1221
+ * @public
1123
1222
  * <p>User Defined Resolution for the output
1124
1223
  * of Resampling operation defined by value and unit.</p>
1125
1224
  */
@@ -1131,15 +1230,18 @@ export interface OutputResolutionResamplingInput {
1131
1230
  */
1132
1231
  export interface ResamplingConfigInput {
1133
1232
  /**
1233
+ * @public
1134
1234
  * <p>The structure representing output
1135
1235
  * resolution (in target georeferenced units) of the result of resampling operation.</p>
1136
1236
  */
1137
1237
  OutputResolution: OutputResolutionResamplingInput | undefined;
1138
1238
  /**
1239
+ * @public
1139
1240
  * <p>The name of the algorithm used for resampling.</p>
1140
1241
  */
1141
1242
  AlgorithmName?: AlgorithmNameResampling | string;
1142
1243
  /**
1244
+ * @public
1143
1245
  * <p>Bands used in the operation. If no target bands are specified, it uses all bands available in the input.</p>
1144
1246
  */
1145
1247
  TargetBands?: string[];
@@ -1172,10 +1274,12 @@ export type PredefinedResolution = (typeof PredefinedResolution)[keyof typeof Pr
1172
1274
  */
1173
1275
  export interface OutputResolutionStackInput {
1174
1276
  /**
1277
+ * @public
1175
1278
  * <p>A string value representing Predefined Output Resolution for a stacking operation. Allowed values are <code>HIGHEST</code>, <code>LOWEST</code>, and <code>AVERAGE</code>.</p>
1176
1279
  */
1177
1280
  Predefined?: PredefinedResolution | string;
1178
1281
  /**
1282
+ * @public
1179
1283
  * <p>The structure representing User Output Resolution for a Stacking operation defined as a value and unit.</p>
1180
1284
  */
1181
1285
  UserDefined?: UserDefined;
@@ -1186,12 +1290,14 @@ export interface OutputResolutionStackInput {
1186
1290
  */
1187
1291
  export interface StackConfigInput {
1188
1292
  /**
1293
+ * @public
1189
1294
  * <p>The structure representing output
1190
1295
  * resolution (in target georeferenced units) of the
1191
1296
  * result of stacking operation.</p>
1192
1297
  */
1193
1298
  OutputResolution?: OutputResolutionStackInput;
1194
1299
  /**
1300
+ * @public
1195
1301
  * <p>A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.</p>
1196
1302
  */
1197
1303
  TargetBands?: string[];
@@ -1242,14 +1348,17 @@ export type TemporalStatistics = (typeof TemporalStatistics)[keyof typeof Tempor
1242
1348
  */
1243
1349
  export interface TemporalStatisticsConfigInput {
1244
1350
  /**
1351
+ * @public
1245
1352
  * <p>The input for the temporal statistics grouping by time frequency option.</p>
1246
1353
  */
1247
1354
  GroupBy?: GroupBy | string;
1248
1355
  /**
1356
+ * @public
1249
1357
  * <p>The list of the statistics method options.</p>
1250
1358
  */
1251
1359
  Statistics: (TemporalStatistics | string)[] | undefined;
1252
1360
  /**
1361
+ * @public
1253
1362
  * <p>The list of target band names for the temporal statistic to calculate.</p>
1254
1363
  */
1255
1364
  TargetBands?: string[];
@@ -1294,19 +1403,23 @@ export type ZonalStatistics = (typeof ZonalStatistics)[keyof typeof ZonalStatist
1294
1403
  */
1295
1404
  export interface ZonalStatisticsConfigInput {
1296
1405
  /**
1406
+ * @public
1297
1407
  * <p>The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.</p>
1298
1408
  */
1299
1409
  ZoneS3Path: string | undefined;
1300
1410
  /**
1411
+ * @public
1301
1412
  * <p>List of zonal statistics to compute.</p>
1302
1413
  */
1303
1414
  Statistics: (ZonalStatistics | string)[] | undefined;
1304
1415
  /**
1416
+ * @public
1305
1417
  * <p>Bands used in the operation.
1306
1418
  * If no target bands are specified, it uses all bands available input.</p>
1307
1419
  */
1308
1420
  TargetBands?: string[];
1309
1421
  /**
1422
+ * @public
1310
1423
  * <p>The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption.
1311
1424
  * The SageMaker execution role must have <code>kms:GenerateDataKey</code> permission.</p>
1312
1425
  * <p>The <code>KmsKeyId</code> can be any of the following formats:</p>
@@ -1340,6 +1453,7 @@ export type JobConfigInput = JobConfigInput.BandMathConfigMember | JobConfigInpu
1340
1453
  */
1341
1454
  export declare namespace JobConfigInput {
1342
1455
  /**
1456
+ * @public
1343
1457
  * <p>An object containing information about the job configuration for BandMath.</p>
1344
1458
  */
1345
1459
  interface BandMathConfigMember {
@@ -1355,6 +1469,7 @@ export declare namespace JobConfigInput {
1355
1469
  $unknown?: never;
1356
1470
  }
1357
1471
  /**
1472
+ * @public
1358
1473
  * <p>An object containing information about the job configuration for resampling.</p>
1359
1474
  */
1360
1475
  interface ResamplingConfigMember {
@@ -1370,6 +1485,7 @@ export declare namespace JobConfigInput {
1370
1485
  $unknown?: never;
1371
1486
  }
1372
1487
  /**
1488
+ * @public
1373
1489
  * <p>An object containing information about the job configuration for temporal statistics.</p>
1374
1490
  */
1375
1491
  interface TemporalStatisticsConfigMember {
@@ -1385,6 +1501,7 @@ export declare namespace JobConfigInput {
1385
1501
  $unknown?: never;
1386
1502
  }
1387
1503
  /**
1504
+ * @public
1388
1505
  * <p>An object containing information about the job configuration for cloud removal.</p>
1389
1506
  */
1390
1507
  interface CloudRemovalConfigMember {
@@ -1400,6 +1517,7 @@ export declare namespace JobConfigInput {
1400
1517
  $unknown?: never;
1401
1518
  }
1402
1519
  /**
1520
+ * @public
1403
1521
  * <p>An object containing information about the job configuration for zonal statistics.</p>
1404
1522
  */
1405
1523
  interface ZonalStatisticsConfigMember {
@@ -1415,6 +1533,7 @@ export declare namespace JobConfigInput {
1415
1533
  $unknown?: never;
1416
1534
  }
1417
1535
  /**
1536
+ * @public
1418
1537
  * <p>An object containing information about the job configuration for geomosaic.</p>
1419
1538
  */
1420
1539
  interface GeoMosaicConfigMember {
@@ -1430,6 +1549,7 @@ export declare namespace JobConfigInput {
1430
1549
  $unknown?: never;
1431
1550
  }
1432
1551
  /**
1552
+ * @public
1433
1553
  * <p>An object containing information about the job configuration for a Stacking Earth Observation job.</p>
1434
1554
  */
1435
1555
  interface StackConfigMember {
@@ -1445,6 +1565,7 @@ export declare namespace JobConfigInput {
1445
1565
  $unknown?: never;
1446
1566
  }
1447
1567
  /**
1568
+ * @public
1448
1569
  * <p>An object containing information about the job configuration for cloud masking.</p>
1449
1570
  */
1450
1571
  interface CloudMaskingConfigMember {
@@ -1460,6 +1581,7 @@ export declare namespace JobConfigInput {
1460
1581
  $unknown?: never;
1461
1582
  }
1462
1583
  /**
1584
+ * @public
1463
1585
  * <p>An object containing information about the job configuration for land cover segmentation.</p>
1464
1586
  */
1465
1587
  interface LandCoverSegmentationConfigMember {
@@ -1474,6 +1596,9 @@ export declare namespace JobConfigInput {
1474
1596
  LandCoverSegmentationConfig: LandCoverSegmentationConfigInput;
1475
1597
  $unknown?: never;
1476
1598
  }
1599
+ /**
1600
+ * @public
1601
+ */
1477
1602
  interface $UnknownMember {
1478
1603
  BandMathConfig?: never;
1479
1604
  ResamplingConfig?: never;
@@ -1506,10 +1631,12 @@ export declare namespace JobConfigInput {
1506
1631
  */
1507
1632
  export interface OutputBand {
1508
1633
  /**
1634
+ * @public
1509
1635
  * <p>The name of the band.</p>
1510
1636
  */
1511
1637
  BandName: string | undefined;
1512
1638
  /**
1639
+ * @public
1513
1640
  * <p>The datatype of the output band.</p>
1514
1641
  */
1515
1642
  OutputDataType: OutputType | string | undefined;
@@ -1561,58 +1688,72 @@ export type EarthObservationJobStatus = (typeof EarthObservationJobStatus)[keyof
1561
1688
  */
1562
1689
  export interface GetEarthObservationJobOutput {
1563
1690
  /**
1691
+ * @public
1564
1692
  * <p>The Amazon Resource Name (ARN) of the Earth Observation job.</p>
1565
1693
  */
1566
1694
  Arn: string | undefined;
1567
1695
  /**
1696
+ * @public
1568
1697
  * <p>The name of the Earth Observation job.</p>
1569
1698
  */
1570
1699
  Name: string | undefined;
1571
1700
  /**
1701
+ * @public
1572
1702
  * <p>The creation time of the initiated Earth Observation job.</p>
1573
1703
  */
1574
1704
  CreationTime: Date | undefined;
1575
1705
  /**
1706
+ * @public
1576
1707
  * <p>The duration of Earth Observation job, in seconds.</p>
1577
1708
  */
1578
1709
  DurationInSeconds: number | undefined;
1579
1710
  /**
1711
+ * @public
1580
1712
  * <p>The status of a previously initiated Earth Observation job.</p>
1581
1713
  */
1582
1714
  Status: EarthObservationJobStatus | string | undefined;
1583
1715
  /**
1716
+ * @public
1584
1717
  * <p>The Key Management Service key ID for server-side encryption.</p>
1585
1718
  */
1586
1719
  KmsKeyId?: string;
1587
1720
  /**
1721
+ * @public
1588
1722
  * <p>Input data for the Earth Observation job.</p>
1589
1723
  */
1590
1724
  InputConfig: InputConfigOutput | undefined;
1591
1725
  /**
1726
+ * @public
1592
1727
  * <p>An object containing information about the job configuration.</p>
1593
1728
  */
1594
1729
  JobConfig: JobConfigInput | undefined;
1595
1730
  /**
1731
+ * @public
1596
1732
  * <p>Bands available in the output of an operation.</p>
1597
1733
  */
1598
1734
  OutputBands?: OutputBand[];
1599
1735
  /**
1736
+ * @public
1600
1737
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
1601
1738
  */
1602
1739
  ExecutionRoleArn?: string;
1603
1740
  /**
1741
+ * @public
1604
1742
  * <p>Details about the errors generated during the Earth Observation job.</p>
1605
1743
  */
1606
1744
  ErrorDetails?: EarthObservationJobErrorDetails;
1607
1745
  /**
1746
+ * @public
1608
1747
  * <p>The status of the Earth Observation job.</p>
1609
1748
  */
1610
1749
  ExportStatus?: EarthObservationJobExportStatus | string;
1611
1750
  /**
1751
+ * @public
1612
1752
  * <p>Details about the errors generated during ExportEarthObservationJob.</p>
1613
1753
  */
1614
1754
  ExportErrorDetails?: ExportErrorDetails;
1615
1755
  /**
1756
+ * @public
1616
1757
  * <p>Each tag consists of a key and a value.</p>
1617
1758
  */
1618
1759
  Tags?: Record<string, string>;
@@ -1640,50 +1781,62 @@ export type TargetOptions = (typeof TargetOptions)[keyof typeof TargetOptions];
1640
1781
  */
1641
1782
  export interface GetTileInput {
1642
1783
  /**
1784
+ * @public
1643
1785
  * <p>The x coordinate of the tile input.</p>
1644
1786
  */
1645
1787
  x: number | undefined;
1646
1788
  /**
1789
+ * @public
1647
1790
  * <p>The y coordinate of the tile input.</p>
1648
1791
  */
1649
1792
  y: number | undefined;
1650
1793
  /**
1794
+ * @public
1651
1795
  * <p>The z coordinate of the tile input.</p>
1652
1796
  */
1653
1797
  z: number | undefined;
1654
1798
  /**
1799
+ * @public
1655
1800
  * <p>The particular assets or bands to tile.</p>
1656
1801
  */
1657
1802
  ImageAssets: string[] | undefined;
1658
1803
  /**
1804
+ * @public
1659
1805
  * <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
1660
1806
  */
1661
1807
  Target: TargetOptions | string | undefined;
1662
1808
  /**
1809
+ * @public
1663
1810
  * <p>The Amazon Resource Name (ARN) of the tile operation.</p>
1664
1811
  */
1665
1812
  Arn: string | undefined;
1666
1813
  /**
1814
+ * @public
1667
1815
  * <p>Determines whether or not to return a valid data mask.</p>
1668
1816
  */
1669
1817
  ImageMask?: boolean;
1670
1818
  /**
1819
+ * @public
1671
1820
  * <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
1672
1821
  */
1673
1822
  OutputFormat?: string;
1674
1823
  /**
1824
+ * @public
1675
1825
  * <p>Time range filter applied to imagery to find the images to tile.</p>
1676
1826
  */
1677
1827
  TimeRangeFilter?: string;
1678
1828
  /**
1829
+ * @public
1679
1830
  * <p>Property filters for the imagery to tile.</p>
1680
1831
  */
1681
1832
  PropertyFilters?: string;
1682
1833
  /**
1834
+ * @public
1683
1835
  * <p>The output data type of the tile operation.</p>
1684
1836
  */
1685
1837
  OutputDataType?: OutputType | string;
1686
1838
  /**
1839
+ * @public
1687
1840
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
1688
1841
  */
1689
1842
  ExecutionRoleArn?: string;
@@ -1693,6 +1846,7 @@ export interface GetTileInput {
1693
1846
  */
1694
1847
  export interface GetTileOutput {
1695
1848
  /**
1849
+ * @public
1696
1850
  * <p>The output binary file.</p>
1697
1851
  */
1698
1852
  BinaryFile?: StreamingBlobTypes;
@@ -1720,23 +1874,28 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
1720
1874
  */
1721
1875
  export interface ListEarthObservationJobInput {
1722
1876
  /**
1877
+ * @public
1723
1878
  * <p>A filter that retrieves only jobs with a specific status.</p>
1724
1879
  */
1725
1880
  StatusEquals?: EarthObservationJobStatus | string;
1726
1881
  /**
1882
+ * @public
1727
1883
  * <p>An optional value that specifies whether you want the results sorted in <code>Ascending</code> or <code>Descending</code> order.</p>
1728
1884
  */
1729
1885
  SortOrder?: SortOrder | string;
1730
1886
  /**
1887
+ * @public
1731
1888
  * <p>The parameter by which to sort the results.</p>
1732
1889
  */
1733
1890
  SortBy?: string;
1734
1891
  /**
1892
+ * @public
1735
1893
  * <p>If the previous response was truncated, you receive this token.
1736
1894
  * Use it in your next request to receive the next set of results.</p>
1737
1895
  */
1738
1896
  NextToken?: string;
1739
1897
  /**
1898
+ * @public
1740
1899
  * <p>The total number of items to return.</p>
1741
1900
  */
1742
1901
  MaxResults?: number;
@@ -1747,30 +1906,37 @@ export interface ListEarthObservationJobInput {
1747
1906
  */
1748
1907
  export interface ListEarthObservationJobOutputConfig {
1749
1908
  /**
1909
+ * @public
1750
1910
  * <p>The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.</p>
1751
1911
  */
1752
1912
  Arn: string | undefined;
1753
1913
  /**
1914
+ * @public
1754
1915
  * <p>The names of the Earth Observation jobs in the list.</p>
1755
1916
  */
1756
1917
  Name: string | undefined;
1757
1918
  /**
1919
+ * @public
1758
1920
  * <p>The creation time.</p>
1759
1921
  */
1760
1922
  CreationTime: Date | undefined;
1761
1923
  /**
1924
+ * @public
1762
1925
  * <p>The duration of the session, in seconds.</p>
1763
1926
  */
1764
1927
  DurationInSeconds: number | undefined;
1765
1928
  /**
1929
+ * @public
1766
1930
  * <p>The status of the list of the Earth Observation jobs.</p>
1767
1931
  */
1768
1932
  Status: EarthObservationJobStatus | string | undefined;
1769
1933
  /**
1934
+ * @public
1770
1935
  * <p>The operation type for an Earth Observation job.</p>
1771
1936
  */
1772
1937
  OperationType: string | undefined;
1773
1938
  /**
1939
+ * @public
1774
1940
  * <p>Each tag consists of a key and a value.</p>
1775
1941
  */
1776
1942
  Tags?: Record<string, string>;
@@ -1780,10 +1946,12 @@ export interface ListEarthObservationJobOutputConfig {
1780
1946
  */
1781
1947
  export interface ListEarthObservationJobOutput {
1782
1948
  /**
1949
+ * @public
1783
1950
  * <p>Contains summary information about the Earth Observation jobs.</p>
1784
1951
  */
1785
1952
  EarthObservationJobSummaries: ListEarthObservationJobOutputConfig[] | undefined;
1786
1953
  /**
1954
+ * @public
1787
1955
  * <p>If the previous response was truncated, you receive this token.
1788
1956
  * Use it in your next request to receive the next set of results.</p>
1789
1957
  */
@@ -1795,10 +1963,12 @@ export interface ListEarthObservationJobOutput {
1795
1963
  */
1796
1964
  export interface TimeRangeFilterInput {
1797
1965
  /**
1966
+ * @public
1798
1967
  * <p>The start time for the time-range filter.</p>
1799
1968
  */
1800
1969
  StartTime: Date | undefined;
1801
1970
  /**
1971
+ * @public
1802
1972
  * <p>The end time for the time-range filter.</p>
1803
1973
  */
1804
1974
  EndTime: Date | undefined;
@@ -1809,18 +1979,22 @@ export interface TimeRangeFilterInput {
1809
1979
  */
1810
1980
  export interface RasterDataCollectionQueryInput {
1811
1981
  /**
1982
+ * @public
1812
1983
  * <p>The Amazon Resource Name (ARN) of the raster data collection.</p>
1813
1984
  */
1814
1985
  RasterDataCollectionArn: string | undefined;
1815
1986
  /**
1987
+ * @public
1816
1988
  * <p>The TimeRange Filter used in the RasterDataCollection Query.</p>
1817
1989
  */
1818
1990
  TimeRangeFilter: TimeRangeFilterInput | undefined;
1819
1991
  /**
1992
+ * @public
1820
1993
  * <p>The area of interest being queried for the raster data collection.</p>
1821
1994
  */
1822
1995
  AreaOfInterest?: AreaOfInterest;
1823
1996
  /**
1997
+ * @public
1824
1998
  * <p>The list of Property filters used in the Raster Data Collection Query.</p>
1825
1999
  */
1826
2000
  PropertyFilters?: PropertyFilters;
@@ -1831,10 +2005,12 @@ export interface RasterDataCollectionQueryInput {
1831
2005
  */
1832
2006
  export interface InputConfigInput {
1833
2007
  /**
2008
+ * @public
1834
2009
  * <p>The Amazon Resource Name (ARN) of the previous Earth Observation job.</p>
1835
2010
  */
1836
2011
  PreviousEarthObservationJobArn?: string;
1837
2012
  /**
2013
+ * @public
1838
2014
  * <p>The structure representing the RasterDataCollection Query consisting of
1839
2015
  * the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.</p>
1840
2016
  */
@@ -1845,30 +2021,37 @@ export interface InputConfigInput {
1845
2021
  */
1846
2022
  export interface StartEarthObservationJobInput {
1847
2023
  /**
2024
+ * @public
1848
2025
  * <p>The name of the Earth Observation job.</p>
1849
2026
  */
1850
2027
  Name: string | undefined;
1851
2028
  /**
2029
+ * @public
1852
2030
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
1853
2031
  */
1854
2032
  ClientToken?: string;
1855
2033
  /**
2034
+ * @public
1856
2035
  * <p>The Key Management Service key ID for server-side encryption.</p>
1857
2036
  */
1858
2037
  KmsKeyId?: string;
1859
2038
  /**
2039
+ * @public
1860
2040
  * <p>Input configuration information for the Earth Observation job.</p>
1861
2041
  */
1862
2042
  InputConfig: InputConfigInput | undefined;
1863
2043
  /**
2044
+ * @public
1864
2045
  * <p>An object containing information about the job configuration.</p>
1865
2046
  */
1866
2047
  JobConfig: JobConfigInput | undefined;
1867
2048
  /**
2049
+ * @public
1868
2050
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
1869
2051
  */
1870
2052
  ExecutionRoleArn: string | undefined;
1871
2053
  /**
2054
+ * @public
1872
2055
  * <p>Each tag consists of a key and a value.</p>
1873
2056
  */
1874
2057
  Tags?: Record<string, string>;
@@ -1878,42 +2061,52 @@ export interface StartEarthObservationJobInput {
1878
2061
  */
1879
2062
  export interface StartEarthObservationJobOutput {
1880
2063
  /**
2064
+ * @public
1881
2065
  * <p>The name of the Earth Observation job.</p>
1882
2066
  */
1883
2067
  Name: string | undefined;
1884
2068
  /**
2069
+ * @public
1885
2070
  * <p>The Amazon Resource Name (ARN) of the Earth Observation job.</p>
1886
2071
  */
1887
2072
  Arn: string | undefined;
1888
2073
  /**
2074
+ * @public
1889
2075
  * <p>The creation time.</p>
1890
2076
  */
1891
2077
  CreationTime: Date | undefined;
1892
2078
  /**
2079
+ * @public
1893
2080
  * <p>The duration of the session, in seconds.</p>
1894
2081
  */
1895
2082
  DurationInSeconds: number | undefined;
1896
2083
  /**
2084
+ * @public
1897
2085
  * <p>The status of the Earth Observation job.</p>
1898
2086
  */
1899
2087
  Status: EarthObservationJobStatus | string | undefined;
1900
2088
  /**
2089
+ * @public
1901
2090
  * <p>The Key Management Service key ID for server-side encryption.</p>
1902
2091
  */
1903
2092
  KmsKeyId?: string;
1904
2093
  /**
2094
+ * @public
1905
2095
  * <p>Input configuration information for the Earth Observation job.</p>
1906
2096
  */
1907
2097
  InputConfig?: InputConfigOutput;
1908
2098
  /**
2099
+ * @public
1909
2100
  * <p>An object containing information about the job configuration.</p>
1910
2101
  */
1911
2102
  JobConfig: JobConfigInput | undefined;
1912
2103
  /**
2104
+ * @public
1913
2105
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
1914
2106
  */
1915
2107
  ExecutionRoleArn: string | undefined;
1916
2108
  /**
2109
+ * @public
1917
2110
  * <p>Each tag consists of a key and a value.</p>
1918
2111
  */
1919
2112
  Tags?: Record<string, string>;
@@ -1923,6 +2116,7 @@ export interface StartEarthObservationJobOutput {
1923
2116
  */
1924
2117
  export interface StopEarthObservationJobInput {
1925
2118
  /**
2119
+ * @public
1926
2120
  * <p>The Amazon Resource Name (ARN) of the Earth Observation job being stopped.</p>
1927
2121
  */
1928
2122
  Arn: string | undefined;
@@ -1938,10 +2132,12 @@ export interface StopEarthObservationJobOutput {
1938
2132
  */
1939
2133
  export interface VectorEnrichmentJobS3Data {
1940
2134
  /**
2135
+ * @public
1941
2136
  * <p>The URL to the Amazon S3 data for the Vector Enrichment job.</p>
1942
2137
  */
1943
2138
  S3Uri: string | undefined;
1944
2139
  /**
2140
+ * @public
1945
2141
  * <p>The Key Management Service key ID for server-side encryption.</p>
1946
2142
  */
1947
2143
  KmsKeyId?: string;
@@ -1952,6 +2148,7 @@ export interface VectorEnrichmentJobS3Data {
1952
2148
  */
1953
2149
  export interface ExportVectorEnrichmentJobOutputConfig {
1954
2150
  /**
2151
+ * @public
1955
2152
  * <p>The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.</p>
1956
2153
  */
1957
2154
  S3Data: VectorEnrichmentJobS3Data | undefined;
@@ -1961,18 +2158,22 @@ export interface ExportVectorEnrichmentJobOutputConfig {
1961
2158
  */
1962
2159
  export interface ExportVectorEnrichmentJobInput {
1963
2160
  /**
2161
+ * @public
1964
2162
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job.</p>
1965
2163
  */
1966
2164
  Arn: string | undefined;
1967
2165
  /**
2166
+ * @public
1968
2167
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
1969
2168
  */
1970
2169
  ClientToken?: string;
1971
2170
  /**
2171
+ * @public
1972
2172
  * <p>The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.</p>
1973
2173
  */
1974
2174
  ExecutionRoleArn: string | undefined;
1975
2175
  /**
2176
+ * @public
1976
2177
  * <p>Output location information for exporting Vector Enrichment Job results.
1977
2178
  * </p>
1978
2179
  */
@@ -1996,22 +2197,27 @@ export type VectorEnrichmentJobExportStatus = (typeof VectorEnrichmentJobExportS
1996
2197
  */
1997
2198
  export interface ExportVectorEnrichmentJobOutput {
1998
2199
  /**
2200
+ * @public
1999
2201
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.</p>
2000
2202
  */
2001
2203
  Arn: string | undefined;
2002
2204
  /**
2205
+ * @public
2003
2206
  * <p>The creation time.</p>
2004
2207
  */
2005
2208
  CreationTime: Date | undefined;
2006
2209
  /**
2210
+ * @public
2007
2211
  * <p>The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.</p>
2008
2212
  */
2009
2213
  ExecutionRoleArn: string | undefined;
2010
2214
  /**
2215
+ * @public
2011
2216
  * <p>The status of the results the Vector Enrichment job being exported.</p>
2012
2217
  */
2013
2218
  ExportStatus: VectorEnrichmentJobExportStatus | string | undefined;
2014
2219
  /**
2220
+ * @public
2015
2221
  * <p>Output location information for exporting Vector Enrichment Job results.
2016
2222
  * </p>
2017
2223
  */
@@ -2024,10 +2230,12 @@ export interface ExportVectorEnrichmentJobOutput {
2024
2230
  */
2025
2231
  export interface Geometry {
2026
2232
  /**
2233
+ * @public
2027
2234
  * <p>GeoJson Geometry types like Polygon and MultiPolygon.</p>
2028
2235
  */
2029
2236
  Type: string | undefined;
2030
2237
  /**
2238
+ * @public
2031
2239
  * <p>The coordinates of the GeoJson Geometry.</p>
2032
2240
  */
2033
2241
  Coordinates: number[][][] | undefined;
@@ -2037,6 +2245,7 @@ export interface Geometry {
2037
2245
  */
2038
2246
  export interface GetRasterDataCollectionInput {
2039
2247
  /**
2248
+ * @public
2040
2249
  * <p>The Amazon Resource Name (ARN) of the raster data collection.</p>
2041
2250
  */
2042
2251
  Arn: string | undefined;
@@ -2046,34 +2255,42 @@ export interface GetRasterDataCollectionInput {
2046
2255
  */
2047
2256
  export interface GetRasterDataCollectionOutput {
2048
2257
  /**
2258
+ * @public
2049
2259
  * <p>The name of the raster data collection.</p>
2050
2260
  */
2051
2261
  Name: string | undefined;
2052
2262
  /**
2263
+ * @public
2053
2264
  * <p>The Amazon Resource Name (ARN) of the raster data collection.</p>
2054
2265
  */
2055
2266
  Arn: string | undefined;
2056
2267
  /**
2268
+ * @public
2057
2269
  * <p>The raster data collection type.</p>
2058
2270
  */
2059
2271
  Type: DataCollectionType | string | undefined;
2060
2272
  /**
2273
+ * @public
2061
2274
  * <p>A description of the raster data collection.</p>
2062
2275
  */
2063
2276
  Description: string | undefined;
2064
2277
  /**
2278
+ * @public
2065
2279
  * <p>The URL of the description page.</p>
2066
2280
  */
2067
2281
  DescriptionPageUrl: string | undefined;
2068
2282
  /**
2283
+ * @public
2069
2284
  * <p>The filters supported by the raster data collection.</p>
2070
2285
  */
2071
2286
  SupportedFilters: Filter[] | undefined;
2072
2287
  /**
2288
+ * @public
2073
2289
  * <p>The list of image source bands in the raster data collection.</p>
2074
2290
  */
2075
2291
  ImageSourceBands: string[] | undefined;
2076
2292
  /**
2293
+ * @public
2077
2294
  * <p>Each tag consists of a key and a value.</p>
2078
2295
  */
2079
2296
  Tags?: Record<string, string>;
@@ -2083,6 +2300,7 @@ export interface GetRasterDataCollectionOutput {
2083
2300
  */
2084
2301
  export interface GetVectorEnrichmentJobInput {
2085
2302
  /**
2303
+ * @public
2086
2304
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job.</p>
2087
2305
  */
2088
2306
  Arn: string | undefined;
@@ -2111,10 +2329,12 @@ export type VectorEnrichmentJobErrorType = (typeof VectorEnrichmentJobErrorType)
2111
2329
  */
2112
2330
  export interface VectorEnrichmentJobErrorDetails {
2113
2331
  /**
2332
+ * @public
2114
2333
  * <p>The type of error generated during the Vector Enrichment job.</p>
2115
2334
  */
2116
2335
  ErrorType?: VectorEnrichmentJobErrorType | string;
2117
2336
  /**
2337
+ * @public
2118
2338
  * <p>A message that you define and then is processed and rendered by
2119
2339
  * the Vector Enrichment job when the error occurs.</p>
2120
2340
  */
@@ -2138,10 +2358,12 @@ export type VectorEnrichmentJobExportErrorType = (typeof VectorEnrichmentJobExpo
2138
2358
  */
2139
2359
  export interface VectorEnrichmentJobExportErrorDetails {
2140
2360
  /**
2361
+ * @public
2141
2362
  * <p>The output error details for an Export operation on a Vector Enrichment job.</p>
2142
2363
  */
2143
2364
  Type?: VectorEnrichmentJobExportErrorType | string;
2144
2365
  /**
2366
+ * @public
2145
2367
  * <p>The message providing details about the errors generated during the Vector Enrichment job.</p>
2146
2368
  */
2147
2369
  Message?: string;
@@ -2156,12 +2378,16 @@ export type VectorEnrichmentJobDataSourceConfigInput = VectorEnrichmentJobDataSo
2156
2378
  */
2157
2379
  export declare namespace VectorEnrichmentJobDataSourceConfigInput {
2158
2380
  /**
2381
+ * @public
2159
2382
  * <p>The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.</p>
2160
2383
  */
2161
2384
  interface S3DataMember {
2162
2385
  S3Data: VectorEnrichmentJobS3Data;
2163
2386
  $unknown?: never;
2164
2387
  }
2388
+ /**
2389
+ * @public
2390
+ */
2165
2391
  interface $UnknownMember {
2166
2392
  S3Data?: never;
2167
2393
  $unknown: [string, any];
@@ -2189,10 +2415,12 @@ export type VectorEnrichmentJobDocumentType = (typeof VectorEnrichmentJobDocumen
2189
2415
  */
2190
2416
  export interface VectorEnrichmentJobInputConfig {
2191
2417
  /**
2418
+ * @public
2192
2419
  * <p>The input structure that defines the data source file type.</p>
2193
2420
  */
2194
2421
  DocumentType: VectorEnrichmentJobDocumentType | string | undefined;
2195
2422
  /**
2423
+ * @public
2196
2424
  * <p>The input structure for the data source that represents the storage type of the input data objects.</p>
2197
2425
  */
2198
2426
  DataSourceConfig: VectorEnrichmentJobDataSourceConfigInput | undefined;
@@ -2203,18 +2431,22 @@ export interface VectorEnrichmentJobInputConfig {
2203
2431
  */
2204
2432
  export interface MapMatchingConfig {
2205
2433
  /**
2434
+ * @public
2206
2435
  * <p>The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.</p>
2207
2436
  */
2208
2437
  IdAttributeName: string | undefined;
2209
2438
  /**
2439
+ * @public
2210
2440
  * <p>The name of the Y-attribute</p>
2211
2441
  */
2212
2442
  YAttributeName: string | undefined;
2213
2443
  /**
2444
+ * @public
2214
2445
  * <p>The name of the X-attribute</p>
2215
2446
  */
2216
2447
  XAttributeName: string | undefined;
2217
2448
  /**
2449
+ * @public
2218
2450
  * <p>The name of the timestamp attribute.</p>
2219
2451
  */
2220
2452
  TimestampAttributeName: string | undefined;
@@ -2225,10 +2457,12 @@ export interface MapMatchingConfig {
2225
2457
  */
2226
2458
  export interface ReverseGeocodingConfig {
2227
2459
  /**
2460
+ * @public
2228
2461
  * <p>The field name for the data that describes y-axis coordinate, eg. latitude of a point.</p>
2229
2462
  */
2230
2463
  YAttributeName: string | undefined;
2231
2464
  /**
2465
+ * @public
2232
2466
  * <p>The field name for the data that describes x-axis coordinate, eg. longitude of a point.</p>
2233
2467
  */
2234
2468
  XAttributeName: string | undefined;
@@ -2243,6 +2477,7 @@ export type VectorEnrichmentJobConfig = VectorEnrichmentJobConfig.MapMatchingCon
2243
2477
  */
2244
2478
  export declare namespace VectorEnrichmentJobConfig {
2245
2479
  /**
2480
+ * @public
2246
2481
  * <p>The input structure for Reverse Geocoding operation type.</p>
2247
2482
  */
2248
2483
  interface ReverseGeocodingConfigMember {
@@ -2251,6 +2486,7 @@ export declare namespace VectorEnrichmentJobConfig {
2251
2486
  $unknown?: never;
2252
2487
  }
2253
2488
  /**
2489
+ * @public
2254
2490
  * <p>The input structure for Map Matching operation type.</p>
2255
2491
  */
2256
2492
  interface MapMatchingConfigMember {
@@ -2258,6 +2494,9 @@ export declare namespace VectorEnrichmentJobConfig {
2258
2494
  MapMatchingConfig: MapMatchingConfig;
2259
2495
  $unknown?: never;
2260
2496
  }
2497
+ /**
2498
+ * @public
2499
+ */
2261
2500
  interface $UnknownMember {
2262
2501
  ReverseGeocodingConfig?: never;
2263
2502
  MapMatchingConfig?: never;
@@ -2305,58 +2544,72 @@ export type VectorEnrichmentJobType = (typeof VectorEnrichmentJobType)[keyof typ
2305
2544
  */
2306
2545
  export interface GetVectorEnrichmentJobOutput {
2307
2546
  /**
2547
+ * @public
2308
2548
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job.</p>
2309
2549
  */
2310
2550
  Arn: string | undefined;
2311
2551
  /**
2552
+ * @public
2312
2553
  * <p>The type of the Vector Enrichment job being initiated.</p>
2313
2554
  */
2314
2555
  Type: VectorEnrichmentJobType | string | undefined;
2315
2556
  /**
2557
+ * @public
2316
2558
  * <p>The name of the Vector Enrichment job.</p>
2317
2559
  */
2318
2560
  Name: string | undefined;
2319
2561
  /**
2562
+ * @public
2320
2563
  * <p>The creation time.</p>
2321
2564
  */
2322
2565
  CreationTime: Date | undefined;
2323
2566
  /**
2567
+ * @public
2324
2568
  * <p>The duration of the Vector Enrichment job, in seconds.</p>
2325
2569
  */
2326
2570
  DurationInSeconds: number | undefined;
2327
2571
  /**
2572
+ * @public
2328
2573
  * <p>The status of the initiated Vector Enrichment job.</p>
2329
2574
  */
2330
2575
  Status: VectorEnrichmentJobStatus | string | undefined;
2331
2576
  /**
2577
+ * @public
2332
2578
  * <p>The Key Management Service key ID for server-side encryption.</p>
2333
2579
  */
2334
2580
  KmsKeyId?: string;
2335
2581
  /**
2582
+ * @public
2336
2583
  * <p>Input configuration information for the Vector Enrichment job.</p>
2337
2584
  */
2338
2585
  InputConfig: VectorEnrichmentJobInputConfig | undefined;
2339
2586
  /**
2587
+ * @public
2340
2588
  * <p>An object containing information about the job configuration.</p>
2341
2589
  */
2342
2590
  JobConfig: VectorEnrichmentJobConfig | undefined;
2343
2591
  /**
2592
+ * @public
2344
2593
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
2345
2594
  */
2346
2595
  ExecutionRoleArn: string | undefined;
2347
2596
  /**
2597
+ * @public
2348
2598
  * <p>Details about the errors generated during the Vector Enrichment job.</p>
2349
2599
  */
2350
2600
  ErrorDetails?: VectorEnrichmentJobErrorDetails;
2351
2601
  /**
2602
+ * @public
2352
2603
  * <p>The export status of the Vector Enrichment job being initiated.</p>
2353
2604
  */
2354
2605
  ExportStatus?: VectorEnrichmentJobExportStatus | string;
2355
2606
  /**
2607
+ * @public
2356
2608
  * <p>Details about the errors generated during the ExportVectorEnrichmentJob.</p>
2357
2609
  */
2358
2610
  ExportErrorDetails?: VectorEnrichmentJobExportErrorDetails;
2359
2611
  /**
2612
+ * @public
2360
2613
  * <p>Each tag consists of a key and a value.</p>
2361
2614
  */
2362
2615
  Tags?: Record<string, string>;
@@ -2367,24 +2620,29 @@ export interface GetVectorEnrichmentJobOutput {
2367
2620
  */
2368
2621
  export interface Properties {
2369
2622
  /**
2623
+ * @public
2370
2624
  * <p>Estimate of cloud cover.</p>
2371
2625
  */
2372
2626
  EoCloudCover?: number;
2373
2627
  /**
2628
+ * @public
2374
2629
  * <p>The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).</p>
2375
2630
  */
2376
2631
  ViewOffNadir?: number;
2377
2632
  /**
2633
+ * @public
2378
2634
  * <p>The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun.
2379
2635
  * Measured clockwise in degrees (0-360).</p>
2380
2636
  */
2381
2637
  ViewSunAzimuth?: number;
2382
2638
  /**
2639
+ * @public
2383
2640
  * <p>The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90).
2384
2641
  * Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during <a href="https://www.timeanddate.com/astronomy/different-types-twilight.html">nautical twilight</a>.</p>
2385
2642
  */
2386
2643
  ViewSunElevation?: number;
2387
2644
  /**
2645
+ * @public
2388
2646
  * <p>Platform property. Platform refers to the unique name
2389
2647
  * of the specific platform the instrument is attached to.
2390
2648
  * For satellites it is the name of
@@ -2392,6 +2650,7 @@ export interface Properties {
2392
2650
  */
2393
2651
  Platform?: string;
2394
2652
  /**
2653
+ * @public
2395
2654
  * <p>Land cloud cover for Landsat Data Collection.</p>
2396
2655
  */
2397
2656
  LandsatCloudCoverLand?: number;
@@ -2402,23 +2661,28 @@ export interface Properties {
2402
2661
  */
2403
2662
  export interface ItemSource {
2404
2663
  /**
2664
+ * @public
2405
2665
  * <p>A unique Id for the source item.</p>
2406
2666
  */
2407
2667
  Id: string | undefined;
2408
2668
  /**
2669
+ * @public
2409
2670
  * <p>The item Geometry in GeoJson format.</p>
2410
2671
  */
2411
2672
  Geometry: Geometry | undefined;
2412
2673
  /**
2674
+ * @public
2413
2675
  * <p>This is a dictionary of Asset Objects data associated with the Item that
2414
2676
  * can be downloaded or streamed, each with a unique key.</p>
2415
2677
  */
2416
2678
  Assets?: Record<string, AssetValue>;
2417
2679
  /**
2680
+ * @public
2418
2681
  * <p>The searchable date and time of the item, in UTC.</p>
2419
2682
  */
2420
2683
  DateTime: Date | undefined;
2421
2684
  /**
2685
+ * @public
2422
2686
  * <p>This field contains additional properties of the item.</p>
2423
2687
  */
2424
2688
  Properties?: Properties;
@@ -2428,11 +2692,13 @@ export interface ItemSource {
2428
2692
  */
2429
2693
  export interface ListRasterDataCollectionsInput {
2430
2694
  /**
2695
+ * @public
2431
2696
  * <p>If the previous response was truncated, you receive this token.
2432
2697
  * Use it in your next request to receive the next set of results.</p>
2433
2698
  */
2434
2699
  NextToken?: string;
2435
2700
  /**
2701
+ * @public
2436
2702
  * <p>The total number of items to return.</p>
2437
2703
  */
2438
2704
  MaxResults?: number;
@@ -2442,10 +2708,12 @@ export interface ListRasterDataCollectionsInput {
2442
2708
  */
2443
2709
  export interface ListRasterDataCollectionsOutput {
2444
2710
  /**
2711
+ * @public
2445
2712
  * <p>Contains summary information about the raster data collection.</p>
2446
2713
  */
2447
2714
  RasterDataCollectionSummaries: RasterDataCollectionMetadata[] | undefined;
2448
2715
  /**
2716
+ * @public
2449
2717
  * <p>If the previous response was truncated, you receive this token.
2450
2718
  * Use it in your next request to receive the next set of results.</p>
2451
2719
  */
@@ -2456,6 +2724,7 @@ export interface ListRasterDataCollectionsOutput {
2456
2724
  */
2457
2725
  export interface ListTagsForResourceRequest {
2458
2726
  /**
2727
+ * @public
2459
2728
  * <p>The Amazon Resource Name (ARN) of the resource you want to tag.</p>
2460
2729
  */
2461
2730
  ResourceArn: string | undefined;
@@ -2465,6 +2734,7 @@ export interface ListTagsForResourceRequest {
2465
2734
  */
2466
2735
  export interface ListTagsForResourceResponse {
2467
2736
  /**
2737
+ * @public
2468
2738
  * <p>Each tag consists of a key and a value.</p>
2469
2739
  */
2470
2740
  Tags?: Record<string, string>;
@@ -2474,23 +2744,28 @@ export interface ListTagsForResourceResponse {
2474
2744
  */
2475
2745
  export interface ListVectorEnrichmentJobInput {
2476
2746
  /**
2747
+ * @public
2477
2748
  * <p>A filter that retrieves only jobs with a specific status.</p>
2478
2749
  */
2479
2750
  StatusEquals?: string;
2480
2751
  /**
2752
+ * @public
2481
2753
  * <p>An optional value that specifies whether you want the results sorted in <code>Ascending</code> or <code>Descending</code> order.</p>
2482
2754
  */
2483
2755
  SortOrder?: SortOrder | string;
2484
2756
  /**
2757
+ * @public
2485
2758
  * <p>The parameter by which to sort the results.</p>
2486
2759
  */
2487
2760
  SortBy?: string;
2488
2761
  /**
2762
+ * @public
2489
2763
  * <p>If the previous response was truncated, you receive this token.
2490
2764
  * Use it in your next request to receive the next set of results.</p>
2491
2765
  */
2492
2766
  NextToken?: string;
2493
2767
  /**
2768
+ * @public
2494
2769
  * <p>The maximum number of items to return.</p>
2495
2770
  */
2496
2771
  MaxResults?: number;
@@ -2501,30 +2776,37 @@ export interface ListVectorEnrichmentJobInput {
2501
2776
  */
2502
2777
  export interface ListVectorEnrichmentJobOutputConfig {
2503
2778
  /**
2779
+ * @public
2504
2780
  * <p>The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.</p>
2505
2781
  */
2506
2782
  Arn: string | undefined;
2507
2783
  /**
2784
+ * @public
2508
2785
  * <p>The names of the Vector Enrichment jobs in the list.</p>
2509
2786
  */
2510
2787
  Name: string | undefined;
2511
2788
  /**
2789
+ * @public
2512
2790
  * <p>The type of the list of Vector Enrichment jobs.</p>
2513
2791
  */
2514
2792
  Type: VectorEnrichmentJobType | string | undefined;
2515
2793
  /**
2794
+ * @public
2516
2795
  * <p>The creation time.</p>
2517
2796
  */
2518
2797
  CreationTime: Date | undefined;
2519
2798
  /**
2799
+ * @public
2520
2800
  * <p>The duration of the session, in seconds.</p>
2521
2801
  */
2522
2802
  DurationInSeconds: number | undefined;
2523
2803
  /**
2804
+ * @public
2524
2805
  * <p>The status of the Vector Enrichment jobs list. </p>
2525
2806
  */
2526
2807
  Status: VectorEnrichmentJobStatus | string | undefined;
2527
2808
  /**
2809
+ * @public
2528
2810
  * <p>Each tag consists of a key and a value.</p>
2529
2811
  */
2530
2812
  Tags?: Record<string, string>;
@@ -2534,10 +2816,12 @@ export interface ListVectorEnrichmentJobOutputConfig {
2534
2816
  */
2535
2817
  export interface ListVectorEnrichmentJobOutput {
2536
2818
  /**
2819
+ * @public
2537
2820
  * <p>Contains summary information about the Vector Enrichment jobs.</p>
2538
2821
  */
2539
2822
  VectorEnrichmentJobSummaries: ListVectorEnrichmentJobOutputConfig[] | undefined;
2540
2823
  /**
2824
+ * @public
2541
2825
  * <p>If the previous response was truncated, you receive this token.
2542
2826
  * Use it in your next request to receive the next set of results.</p>
2543
2827
  */
@@ -2549,18 +2833,22 @@ export interface ListVectorEnrichmentJobOutput {
2549
2833
  */
2550
2834
  export interface RasterDataCollectionQueryWithBandFilterInput {
2551
2835
  /**
2836
+ * @public
2552
2837
  * <p>The TimeRange Filter used in the search query.</p>
2553
2838
  */
2554
2839
  TimeRangeFilter: TimeRangeFilterInput | undefined;
2555
2840
  /**
2841
+ * @public
2556
2842
  * <p>The Area of interest to be used in the search query.</p>
2557
2843
  */
2558
2844
  AreaOfInterest?: AreaOfInterest;
2559
2845
  /**
2846
+ * @public
2560
2847
  * <p>The Property Filters used in the search query.</p>
2561
2848
  */
2562
2849
  PropertyFilters?: PropertyFilters;
2563
2850
  /**
2851
+ * @public
2564
2852
  * <p>The list of Bands to be displayed in the result for each item.</p>
2565
2853
  */
2566
2854
  BandFilter?: string[];
@@ -2570,15 +2858,18 @@ export interface RasterDataCollectionQueryWithBandFilterInput {
2570
2858
  */
2571
2859
  export interface SearchRasterDataCollectionInput {
2572
2860
  /**
2861
+ * @public
2573
2862
  * <p>The Amazon Resource Name (ARN) of the raster data collection.</p>
2574
2863
  */
2575
2864
  Arn: string | undefined;
2576
2865
  /**
2866
+ * @public
2577
2867
  * <p>RasterDataCollectionQuery consisting of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html">AreaOfInterest(AOI)</a>, <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html">PropertyFilters</a> and
2578
2868
  * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html">TimeRangeFilterInput</a> used in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_SearchRasterDataCollection.html">SearchRasterDataCollection</a>.</p>
2579
2869
  */
2580
2870
  RasterDataCollectionQuery: RasterDataCollectionQueryWithBandFilterInput | undefined;
2581
2871
  /**
2872
+ * @public
2582
2873
  * <p>If the previous response was truncated, you receive this token.
2583
2874
  * Use it in your next request to receive the next set of results.</p>
2584
2875
  */
@@ -2589,15 +2880,18 @@ export interface SearchRasterDataCollectionInput {
2589
2880
  */
2590
2881
  export interface SearchRasterDataCollectionOutput {
2591
2882
  /**
2883
+ * @public
2592
2884
  * <p>Approximate number of results in the response.</p>
2593
2885
  */
2594
2886
  ApproximateResultCount: number | undefined;
2595
2887
  /**
2888
+ * @public
2596
2889
  * <p>If the previous response was truncated, you receive this token.
2597
2890
  * Use it in your next request to receive the next set of results.</p>
2598
2891
  */
2599
2892
  NextToken?: string;
2600
2893
  /**
2894
+ * @public
2601
2895
  * <p>List of items matching the Raster DataCollectionQuery.</p>
2602
2896
  */
2603
2897
  Items?: ItemSource[];
@@ -2607,10 +2901,12 @@ export interface SearchRasterDataCollectionOutput {
2607
2901
  */
2608
2902
  export interface TagResourceRequest {
2609
2903
  /**
2904
+ * @public
2610
2905
  * <p>The Amazon Resource Name (ARN) of the resource you want to tag.</p>
2611
2906
  */
2612
2907
  ResourceArn: string | undefined;
2613
2908
  /**
2909
+ * @public
2614
2910
  * <p>Each tag consists of a key and a value.</p>
2615
2911
  */
2616
2912
  Tags: Record<string, string> | undefined;
@@ -2625,10 +2921,12 @@ export interface TagResourceResponse {
2625
2921
  */
2626
2922
  export interface UntagResourceRequest {
2627
2923
  /**
2924
+ * @public
2628
2925
  * <p>The Amazon Resource Name (ARN) of the resource you want to untag.</p>
2629
2926
  */
2630
2927
  ResourceArn: string | undefined;
2631
2928
  /**
2929
+ * @public
2632
2930
  * <p>Keys of the tags you want to remove.</p>
2633
2931
  */
2634
2932
  TagKeys: string[] | undefined;
@@ -2643,30 +2941,37 @@ export interface UntagResourceResponse {
2643
2941
  */
2644
2942
  export interface StartVectorEnrichmentJobInput {
2645
2943
  /**
2944
+ * @public
2646
2945
  * <p>The name of the Vector Enrichment job.</p>
2647
2946
  */
2648
2947
  Name: string | undefined;
2649
2948
  /**
2949
+ * @public
2650
2950
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
2651
2951
  */
2652
2952
  ClientToken?: string;
2653
2953
  /**
2954
+ * @public
2654
2955
  * <p>The Key Management Service key ID for server-side encryption.</p>
2655
2956
  */
2656
2957
  KmsKeyId?: string;
2657
2958
  /**
2959
+ * @public
2658
2960
  * <p>Input configuration information for the Vector Enrichment job.</p>
2659
2961
  */
2660
2962
  InputConfig: VectorEnrichmentJobInputConfig | undefined;
2661
2963
  /**
2964
+ * @public
2662
2965
  * <p>An object containing information about the job configuration.</p>
2663
2966
  */
2664
2967
  JobConfig: VectorEnrichmentJobConfig | undefined;
2665
2968
  /**
2969
+ * @public
2666
2970
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
2667
2971
  */
2668
2972
  ExecutionRoleArn: string | undefined;
2669
2973
  /**
2974
+ * @public
2670
2975
  * <p>Each tag consists of a key and a value.</p>
2671
2976
  */
2672
2977
  Tags?: Record<string, string>;
@@ -2676,46 +2981,57 @@ export interface StartVectorEnrichmentJobInput {
2676
2981
  */
2677
2982
  export interface StartVectorEnrichmentJobOutput {
2678
2983
  /**
2984
+ * @public
2679
2985
  * <p>The name of the Vector Enrichment job.</p>
2680
2986
  */
2681
2987
  Name: string | undefined;
2682
2988
  /**
2989
+ * @public
2683
2990
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job.</p>
2684
2991
  */
2685
2992
  Arn: string | undefined;
2686
2993
  /**
2994
+ * @public
2687
2995
  * <p>The type of the Vector Enrichment job.</p>
2688
2996
  */
2689
2997
  Type: VectorEnrichmentJobType | string | undefined;
2690
2998
  /**
2999
+ * @public
2691
3000
  * <p>The creation time.</p>
2692
3001
  */
2693
3002
  CreationTime: Date | undefined;
2694
3003
  /**
3004
+ * @public
2695
3005
  * <p>The duration of the Vector Enrichment job, in seconds.</p>
2696
3006
  */
2697
3007
  DurationInSeconds: number | undefined;
2698
3008
  /**
3009
+ * @public
2699
3010
  * <p>The status of the Vector Enrichment job being started.</p>
2700
3011
  */
2701
3012
  Status: VectorEnrichmentJobStatus | string | undefined;
2702
3013
  /**
3014
+ * @public
2703
3015
  * <p>The Key Management Service key ID for server-side encryption.</p>
2704
3016
  */
2705
3017
  KmsKeyId?: string;
2706
3018
  /**
3019
+ * @public
2707
3020
  * <p>Input configuration information for starting the Vector Enrichment job.</p>
2708
3021
  */
2709
3022
  InputConfig: VectorEnrichmentJobInputConfig | undefined;
2710
3023
  /**
3024
+ * @public
2711
3025
  * <p>An object containing information about the job configuration.</p>
2712
3026
  */
2713
3027
  JobConfig: VectorEnrichmentJobConfig | undefined;
2714
3028
  /**
3029
+ * @public
2715
3030
  * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the job.</p>
2716
3031
  */
2717
3032
  ExecutionRoleArn: string | undefined;
2718
3033
  /**
3034
+ * @public
2719
3035
  * <p>Each tag consists of a key and a value.</p>
2720
3036
  */
2721
3037
  Tags?: Record<string, string>;
@@ -2725,6 +3041,7 @@ export interface StartVectorEnrichmentJobOutput {
2725
3041
  */
2726
3042
  export interface StopVectorEnrichmentJobInput {
2727
3043
  /**
3044
+ * @public
2728
3045
  * <p>The Amazon Resource Name (ARN) of the Vector Enrichment job.</p>
2729
3046
  */
2730
3047
  Arn: string | undefined;