@aws-sdk/client-location 3.1032.0 → 3.1033.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -7
- package/dist-cjs/endpoint/bdd.js +49 -0
- package/dist-cjs/endpoint/endpointResolver.js +2 -2
- package/dist-cjs/index.js +147 -1
- package/dist-cjs/schemas/schemas_0.js +143 -12
- package/dist-es/Location.js +15 -1
- package/dist-es/commands/CancelJobCommand.js +16 -0
- package/dist-es/commands/GetJobCommand.js +16 -0
- package/dist-es/commands/ListJobsCommand.js +16 -0
- package/dist-es/commands/StartJobCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/endpoint/bdd.js +46 -0
- package/dist-es/endpoint/endpointResolver.js +3 -3
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +25 -1
- package/dist-es/pagination/ListJobsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +137 -7
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForJobCompleted.js +49 -0
- package/dist-types/Location.d.ts +44 -1
- package/dist-types/LocationClient.d.ts +6 -2
- package/dist-types/commands/CancelJobCommand.d.ts +88 -0
- package/dist-types/commands/GetJobCommand.d.ts +121 -0
- package/dist-types/commands/ListJobsCommand.d.ts +124 -0
- package/dist-types/commands/StartJobCommand.d.ts +110 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +94 -0
- package/dist-types/models/models_0.d.ts +376 -4
- package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +19 -0
- package/dist-types/ts3.4/Location.d.ts +87 -0
- package/dist-types/ts3.4/LocationClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetJobCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/StartJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +34 -0
- package/dist-types/ts3.4/models/models_0.d.ts +94 -0
- package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForJobCompleted.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForJobCompleted.d.ts +14 -0
- package/package.json +6 -5
- package/dist-cjs/endpoint/ruleset.js +0 -7
- package/dist-es/endpoint/ruleset.js +0 -4
- package/dist-types/endpoint/ruleset.d.ts +0 -2
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +0 -2
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import type { BatchItemErrorCode, DimensionUnit, DistanceUnit, ForecastedGeofenceEventType, IntendedUse, OptimizationMode, PositionFiltering, PricingPlan, RouteMatrixErrorCode, SpeedUnit, Status, TravelMode, VehicleWeightUnit } from "./enums";
|
|
1
|
+
import type { BatchItemErrorCode, DimensionUnit, DistanceUnit, ForecastedGeofenceEventType, IntendedUse, JobAction, JobErrorCode, JobInputFormat, JobOutputFormat, JobStatus, OptimizationMode, PositionFiltering, PricingPlan, RouteMatrixErrorCode, SpeedUnit, Status, TravelMode, ValidateAddressAdditionalFeature, VehicleWeightUnit } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.</p>
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
6
6
|
export interface AndroidApp {
|
|
7
7
|
/**
|
|
8
|
-
* <p>Unique package name for an Android app.</p>
|
|
8
|
+
* <p>Unique package name identifier for an Android app.</p> <p>Example: <code>com.mydomain.appname</code> </p>
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
11
|
Package: string | undefined;
|
|
12
12
|
/**
|
|
13
|
-
* <p>20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.</p>
|
|
13
|
+
* <p>20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.</p> <p>Example: <code>BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75</code> </p>
|
|
14
14
|
* @public
|
|
15
15
|
*/
|
|
16
16
|
CertificateFingerprint: string | undefined;
|
|
@@ -32,7 +32,7 @@ export interface ApiKeyFilter {
|
|
|
32
32
|
*/
|
|
33
33
|
export interface AppleApp {
|
|
34
34
|
/**
|
|
35
|
-
* <p>The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS
|
|
35
|
+
* <p>The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS and watchOS).</p> <p>Example: <code>com.mydomain.appname</code> </p>
|
|
36
36
|
* @public
|
|
37
37
|
*/
|
|
38
38
|
BundleId: string | undefined;
|
|
@@ -1242,6 +1242,36 @@ export interface CalculateRouteMatrixResponse {
|
|
|
1242
1242
|
*/
|
|
1243
1243
|
Summary: CalculateRouteMatrixSummary | undefined;
|
|
1244
1244
|
}
|
|
1245
|
+
/**
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
export interface CancelJobRequest {
|
|
1249
|
+
/**
|
|
1250
|
+
* <p>The unique identifier of the job to cancel.</p>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
JobId: string | undefined;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
export interface CancelJobResponse {
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>Amazon Resource Name (ARN) of the cancelled job.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
JobArn: string | undefined;
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>Unique job identifier.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
JobId: string | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>Job status after cancellation request.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
Status: JobStatus | undefined;
|
|
1274
|
+
}
|
|
1245
1275
|
/**
|
|
1246
1276
|
* <p>LTE local identification information (local ID).</p>
|
|
1247
1277
|
* @public
|
|
@@ -2730,6 +2760,161 @@ export interface GetDevicePositionHistoryResponse {
|
|
|
2730
2760
|
*/
|
|
2731
2761
|
NextToken?: string | undefined;
|
|
2732
2762
|
}
|
|
2763
|
+
/**
|
|
2764
|
+
* @public
|
|
2765
|
+
*/
|
|
2766
|
+
export interface GetJobRequest {
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>The unique identifier of the job to retrieve.</p>
|
|
2769
|
+
* @public
|
|
2770
|
+
*/
|
|
2771
|
+
JobId: string | undefined;
|
|
2772
|
+
}
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>Options specific to address validation jobs.</p>
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
export interface ValidateAddressActionOptions {
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>A list of optional additional parameters that can be requested for each result.</p> <p>Values:</p> <ul> <li> <p> <code>Position</code> - Return the position coordinates of the address if available.</p> </li> <li> <p> <code>CountrySpecificAttributes</code> - Return additional information about the address specific to the country of origin.</p> </li> </ul>
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2782
|
+
AdditionalFeatures?: ValidateAddressAdditionalFeature[] | undefined;
|
|
2783
|
+
}
|
|
2784
|
+
/**
|
|
2785
|
+
* <p>Additional options for configuring job action parameters.</p>
|
|
2786
|
+
* @public
|
|
2787
|
+
*/
|
|
2788
|
+
export interface JobActionOptions {
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>Options specific to address validation jobs.</p>
|
|
2791
|
+
* @public
|
|
2792
|
+
*/
|
|
2793
|
+
ValidateAddress?: ValidateAddressActionOptions | undefined;
|
|
2794
|
+
}
|
|
2795
|
+
/**
|
|
2796
|
+
* <p>Error information for failed jobs.</p>
|
|
2797
|
+
* @public
|
|
2798
|
+
*/
|
|
2799
|
+
export interface JobError {
|
|
2800
|
+
/**
|
|
2801
|
+
* <p>Error code indicating the type of error that occurred.</p>
|
|
2802
|
+
* @public
|
|
2803
|
+
*/
|
|
2804
|
+
Code: JobErrorCode | undefined;
|
|
2805
|
+
/**
|
|
2806
|
+
* <p>Error messages providing details about the failure.</p>
|
|
2807
|
+
* @public
|
|
2808
|
+
*/
|
|
2809
|
+
Messages?: string[] | undefined;
|
|
2810
|
+
}
|
|
2811
|
+
/**
|
|
2812
|
+
* <p>Configuration for input data location and format.</p> <note> <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p> </note>
|
|
2813
|
+
* @public
|
|
2814
|
+
*/
|
|
2815
|
+
export interface JobInputOptions {
|
|
2816
|
+
/**
|
|
2817
|
+
* <p>S3 ARN or URI where input files are stored.</p> <note> <p>The Amazon S3 bucket must be created in the same Amazon Web Services region where you plan to run your job.</p> </note>
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
Location: string | undefined;
|
|
2821
|
+
/**
|
|
2822
|
+
* <p>Input data format. Currently only <code>Parquet</code> is supported.</p> <note> <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p> </note>
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
Format: JobInputFormat | undefined;
|
|
2826
|
+
}
|
|
2827
|
+
/**
|
|
2828
|
+
* <p>Configuration for output data location and format.</p>
|
|
2829
|
+
* @public
|
|
2830
|
+
*/
|
|
2831
|
+
export interface JobOutputOptions {
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>Output data format. Currently only "Parquet" is supported.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
Format: JobOutputFormat | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>S3 ARN or URI where output files will be written.</p> <note> <p>The Amazon S3 bucket must exist in the same Amazon Web Services region where you plan to run your job.</p> </note>
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
Location: string | undefined;
|
|
2842
|
+
}
|
|
2843
|
+
/**
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
export interface GetJobResponse {
|
|
2847
|
+
/**
|
|
2848
|
+
* <p>Action performed by the job.</p>
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
Action: JobAction | undefined;
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>Additional options for configuring job action parameters.</p>
|
|
2854
|
+
* @public
|
|
2855
|
+
*/
|
|
2856
|
+
ActionOptions?: JobActionOptions | undefined;
|
|
2857
|
+
/**
|
|
2858
|
+
* <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
|
|
2859
|
+
* @public
|
|
2860
|
+
*/
|
|
2861
|
+
CreatedAt: Date | undefined;
|
|
2862
|
+
/**
|
|
2863
|
+
* <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
|
|
2864
|
+
* @public
|
|
2865
|
+
*/
|
|
2866
|
+
EndedAt?: Date | undefined;
|
|
2867
|
+
/**
|
|
2868
|
+
* <p>Error information if the job failed.</p>
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
Error?: JobError | undefined;
|
|
2872
|
+
/**
|
|
2873
|
+
* <p>IAM role used for permissions when running the job.</p>
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
ExecutionRoleArn: string | undefined;
|
|
2877
|
+
/**
|
|
2878
|
+
* <p>Input configuration.</p>
|
|
2879
|
+
* @public
|
|
2880
|
+
*/
|
|
2881
|
+
InputOptions: JobInputOptions | undefined;
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>Amazon Resource Name (ARN) of the specified job.</p>
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2886
|
+
JobArn: string | undefined;
|
|
2887
|
+
/**
|
|
2888
|
+
* <p>Unique job identifier.</p>
|
|
2889
|
+
* @public
|
|
2890
|
+
*/
|
|
2891
|
+
JobId: string | undefined;
|
|
2892
|
+
/**
|
|
2893
|
+
* <p>Job name (if provided during creation).</p>
|
|
2894
|
+
* @public
|
|
2895
|
+
*/
|
|
2896
|
+
Name?: string | undefined;
|
|
2897
|
+
/**
|
|
2898
|
+
* <p>Output configuration.</p>
|
|
2899
|
+
* @public
|
|
2900
|
+
*/
|
|
2901
|
+
OutputOptions: JobOutputOptions | undefined;
|
|
2902
|
+
/**
|
|
2903
|
+
* <p>Current job status.</p>
|
|
2904
|
+
* @public
|
|
2905
|
+
*/
|
|
2906
|
+
Status: JobStatus | undefined;
|
|
2907
|
+
/**
|
|
2908
|
+
* <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
|
|
2909
|
+
* @public
|
|
2910
|
+
*/
|
|
2911
|
+
UpdatedAt: Date | undefined;
|
|
2912
|
+
/**
|
|
2913
|
+
* <p>Tags and corresponding values associated with the specified job.</p>
|
|
2914
|
+
* @public
|
|
2915
|
+
*/
|
|
2916
|
+
Tags?: Record<string, string> | undefined;
|
|
2917
|
+
}
|
|
2733
2918
|
/**
|
|
2734
2919
|
* @public
|
|
2735
2920
|
*/
|
|
@@ -3079,6 +3264,193 @@ export interface InferredState {
|
|
|
3079
3264
|
*/
|
|
3080
3265
|
ProxyDetected: boolean | undefined;
|
|
3081
3266
|
}
|
|
3267
|
+
/**
|
|
3268
|
+
* <p>Criteria for filtering jobs.</p>
|
|
3269
|
+
* @public
|
|
3270
|
+
*/
|
|
3271
|
+
export interface JobsFilter {
|
|
3272
|
+
/**
|
|
3273
|
+
* <p>Filter by job status.</p>
|
|
3274
|
+
* @public
|
|
3275
|
+
*/
|
|
3276
|
+
JobStatus?: JobStatus | undefined;
|
|
3277
|
+
}
|
|
3278
|
+
/**
|
|
3279
|
+
* @public
|
|
3280
|
+
*/
|
|
3281
|
+
export interface ListJobsRequest {
|
|
3282
|
+
/**
|
|
3283
|
+
* <p>An optional structure containing criteria by which to filter job results.</p>
|
|
3284
|
+
* @public
|
|
3285
|
+
*/
|
|
3286
|
+
Filter?: JobsFilter | undefined;
|
|
3287
|
+
/**
|
|
3288
|
+
* <p>Maximum number of jobs to return.</p>
|
|
3289
|
+
* @public
|
|
3290
|
+
*/
|
|
3291
|
+
MaxResults?: number | undefined;
|
|
3292
|
+
/**
|
|
3293
|
+
* <p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p>
|
|
3294
|
+
* @public
|
|
3295
|
+
*/
|
|
3296
|
+
NextToken?: string | undefined;
|
|
3297
|
+
}
|
|
3298
|
+
/**
|
|
3299
|
+
* <p>Job summary information returned in list operations.</p>
|
|
3300
|
+
* @public
|
|
3301
|
+
*/
|
|
3302
|
+
export interface ListJobsResponseEntry {
|
|
3303
|
+
/**
|
|
3304
|
+
* <p>Action performed by the job.</p>
|
|
3305
|
+
* @public
|
|
3306
|
+
*/
|
|
3307
|
+
Action: JobAction | undefined;
|
|
3308
|
+
/**
|
|
3309
|
+
* <p>Additional options for configuring job action parameters.</p>
|
|
3310
|
+
* @public
|
|
3311
|
+
*/
|
|
3312
|
+
ActionOptions?: JobActionOptions | undefined;
|
|
3313
|
+
/**
|
|
3314
|
+
* <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
|
|
3315
|
+
* @public
|
|
3316
|
+
*/
|
|
3317
|
+
CreatedAt: Date | undefined;
|
|
3318
|
+
/**
|
|
3319
|
+
* <p>IAM role used for job execution.</p>
|
|
3320
|
+
* @public
|
|
3321
|
+
*/
|
|
3322
|
+
ExecutionRoleArn: string | undefined;
|
|
3323
|
+
/**
|
|
3324
|
+
* <p>Job completion time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
|
|
3325
|
+
* @public
|
|
3326
|
+
*/
|
|
3327
|
+
EndedAt?: Date | undefined;
|
|
3328
|
+
/**
|
|
3329
|
+
* <p>Error information if the job failed.</p>
|
|
3330
|
+
* @public
|
|
3331
|
+
*/
|
|
3332
|
+
Error?: JobError | undefined;
|
|
3333
|
+
/**
|
|
3334
|
+
* <p>Input configuration.</p>
|
|
3335
|
+
* @public
|
|
3336
|
+
*/
|
|
3337
|
+
InputOptions: JobInputOptions | undefined;
|
|
3338
|
+
/**
|
|
3339
|
+
* <p>Unique job identifier.</p>
|
|
3340
|
+
* @public
|
|
3341
|
+
*/
|
|
3342
|
+
JobId: string | undefined;
|
|
3343
|
+
/**
|
|
3344
|
+
* <p>Amazon Resource Name (ARN) of the job.</p>
|
|
3345
|
+
* @public
|
|
3346
|
+
*/
|
|
3347
|
+
JobArn: string | undefined;
|
|
3348
|
+
/**
|
|
3349
|
+
* <p>Job name (if provided during creation).</p>
|
|
3350
|
+
* @public
|
|
3351
|
+
*/
|
|
3352
|
+
Name?: string | undefined;
|
|
3353
|
+
/**
|
|
3354
|
+
* <p>Output configuration.</p>
|
|
3355
|
+
* @public
|
|
3356
|
+
*/
|
|
3357
|
+
OutputOptions: JobOutputOptions | undefined;
|
|
3358
|
+
/**
|
|
3359
|
+
* <p>Current job status.</p>
|
|
3360
|
+
* @public
|
|
3361
|
+
*/
|
|
3362
|
+
Status: JobStatus | undefined;
|
|
3363
|
+
/**
|
|
3364
|
+
* <p>Last update time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
|
|
3365
|
+
* @public
|
|
3366
|
+
*/
|
|
3367
|
+
UpdatedAt: Date | undefined;
|
|
3368
|
+
}
|
|
3369
|
+
/**
|
|
3370
|
+
* @public
|
|
3371
|
+
*/
|
|
3372
|
+
export interface ListJobsResponse {
|
|
3373
|
+
/**
|
|
3374
|
+
* <p>List of jobs in your Amazon Web Services account.</p>
|
|
3375
|
+
* @public
|
|
3376
|
+
*/
|
|
3377
|
+
Entries: ListJobsResponseEntry[] | undefined;
|
|
3378
|
+
/**
|
|
3379
|
+
* <p>Token for retrieving the next page (present if more results available).</p>
|
|
3380
|
+
* @public
|
|
3381
|
+
*/
|
|
3382
|
+
NextToken?: string | undefined;
|
|
3383
|
+
}
|
|
3384
|
+
/**
|
|
3385
|
+
* @public
|
|
3386
|
+
*/
|
|
3387
|
+
export interface StartJobRequest {
|
|
3388
|
+
/**
|
|
3389
|
+
* <p>A unique identifier for this request to ensure idempotency.</p>
|
|
3390
|
+
* @public
|
|
3391
|
+
*/
|
|
3392
|
+
ClientToken?: string | undefined;
|
|
3393
|
+
/**
|
|
3394
|
+
* <p>The action to perform on the input data.</p>
|
|
3395
|
+
* @public
|
|
3396
|
+
*/
|
|
3397
|
+
Action: JobAction | undefined;
|
|
3398
|
+
/**
|
|
3399
|
+
* <p>Additional parameters that can be requested for each result.</p>
|
|
3400
|
+
* @public
|
|
3401
|
+
*/
|
|
3402
|
+
ActionOptions?: JobActionOptions | undefined;
|
|
3403
|
+
/**
|
|
3404
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p> <note> <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p> </note> <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
3405
|
+
* @public
|
|
3406
|
+
*/
|
|
3407
|
+
ExecutionRoleArn: string | undefined;
|
|
3408
|
+
/**
|
|
3409
|
+
* <p>Configuration for input data location and format.</p> <note> <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p> </note>
|
|
3410
|
+
* @public
|
|
3411
|
+
*/
|
|
3412
|
+
InputOptions: JobInputOptions | undefined;
|
|
3413
|
+
/**
|
|
3414
|
+
* <p>An optional name for the job resource.</p>
|
|
3415
|
+
* @public
|
|
3416
|
+
*/
|
|
3417
|
+
Name?: string | undefined;
|
|
3418
|
+
/**
|
|
3419
|
+
* <p>Configuration for output data location and format.</p>
|
|
3420
|
+
* @public
|
|
3421
|
+
*/
|
|
3422
|
+
OutputOptions: JobOutputOptions | undefined;
|
|
3423
|
+
/**
|
|
3424
|
+
* <p>Tags and corresponding values to be associated with the job.</p>
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
Tags?: Record<string, string> | undefined;
|
|
3428
|
+
}
|
|
3429
|
+
/**
|
|
3430
|
+
* @public
|
|
3431
|
+
*/
|
|
3432
|
+
export interface StartJobResponse {
|
|
3433
|
+
/**
|
|
3434
|
+
* <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
|
|
3435
|
+
* @public
|
|
3436
|
+
*/
|
|
3437
|
+
CreatedAt: Date | undefined;
|
|
3438
|
+
/**
|
|
3439
|
+
* <p>The Amazon Resource Name (ARN) for the job resource. Used when you need to specify a resource across all Amazon Web Services.</p> <p>Format example: <code>arn:aws:geo:region:account-id:job/ExampleJob</code> </p>
|
|
3440
|
+
* @public
|
|
3441
|
+
*/
|
|
3442
|
+
JobArn: string | undefined;
|
|
3443
|
+
/**
|
|
3444
|
+
* <p>Unique job identifier.</p>
|
|
3445
|
+
* @public
|
|
3446
|
+
*/
|
|
3447
|
+
JobId: string | undefined;
|
|
3448
|
+
/**
|
|
3449
|
+
* <p>Initial job status (always "Pending" for new jobs).</p>
|
|
3450
|
+
* @public
|
|
3451
|
+
*/
|
|
3452
|
+
Status: JobStatus | undefined;
|
|
3453
|
+
}
|
|
3082
3454
|
/**
|
|
3083
3455
|
* <p>The geomerty used to filter device positions.</p>
|
|
3084
3456
|
* @public
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListJobsCommandInput, ListJobsCommandOutput } from "../commands/ListJobsCommand";
|
|
3
|
+
import type { LocationPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListJobs: (config: LocationPaginationConfiguration, input: ListJobsCommandInput, ...rest: any[]) => Paginator<ListJobsCommandOutput>;
|
|
@@ -4,6 +4,7 @@ export * from "./GetDevicePositionHistoryPaginator";
|
|
|
4
4
|
export * from "./ListDevicePositionsPaginator";
|
|
5
5
|
export * from "./ListGeofenceCollectionsPaginator";
|
|
6
6
|
export * from "./ListGeofencesPaginator";
|
|
7
|
+
export * from "./ListJobsPaginator";
|
|
7
8
|
export * from "./ListKeysPaginator";
|
|
8
9
|
export * from "./ListMapsPaginator";
|
|
9
10
|
export * from "./ListPlaceIndexesPaginator";
|
|
@@ -49,6 +49,8 @@ export declare var CalculateRouteRequest$: StaticStructureSchema;
|
|
|
49
49
|
export declare var CalculateRouteResponse$: StaticStructureSchema;
|
|
50
50
|
export declare var CalculateRouteSummary$: StaticStructureSchema;
|
|
51
51
|
export declare var CalculateRouteTruckModeOptions$: StaticStructureSchema;
|
|
52
|
+
export declare var CancelJobRequest$: StaticStructureSchema;
|
|
53
|
+
export declare var CancelJobResponse$: StaticStructureSchema;
|
|
52
54
|
export declare var CellSignals$: StaticStructureSchema;
|
|
53
55
|
export declare var Circle$: StaticStructureSchema;
|
|
54
56
|
export declare var CreateGeofenceCollectionRequest$: StaticStructureSchema;
|
|
@@ -104,6 +106,8 @@ export declare var GetDevicePositionRequest$: StaticStructureSchema;
|
|
|
104
106
|
export declare var GetDevicePositionResponse$: StaticStructureSchema;
|
|
105
107
|
export declare var GetGeofenceRequest$: StaticStructureSchema;
|
|
106
108
|
export declare var GetGeofenceResponse$: StaticStructureSchema;
|
|
109
|
+
export declare var GetJobRequest$: StaticStructureSchema;
|
|
110
|
+
export declare var GetJobResponse$: StaticStructureSchema;
|
|
107
111
|
export declare var GetMapGlyphsRequest$: StaticStructureSchema;
|
|
108
112
|
export declare var GetMapGlyphsResponse$: StaticStructureSchema;
|
|
109
113
|
export declare var GetMapSpritesRequest$: StaticStructureSchema;
|
|
@@ -115,6 +119,11 @@ export declare var GetMapTileResponse$: StaticStructureSchema;
|
|
|
115
119
|
export declare var GetPlaceRequest$: StaticStructureSchema;
|
|
116
120
|
export declare var GetPlaceResponse$: StaticStructureSchema;
|
|
117
121
|
export declare var InferredState$: StaticStructureSchema;
|
|
122
|
+
export declare var JobActionOptions$: StaticStructureSchema;
|
|
123
|
+
export declare var JobError$: StaticStructureSchema;
|
|
124
|
+
export declare var JobInputOptions$: StaticStructureSchema;
|
|
125
|
+
export declare var JobOutputOptions$: StaticStructureSchema;
|
|
126
|
+
export declare var JobsFilter$: StaticStructureSchema;
|
|
118
127
|
export declare var Leg$: StaticStructureSchema;
|
|
119
128
|
export declare var LegGeometry$: StaticStructureSchema;
|
|
120
129
|
export declare var ListDevicePositionsRequest$: StaticStructureSchema;
|
|
@@ -126,6 +135,9 @@ export declare var ListGeofenceCollectionsResponseEntry$: StaticStructureSchema;
|
|
|
126
135
|
export declare var ListGeofenceResponseEntry$: StaticStructureSchema;
|
|
127
136
|
export declare var ListGeofencesRequest$: StaticStructureSchema;
|
|
128
137
|
export declare var ListGeofencesResponse$: StaticStructureSchema;
|
|
138
|
+
export declare var ListJobsRequest$: StaticStructureSchema;
|
|
139
|
+
export declare var ListJobsResponse$: StaticStructureSchema;
|
|
140
|
+
export declare var ListJobsResponseEntry$: StaticStructureSchema;
|
|
129
141
|
export declare var ListKeysRequest$: StaticStructureSchema;
|
|
130
142
|
export declare var ListKeysResponse$: StaticStructureSchema;
|
|
131
143
|
export declare var ListKeysResponseEntry$: StaticStructureSchema;
|
|
@@ -169,6 +181,8 @@ export declare var SearchPlaceIndexForSuggestionsSummary$: StaticStructureSchema
|
|
|
169
181
|
export declare var SearchPlaceIndexForTextRequest$: StaticStructureSchema;
|
|
170
182
|
export declare var SearchPlaceIndexForTextResponse$: StaticStructureSchema;
|
|
171
183
|
export declare var SearchPlaceIndexForTextSummary$: StaticStructureSchema;
|
|
184
|
+
export declare var StartJobRequest$: StaticStructureSchema;
|
|
185
|
+
export declare var StartJobResponse$: StaticStructureSchema;
|
|
172
186
|
export declare var Step$: StaticStructureSchema;
|
|
173
187
|
export declare var TagResourceRequest$: StaticStructureSchema;
|
|
174
188
|
export declare var TagResourceResponse$: StaticStructureSchema;
|
|
@@ -190,6 +204,7 @@ export declare var UpdateRouteCalculatorRequest$: StaticStructureSchema;
|
|
|
190
204
|
export declare var UpdateRouteCalculatorResponse$: StaticStructureSchema;
|
|
191
205
|
export declare var UpdateTrackerRequest$: StaticStructureSchema;
|
|
192
206
|
export declare var UpdateTrackerResponse$: StaticStructureSchema;
|
|
207
|
+
export declare var ValidateAddressActionOptions$: StaticStructureSchema;
|
|
193
208
|
export declare var ValidationExceptionField$: StaticStructureSchema;
|
|
194
209
|
export declare var VerifyDevicePositionRequest$: StaticStructureSchema;
|
|
195
210
|
export declare var VerifyDevicePositionResponse$: StaticStructureSchema;
|
|
@@ -203,6 +218,7 @@ export declare var BatchPutGeofence$: StaticOperationSchema;
|
|
|
203
218
|
export declare var BatchUpdateDevicePosition$: StaticOperationSchema;
|
|
204
219
|
export declare var CalculateRoute$: StaticOperationSchema;
|
|
205
220
|
export declare var CalculateRouteMatrix$: StaticOperationSchema;
|
|
221
|
+
export declare var CancelJob$: StaticOperationSchema;
|
|
206
222
|
export declare var CreateGeofenceCollection$: StaticOperationSchema;
|
|
207
223
|
export declare var CreateKey$: StaticOperationSchema;
|
|
208
224
|
export declare var CreateMap$: StaticOperationSchema;
|
|
@@ -226,6 +242,7 @@ export declare var ForecastGeofenceEvents$: StaticOperationSchema;
|
|
|
226
242
|
export declare var GetDevicePosition$: StaticOperationSchema;
|
|
227
243
|
export declare var GetDevicePositionHistory$: StaticOperationSchema;
|
|
228
244
|
export declare var GetGeofence$: StaticOperationSchema;
|
|
245
|
+
export declare var GetJob$: StaticOperationSchema;
|
|
229
246
|
export declare var GetMapGlyphs$: StaticOperationSchema;
|
|
230
247
|
export declare var GetMapSprites$: StaticOperationSchema;
|
|
231
248
|
export declare var GetMapStyleDescriptor$: StaticOperationSchema;
|
|
@@ -234,6 +251,7 @@ export declare var GetPlace$: StaticOperationSchema;
|
|
|
234
251
|
export declare var ListDevicePositions$: StaticOperationSchema;
|
|
235
252
|
export declare var ListGeofenceCollections$: StaticOperationSchema;
|
|
236
253
|
export declare var ListGeofences$: StaticOperationSchema;
|
|
254
|
+
export declare var ListJobs$: StaticOperationSchema;
|
|
237
255
|
export declare var ListKeys$: StaticOperationSchema;
|
|
238
256
|
export declare var ListMaps$: StaticOperationSchema;
|
|
239
257
|
export declare var ListPlaceIndexes$: StaticOperationSchema;
|
|
@@ -245,6 +263,7 @@ export declare var PutGeofence$: StaticOperationSchema;
|
|
|
245
263
|
export declare var SearchPlaceIndexForPosition$: StaticOperationSchema;
|
|
246
264
|
export declare var SearchPlaceIndexForSuggestions$: StaticOperationSchema;
|
|
247
265
|
export declare var SearchPlaceIndexForText$: StaticOperationSchema;
|
|
266
|
+
export declare var StartJob$: StaticOperationSchema;
|
|
248
267
|
export declare var TagResource$: StaticOperationSchema;
|
|
249
268
|
export declare var UntagResource$: StaticOperationSchema;
|
|
250
269
|
export declare var UpdateGeofenceCollection$: StaticOperationSchema;
|
|
@@ -2,7 +2,9 @@ import {
|
|
|
2
2
|
HttpHandlerOptions as __HttpHandlerOptions,
|
|
3
3
|
PaginationConfiguration,
|
|
4
4
|
Paginator,
|
|
5
|
+
WaiterConfiguration,
|
|
5
6
|
} from "@smithy/types";
|
|
7
|
+
import { WaiterResult } from "@smithy/util-waiter";
|
|
6
8
|
import {
|
|
7
9
|
AssociateTrackerConsumerCommandInput,
|
|
8
10
|
AssociateTrackerConsumerCommandOutput,
|
|
@@ -39,6 +41,10 @@ import {
|
|
|
39
41
|
CalculateRouteMatrixCommandInput,
|
|
40
42
|
CalculateRouteMatrixCommandOutput,
|
|
41
43
|
} from "./commands/CalculateRouteMatrixCommand";
|
|
44
|
+
import {
|
|
45
|
+
CancelJobCommandInput,
|
|
46
|
+
CancelJobCommandOutput,
|
|
47
|
+
} from "./commands/CancelJobCommand";
|
|
42
48
|
import {
|
|
43
49
|
CreateGeofenceCollectionCommandInput,
|
|
44
50
|
CreateGeofenceCollectionCommandOutput,
|
|
@@ -131,6 +137,10 @@ import {
|
|
|
131
137
|
GetGeofenceCommandInput,
|
|
132
138
|
GetGeofenceCommandOutput,
|
|
133
139
|
} from "./commands/GetGeofenceCommand";
|
|
140
|
+
import {
|
|
141
|
+
GetJobCommandInput,
|
|
142
|
+
GetJobCommandOutput,
|
|
143
|
+
} from "./commands/GetJobCommand";
|
|
134
144
|
import {
|
|
135
145
|
GetMapGlyphsCommandInput,
|
|
136
146
|
GetMapGlyphsCommandOutput,
|
|
@@ -163,6 +173,10 @@ import {
|
|
|
163
173
|
ListGeofencesCommandInput,
|
|
164
174
|
ListGeofencesCommandOutput,
|
|
165
175
|
} from "./commands/ListGeofencesCommand";
|
|
176
|
+
import {
|
|
177
|
+
ListJobsCommandInput,
|
|
178
|
+
ListJobsCommandOutput,
|
|
179
|
+
} from "./commands/ListJobsCommand";
|
|
166
180
|
import {
|
|
167
181
|
ListKeysCommandInput,
|
|
168
182
|
ListKeysCommandOutput,
|
|
@@ -207,6 +221,10 @@ import {
|
|
|
207
221
|
SearchPlaceIndexForTextCommandInput,
|
|
208
222
|
SearchPlaceIndexForTextCommandOutput,
|
|
209
223
|
} from "./commands/SearchPlaceIndexForTextCommand";
|
|
224
|
+
import {
|
|
225
|
+
StartJobCommandInput,
|
|
226
|
+
StartJobCommandOutput,
|
|
227
|
+
} from "./commands/StartJobCommand";
|
|
210
228
|
import {
|
|
211
229
|
TagResourceCommandInput,
|
|
212
230
|
TagResourceCommandOutput,
|
|
@@ -362,6 +380,19 @@ export interface Location {
|
|
|
362
380
|
options: __HttpHandlerOptions,
|
|
363
381
|
cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void
|
|
364
382
|
): void;
|
|
383
|
+
cancelJob(
|
|
384
|
+
args: CancelJobCommandInput,
|
|
385
|
+
options?: __HttpHandlerOptions
|
|
386
|
+
): Promise<CancelJobCommandOutput>;
|
|
387
|
+
cancelJob(
|
|
388
|
+
args: CancelJobCommandInput,
|
|
389
|
+
cb: (err: any, data?: CancelJobCommandOutput) => void
|
|
390
|
+
): void;
|
|
391
|
+
cancelJob(
|
|
392
|
+
args: CancelJobCommandInput,
|
|
393
|
+
options: __HttpHandlerOptions,
|
|
394
|
+
cb: (err: any, data?: CancelJobCommandOutput) => void
|
|
395
|
+
): void;
|
|
365
396
|
createGeofenceCollection(
|
|
366
397
|
args: CreateGeofenceCollectionCommandInput,
|
|
367
398
|
options?: __HttpHandlerOptions
|
|
@@ -661,6 +692,19 @@ export interface Location {
|
|
|
661
692
|
options: __HttpHandlerOptions,
|
|
662
693
|
cb: (err: any, data?: GetGeofenceCommandOutput) => void
|
|
663
694
|
): void;
|
|
695
|
+
getJob(
|
|
696
|
+
args: GetJobCommandInput,
|
|
697
|
+
options?: __HttpHandlerOptions
|
|
698
|
+
): Promise<GetJobCommandOutput>;
|
|
699
|
+
getJob(
|
|
700
|
+
args: GetJobCommandInput,
|
|
701
|
+
cb: (err: any, data?: GetJobCommandOutput) => void
|
|
702
|
+
): void;
|
|
703
|
+
getJob(
|
|
704
|
+
args: GetJobCommandInput,
|
|
705
|
+
options: __HttpHandlerOptions,
|
|
706
|
+
cb: (err: any, data?: GetJobCommandOutput) => void
|
|
707
|
+
): void;
|
|
664
708
|
getMapGlyphs(
|
|
665
709
|
args: GetMapGlyphsCommandInput,
|
|
666
710
|
options?: __HttpHandlerOptions
|
|
@@ -766,6 +810,20 @@ export interface Location {
|
|
|
766
810
|
options: __HttpHandlerOptions,
|
|
767
811
|
cb: (err: any, data?: ListGeofencesCommandOutput) => void
|
|
768
812
|
): void;
|
|
813
|
+
listJobs(): Promise<ListJobsCommandOutput>;
|
|
814
|
+
listJobs(
|
|
815
|
+
args: ListJobsCommandInput,
|
|
816
|
+
options?: __HttpHandlerOptions
|
|
817
|
+
): Promise<ListJobsCommandOutput>;
|
|
818
|
+
listJobs(
|
|
819
|
+
args: ListJobsCommandInput,
|
|
820
|
+
cb: (err: any, data?: ListJobsCommandOutput) => void
|
|
821
|
+
): void;
|
|
822
|
+
listJobs(
|
|
823
|
+
args: ListJobsCommandInput,
|
|
824
|
+
options: __HttpHandlerOptions,
|
|
825
|
+
cb: (err: any, data?: ListJobsCommandOutput) => void
|
|
826
|
+
): void;
|
|
769
827
|
listKeys(): Promise<ListKeysCommandOutput>;
|
|
770
828
|
listKeys(
|
|
771
829
|
args: ListKeysCommandInput,
|
|
@@ -914,6 +972,19 @@ export interface Location {
|
|
|
914
972
|
options: __HttpHandlerOptions,
|
|
915
973
|
cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void
|
|
916
974
|
): void;
|
|
975
|
+
startJob(
|
|
976
|
+
args: StartJobCommandInput,
|
|
977
|
+
options?: __HttpHandlerOptions
|
|
978
|
+
): Promise<StartJobCommandOutput>;
|
|
979
|
+
startJob(
|
|
980
|
+
args: StartJobCommandInput,
|
|
981
|
+
cb: (err: any, data?: StartJobCommandOutput) => void
|
|
982
|
+
): void;
|
|
983
|
+
startJob(
|
|
984
|
+
args: StartJobCommandInput,
|
|
985
|
+
options: __HttpHandlerOptions,
|
|
986
|
+
cb: (err: any, data?: StartJobCommandOutput) => void
|
|
987
|
+
): void;
|
|
917
988
|
tagResource(
|
|
918
989
|
args: TagResourceCommandInput,
|
|
919
990
|
options?: __HttpHandlerOptions
|
|
@@ -1066,6 +1137,13 @@ export interface Location {
|
|
|
1066
1137
|
Exclude<keyof PaginationConfiguration, "client">
|
|
1067
1138
|
>
|
|
1068
1139
|
): Paginator<ListGeofencesCommandOutput>;
|
|
1140
|
+
paginateListJobs(
|
|
1141
|
+
args?: ListJobsCommandInput,
|
|
1142
|
+
paginationConfig?: Pick<
|
|
1143
|
+
PaginationConfiguration,
|
|
1144
|
+
Exclude<keyof PaginationConfiguration, "client">
|
|
1145
|
+
>
|
|
1146
|
+
): Paginator<ListJobsCommandOutput>;
|
|
1069
1147
|
paginateListKeys(
|
|
1070
1148
|
args?: ListKeysCommandInput,
|
|
1071
1149
|
paginationConfig?: Pick<
|
|
@@ -1108,5 +1186,14 @@ export interface Location {
|
|
|
1108
1186
|
Exclude<keyof PaginationConfiguration, "client">
|
|
1109
1187
|
>
|
|
1110
1188
|
): Paginator<ListTrackersCommandOutput>;
|
|
1189
|
+
waitUntilJobCompleted(
|
|
1190
|
+
args: GetJobCommandInput,
|
|
1191
|
+
waiterConfig:
|
|
1192
|
+
| number
|
|
1193
|
+
| Pick<
|
|
1194
|
+
WaiterConfiguration<Location>,
|
|
1195
|
+
Exclude<keyof WaiterConfiguration<Location>, "client">
|
|
1196
|
+
>
|
|
1197
|
+
): Promise<WaiterResult>;
|
|
1111
1198
|
}
|
|
1112
1199
|
export declare class Location extends LocationClient implements Location {}
|