@aws-sdk/client-location 3.1031.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.
Files changed (57) hide show
  1. package/README.md +35 -7
  2. package/dist-cjs/endpoint/bdd.js +49 -0
  3. package/dist-cjs/endpoint/endpointResolver.js +2 -2
  4. package/dist-cjs/index.js +147 -1
  5. package/dist-cjs/schemas/schemas_0.js +143 -12
  6. package/dist-es/Location.js +15 -1
  7. package/dist-es/commands/CancelJobCommand.js +16 -0
  8. package/dist-es/commands/GetJobCommand.js +16 -0
  9. package/dist-es/commands/ListJobsCommand.js +16 -0
  10. package/dist-es/commands/StartJobCommand.js +16 -0
  11. package/dist-es/commands/index.js +4 -0
  12. package/dist-es/endpoint/bdd.js +46 -0
  13. package/dist-es/endpoint/endpointResolver.js +3 -3
  14. package/dist-es/index.js +1 -0
  15. package/dist-es/models/enums.js +25 -1
  16. package/dist-es/pagination/ListJobsPaginator.js +4 -0
  17. package/dist-es/pagination/index.js +1 -0
  18. package/dist-es/schemas/schemas_0.js +137 -7
  19. package/dist-es/waiters/index.js +1 -0
  20. package/dist-es/waiters/waitForJobCompleted.js +49 -0
  21. package/dist-types/Location.d.ts +44 -1
  22. package/dist-types/LocationClient.d.ts +6 -2
  23. package/dist-types/commands/CancelJobCommand.d.ts +88 -0
  24. package/dist-types/commands/GetJobCommand.d.ts +121 -0
  25. package/dist-types/commands/ListJobsCommand.d.ts +124 -0
  26. package/dist-types/commands/StartJobCommand.d.ts +110 -0
  27. package/dist-types/commands/index.d.ts +4 -0
  28. package/dist-types/endpoint/bdd.d.ts +2 -0
  29. package/dist-types/index.d.ts +1 -0
  30. package/dist-types/models/enums.d.ts +94 -0
  31. package/dist-types/models/models_0.d.ts +376 -4
  32. package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
  33. package/dist-types/pagination/index.d.ts +1 -0
  34. package/dist-types/schemas/schemas_0.d.ts +19 -0
  35. package/dist-types/ts3.4/Location.d.ts +87 -0
  36. package/dist-types/ts3.4/LocationClient.d.ts +24 -0
  37. package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +47 -0
  38. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +41 -0
  39. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +47 -0
  40. package/dist-types/ts3.4/commands/StartJobCommand.d.ts +47 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  42. package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
  43. package/dist-types/ts3.4/index.d.ts +1 -0
  44. package/dist-types/ts3.4/models/enums.d.ts +34 -0
  45. package/dist-types/ts3.4/models/models_0.d.ts +94 -0
  46. package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +11 -0
  47. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  48. package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
  49. package/dist-types/ts3.4/waiters/index.d.ts +1 -0
  50. package/dist-types/ts3.4/waiters/waitForJobCompleted.d.ts +11 -0
  51. package/dist-types/waiters/index.d.ts +1 -0
  52. package/dist-types/waiters/waitForJobCompleted.d.ts +14 -0
  53. package/package.json +6 -5
  54. package/dist-cjs/endpoint/ruleset.js +0 -7
  55. package/dist-es/endpoint/ruleset.js +0 -4
  56. package/dist-types/endpoint/ruleset.d.ts +0 -2
  57. package/dist-types/ts3.4/endpoint/ruleset.d.ts +0 -2
@@ -16,6 +16,7 @@ import type { BatchPutGeofenceCommandInput, BatchPutGeofenceCommandOutput } from
16
16
  import type { BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput } from "./commands/BatchUpdateDevicePositionCommand";
17
17
  import type { CalculateRouteCommandInput, CalculateRouteCommandOutput } from "./commands/CalculateRouteCommand";
18
18
  import type { CalculateRouteMatrixCommandInput, CalculateRouteMatrixCommandOutput } from "./commands/CalculateRouteMatrixCommand";
19
+ import type { CancelJobCommandInput, CancelJobCommandOutput } from "./commands/CancelJobCommand";
19
20
  import type { CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput } from "./commands/CreateGeofenceCollectionCommand";
20
21
  import type { CreateKeyCommandInput, CreateKeyCommandOutput } from "./commands/CreateKeyCommand";
21
22
  import type { CreateMapCommandInput, CreateMapCommandOutput } from "./commands/CreateMapCommand";
@@ -39,6 +40,7 @@ import type { ForecastGeofenceEventsCommandInput, ForecastGeofenceEventsCommandO
39
40
  import type { GetDevicePositionCommandInput, GetDevicePositionCommandOutput } from "./commands/GetDevicePositionCommand";
40
41
  import type { GetDevicePositionHistoryCommandInput, GetDevicePositionHistoryCommandOutput } from "./commands/GetDevicePositionHistoryCommand";
41
42
  import type { GetGeofenceCommandInput, GetGeofenceCommandOutput } from "./commands/GetGeofenceCommand";
43
+ import type { GetJobCommandInput, GetJobCommandOutput } from "./commands/GetJobCommand";
42
44
  import type { GetMapGlyphsCommandInput, GetMapGlyphsCommandOutput } from "./commands/GetMapGlyphsCommand";
43
45
  import type { GetMapSpritesCommandInput, GetMapSpritesCommandOutput } from "./commands/GetMapSpritesCommand";
44
46
  import type { GetMapStyleDescriptorCommandInput, GetMapStyleDescriptorCommandOutput } from "./commands/GetMapStyleDescriptorCommand";
@@ -47,6 +49,7 @@ import type { GetPlaceCommandInput, GetPlaceCommandOutput } from "./commands/Get
47
49
  import type { ListDevicePositionsCommandInput, ListDevicePositionsCommandOutput } from "./commands/ListDevicePositionsCommand";
48
50
  import type { ListGeofenceCollectionsCommandInput, ListGeofenceCollectionsCommandOutput } from "./commands/ListGeofenceCollectionsCommand";
49
51
  import type { ListGeofencesCommandInput, ListGeofencesCommandOutput } from "./commands/ListGeofencesCommand";
52
+ import type { ListJobsCommandInput, ListJobsCommandOutput } from "./commands/ListJobsCommand";
50
53
  import type { ListKeysCommandInput, ListKeysCommandOutput } from "./commands/ListKeysCommand";
51
54
  import type { ListMapsCommandInput, ListMapsCommandOutput } from "./commands/ListMapsCommand";
52
55
  import type { ListPlaceIndexesCommandInput, ListPlaceIndexesCommandOutput } from "./commands/ListPlaceIndexesCommand";
@@ -58,6 +61,7 @@ import type { PutGeofenceCommandInput, PutGeofenceCommandOutput } from "./comman
58
61
  import type { SearchPlaceIndexForPositionCommandInput, SearchPlaceIndexForPositionCommandOutput } from "./commands/SearchPlaceIndexForPositionCommand";
59
62
  import type { SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput } from "./commands/SearchPlaceIndexForSuggestionsCommand";
60
63
  import type { SearchPlaceIndexForTextCommandInput, SearchPlaceIndexForTextCommandOutput } from "./commands/SearchPlaceIndexForTextCommand";
64
+ import type { StartJobCommandInput, StartJobCommandOutput } from "./commands/StartJobCommand";
61
65
  import type { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
62
66
  import type { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
63
67
  import type { UpdateGeofenceCollectionCommandInput, UpdateGeofenceCollectionCommandOutput } from "./commands/UpdateGeofenceCollectionCommand";
@@ -73,11 +77,11 @@ export { __Client };
73
77
  /**
74
78
  * @public
75
79
  */
76
- export type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CreateGeofenceCollectionCommandInput | CreateKeyCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteKeyCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeKeyCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | ForecastGeofenceEventsCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | GetPlaceCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListKeysCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateKeyCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput | VerifyDevicePositionCommandInput;
80
+ export type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CancelJobCommandInput | CreateGeofenceCollectionCommandInput | CreateKeyCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteKeyCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeKeyCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | ForecastGeofenceEventsCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetJobCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | GetPlaceCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListJobsCommandInput | ListKeysCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | StartJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateKeyCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput | VerifyDevicePositionCommandInput;
77
81
  /**
78
82
  * @public
79
83
  */
80
- export type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CreateGeofenceCollectionCommandOutput | CreateKeyCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteKeyCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeKeyCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | ForecastGeofenceEventsCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | GetPlaceCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListKeysCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateKeyCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput | VerifyDevicePositionCommandOutput;
84
+ export type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CancelJobCommandOutput | CreateGeofenceCollectionCommandOutput | CreateKeyCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteKeyCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeKeyCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | ForecastGeofenceEventsCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetJobCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | GetPlaceCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListJobsCommandOutput | ListKeysCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | StartJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateKeyCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput | VerifyDevicePositionCommandOutput;
81
85
  /**
82
86
  * @public
83
87
  */
@@ -0,0 +1,88 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
4
+ import type { CancelJobRequest, CancelJobResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CancelJobCommand}.
14
+ */
15
+ export interface CancelJobCommandInput extends CancelJobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CancelJobCommand}.
21
+ */
22
+ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {
23
+ }
24
+ declare const CancelJobCommand_base: {
25
+ new (input: CancelJobCommandInput): import("@smithy/smithy-client").CommandImpl<CancelJobCommandInput, CancelJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: CancelJobCommandInput): import("@smithy/smithy-client").CommandImpl<CancelJobCommandInput, CancelJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> <code>CancelJob</code> cancels a job that is currently running or pending. If the job is already in a terminal state (<code>Completed</code>, <code>Failed</code>, or <code>Cancelled</code>), the operation returns successfully with the current status.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html">Job concepts</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { LocationClient, CancelJobCommand } from "@aws-sdk/client-location"; // ES Modules import
35
+ * // const { LocationClient, CancelJobCommand } = require("@aws-sdk/client-location"); // CommonJS import
36
+ * // import type { LocationClientConfig } from "@aws-sdk/client-location";
37
+ * const config = {}; // type is LocationClientConfig
38
+ * const client = new LocationClient(config);
39
+ * const input = { // CancelJobRequest
40
+ * JobId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new CancelJobCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // CancelJobResponse
45
+ * // JobArn: "STRING_VALUE", // required
46
+ * // JobId: "STRING_VALUE", // required
47
+ * // Status: "STRING_VALUE", // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param CancelJobCommandInput - {@link CancelJobCommandInput}
53
+ * @returns {@link CancelJobCommandOutput}
54
+ * @see {@link CancelJobCommandInput} for command's `input` shape.
55
+ * @see {@link CancelJobCommandOutput} for command's `response` shape.
56
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
57
+ *
58
+ * @throws {@link AccessDeniedException} (client fault)
59
+ * <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
60
+ *
61
+ * @throws {@link InternalServerException} (server fault)
62
+ * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
63
+ *
64
+ * @throws {@link ThrottlingException} (client fault)
65
+ * <p>The request was denied because of request throttling.</p>
66
+ *
67
+ * @throws {@link ValidationException} (client fault)
68
+ * <p>The input failed to meet the constraints specified by the AWS service. </p>
69
+ *
70
+ * @throws {@link LocationServiceException}
71
+ * <p>Base exception class for all service exceptions from Location service.</p>
72
+ *
73
+ *
74
+ * @public
75
+ */
76
+ export declare class CancelJobCommand extends CancelJobCommand_base {
77
+ /** @internal type navigation helper, not in runtime. */
78
+ protected static __types: {
79
+ api: {
80
+ input: CancelJobRequest;
81
+ output: CancelJobResponse;
82
+ };
83
+ sdk: {
84
+ input: CancelJobCommandInput;
85
+ output: CancelJobCommandOutput;
86
+ };
87
+ };
88
+ }
@@ -0,0 +1,121 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
4
+ import type { GetJobRequest, GetJobResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetJobCommand}.
14
+ */
15
+ export interface GetJobCommandInput extends GetJobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetJobCommand}.
21
+ */
22
+ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
23
+ }
24
+ declare const GetJobCommand_base: {
25
+ new (input: GetJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetJobCommandInput, GetJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetJobCommandInput, GetJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> <code>GetJob</code> retrieves detailed information about a specific job, including its current status, configuration, and error information if the job failed.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html">Job concepts</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { LocationClient, GetJobCommand } from "@aws-sdk/client-location"; // ES Modules import
35
+ * // const { LocationClient, GetJobCommand } = require("@aws-sdk/client-location"); // CommonJS import
36
+ * // import type { LocationClientConfig } from "@aws-sdk/client-location";
37
+ * const config = {}; // type is LocationClientConfig
38
+ * const client = new LocationClient(config);
39
+ * const input = { // GetJobRequest
40
+ * JobId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetJobCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetJobResponse
45
+ * // Action: "STRING_VALUE", // required
46
+ * // ActionOptions: { // JobActionOptions
47
+ * // ValidateAddress: { // ValidateAddressActionOptions
48
+ * // AdditionalFeatures: [ // ValidateAddressAdditionalFeatureList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // },
52
+ * // },
53
+ * // CreatedAt: new Date("TIMESTAMP"), // required
54
+ * // EndedAt: new Date("TIMESTAMP"),
55
+ * // Error: { // JobError
56
+ * // Code: "STRING_VALUE", // required
57
+ * // Messages: [ // JobErrorMessagesList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // ExecutionRoleArn: "STRING_VALUE", // required
62
+ * // InputOptions: { // JobInputOptions
63
+ * // Location: "STRING_VALUE", // required
64
+ * // Format: "STRING_VALUE", // required
65
+ * // },
66
+ * // JobArn: "STRING_VALUE", // required
67
+ * // JobId: "STRING_VALUE", // required
68
+ * // Name: "STRING_VALUE",
69
+ * // OutputOptions: { // JobOutputOptions
70
+ * // Format: "STRING_VALUE", // required
71
+ * // Location: "STRING_VALUE", // required
72
+ * // },
73
+ * // Status: "STRING_VALUE", // required
74
+ * // UpdatedAt: new Date("TIMESTAMP"), // required
75
+ * // Tags: { // TagMap
76
+ * // "<keys>": "STRING_VALUE",
77
+ * // },
78
+ * // };
79
+ *
80
+ * ```
81
+ *
82
+ * @param GetJobCommandInput - {@link GetJobCommandInput}
83
+ * @returns {@link GetJobCommandOutput}
84
+ * @see {@link GetJobCommandInput} for command's `input` shape.
85
+ * @see {@link GetJobCommandOutput} for command's `response` shape.
86
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
87
+ *
88
+ * @throws {@link AccessDeniedException} (client fault)
89
+ * <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
90
+ *
91
+ * @throws {@link InternalServerException} (server fault)
92
+ * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
93
+ *
94
+ * @throws {@link ResourceNotFoundException} (client fault)
95
+ * <p>The resource that you've entered was not found in your AWS account.</p>
96
+ *
97
+ * @throws {@link ThrottlingException} (client fault)
98
+ * <p>The request was denied because of request throttling.</p>
99
+ *
100
+ * @throws {@link ValidationException} (client fault)
101
+ * <p>The input failed to meet the constraints specified by the AWS service. </p>
102
+ *
103
+ * @throws {@link LocationServiceException}
104
+ * <p>Base exception class for all service exceptions from Location service.</p>
105
+ *
106
+ *
107
+ * @public
108
+ */
109
+ export declare class GetJobCommand extends GetJobCommand_base {
110
+ /** @internal type navigation helper, not in runtime. */
111
+ protected static __types: {
112
+ api: {
113
+ input: GetJobRequest;
114
+ output: GetJobResponse;
115
+ };
116
+ sdk: {
117
+ input: GetJobCommandInput;
118
+ output: GetJobCommandOutput;
119
+ };
120
+ };
121
+ }
@@ -0,0 +1,124 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
4
+ import type { ListJobsRequest, ListJobsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListJobsCommand}.
14
+ */
15
+ export interface ListJobsCommandInput extends ListJobsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListJobsCommand}.
21
+ */
22
+ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListJobsCommand_base: {
25
+ new (input: ListJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> <code>ListJobs</code> retrieves a list of jobs with optional filtering and pagination support.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html">Job concepts</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { LocationClient, ListJobsCommand } from "@aws-sdk/client-location"; // ES Modules import
35
+ * // const { LocationClient, ListJobsCommand } = require("@aws-sdk/client-location"); // CommonJS import
36
+ * // import type { LocationClientConfig } from "@aws-sdk/client-location";
37
+ * const config = {}; // type is LocationClientConfig
38
+ * const client = new LocationClient(config);
39
+ * const input = { // ListJobsRequest
40
+ * Filter: { // JobsFilter
41
+ * JobStatus: "STRING_VALUE",
42
+ * },
43
+ * MaxResults: Number("int"),
44
+ * NextToken: "STRING_VALUE",
45
+ * };
46
+ * const command = new ListJobsCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // ListJobsResponse
49
+ * // Entries: [ // ListJobsResponseEntryList // required
50
+ * // { // ListJobsResponseEntry
51
+ * // Action: "STRING_VALUE", // required
52
+ * // ActionOptions: { // JobActionOptions
53
+ * // ValidateAddress: { // ValidateAddressActionOptions
54
+ * // AdditionalFeatures: [ // ValidateAddressAdditionalFeatureList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // },
58
+ * // },
59
+ * // CreatedAt: new Date("TIMESTAMP"), // required
60
+ * // ExecutionRoleArn: "STRING_VALUE", // required
61
+ * // EndedAt: new Date("TIMESTAMP"),
62
+ * // Error: { // JobError
63
+ * // Code: "STRING_VALUE", // required
64
+ * // Messages: [ // JobErrorMessagesList
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // },
68
+ * // InputOptions: { // JobInputOptions
69
+ * // Location: "STRING_VALUE", // required
70
+ * // Format: "STRING_VALUE", // required
71
+ * // },
72
+ * // JobId: "STRING_VALUE", // required
73
+ * // JobArn: "STRING_VALUE", // required
74
+ * // Name: "STRING_VALUE",
75
+ * // OutputOptions: { // JobOutputOptions
76
+ * // Format: "STRING_VALUE", // required
77
+ * // Location: "STRING_VALUE", // required
78
+ * // },
79
+ * // Status: "STRING_VALUE", // required
80
+ * // UpdatedAt: new Date("TIMESTAMP"), // required
81
+ * // },
82
+ * // ],
83
+ * // NextToken: "STRING_VALUE",
84
+ * // };
85
+ *
86
+ * ```
87
+ *
88
+ * @param ListJobsCommandInput - {@link ListJobsCommandInput}
89
+ * @returns {@link ListJobsCommandOutput}
90
+ * @see {@link ListJobsCommandInput} for command's `input` shape.
91
+ * @see {@link ListJobsCommandOutput} for command's `response` shape.
92
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
93
+ *
94
+ * @throws {@link AccessDeniedException} (client fault)
95
+ * <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
96
+ *
97
+ * @throws {@link InternalServerException} (server fault)
98
+ * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
99
+ *
100
+ * @throws {@link ThrottlingException} (client fault)
101
+ * <p>The request was denied because of request throttling.</p>
102
+ *
103
+ * @throws {@link ValidationException} (client fault)
104
+ * <p>The input failed to meet the constraints specified by the AWS service. </p>
105
+ *
106
+ * @throws {@link LocationServiceException}
107
+ * <p>Base exception class for all service exceptions from Location service.</p>
108
+ *
109
+ *
110
+ * @public
111
+ */
112
+ export declare class ListJobsCommand extends ListJobsCommand_base {
113
+ /** @internal type navigation helper, not in runtime. */
114
+ protected static __types: {
115
+ api: {
116
+ input: ListJobsRequest;
117
+ output: ListJobsResponse;
118
+ };
119
+ sdk: {
120
+ input: ListJobsCommandInput;
121
+ output: ListJobsCommandOutput;
122
+ };
123
+ };
124
+ }
@@ -0,0 +1,110 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
4
+ import type { StartJobRequest, StartJobResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartJobCommand}.
14
+ */
15
+ export interface StartJobCommandInput extends StartJobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartJobCommand}.
21
+ */
22
+ export interface StartJobCommandOutput extends StartJobResponse, __MetadataBearer {
23
+ }
24
+ declare const StartJobCommand_base: {
25
+ new (input: StartJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartJobCommandInput, StartJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartJobCommandInput, StartJobCommandOutput, LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> <code>StartJob</code> starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html">Job concepts</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { LocationClient, StartJobCommand } from "@aws-sdk/client-location"; // ES Modules import
35
+ * // const { LocationClient, StartJobCommand } = require("@aws-sdk/client-location"); // CommonJS import
36
+ * // import type { LocationClientConfig } from "@aws-sdk/client-location";
37
+ * const config = {}; // type is LocationClientConfig
38
+ * const client = new LocationClient(config);
39
+ * const input = { // StartJobRequest
40
+ * ClientToken: "STRING_VALUE",
41
+ * Action: "STRING_VALUE", // required
42
+ * ActionOptions: { // JobActionOptions
43
+ * ValidateAddress: { // ValidateAddressActionOptions
44
+ * AdditionalFeatures: [ // ValidateAddressAdditionalFeatureList
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * },
48
+ * },
49
+ * ExecutionRoleArn: "STRING_VALUE", // required
50
+ * InputOptions: { // JobInputOptions
51
+ * Location: "STRING_VALUE", // required
52
+ * Format: "STRING_VALUE", // required
53
+ * },
54
+ * Name: "STRING_VALUE",
55
+ * OutputOptions: { // JobOutputOptions
56
+ * Format: "STRING_VALUE", // required
57
+ * Location: "STRING_VALUE", // required
58
+ * },
59
+ * Tags: { // TagMap
60
+ * "<keys>": "STRING_VALUE",
61
+ * },
62
+ * };
63
+ * const command = new StartJobCommand(input);
64
+ * const response = await client.send(command);
65
+ * // { // StartJobResponse
66
+ * // CreatedAt: new Date("TIMESTAMP"), // required
67
+ * // JobArn: "STRING_VALUE", // required
68
+ * // JobId: "STRING_VALUE", // required
69
+ * // Status: "STRING_VALUE", // required
70
+ * // };
71
+ *
72
+ * ```
73
+ *
74
+ * @param StartJobCommandInput - {@link StartJobCommandInput}
75
+ * @returns {@link StartJobCommandOutput}
76
+ * @see {@link StartJobCommandInput} for command's `input` shape.
77
+ * @see {@link StartJobCommandOutput} for command's `response` shape.
78
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
79
+ *
80
+ * @throws {@link AccessDeniedException} (client fault)
81
+ * <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
82
+ *
83
+ * @throws {@link InternalServerException} (server fault)
84
+ * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
85
+ *
86
+ * @throws {@link ThrottlingException} (client fault)
87
+ * <p>The request was denied because of request throttling.</p>
88
+ *
89
+ * @throws {@link ValidationException} (client fault)
90
+ * <p>The input failed to meet the constraints specified by the AWS service. </p>
91
+ *
92
+ * @throws {@link LocationServiceException}
93
+ * <p>Base exception class for all service exceptions from Location service.</p>
94
+ *
95
+ *
96
+ * @public
97
+ */
98
+ export declare class StartJobCommand extends StartJobCommand_base {
99
+ /** @internal type navigation helper, not in runtime. */
100
+ protected static __types: {
101
+ api: {
102
+ input: StartJobRequest;
103
+ output: StartJobResponse;
104
+ };
105
+ sdk: {
106
+ input: StartJobCommandInput;
107
+ output: StartJobCommandOutput;
108
+ };
109
+ };
110
+ }
@@ -7,6 +7,7 @@ export * from "./BatchPutGeofenceCommand";
7
7
  export * from "./BatchUpdateDevicePositionCommand";
8
8
  export * from "./CalculateRouteCommand";
9
9
  export * from "./CalculateRouteMatrixCommand";
10
+ export * from "./CancelJobCommand";
10
11
  export * from "./CreateGeofenceCollectionCommand";
11
12
  export * from "./CreateKeyCommand";
12
13
  export * from "./CreateMapCommand";
@@ -30,6 +31,7 @@ export * from "./ForecastGeofenceEventsCommand";
30
31
  export * from "./GetDevicePositionCommand";
31
32
  export * from "./GetDevicePositionHistoryCommand";
32
33
  export * from "./GetGeofenceCommand";
34
+ export * from "./GetJobCommand";
33
35
  export * from "./GetMapGlyphsCommand";
34
36
  export * from "./GetMapSpritesCommand";
35
37
  export * from "./GetMapStyleDescriptorCommand";
@@ -38,6 +40,7 @@ export * from "./GetPlaceCommand";
38
40
  export * from "./ListDevicePositionsCommand";
39
41
  export * from "./ListGeofenceCollectionsCommand";
40
42
  export * from "./ListGeofencesCommand";
43
+ export * from "./ListJobsCommand";
41
44
  export * from "./ListKeysCommand";
42
45
  export * from "./ListMapsCommand";
43
46
  export * from "./ListPlaceIndexesCommand";
@@ -49,6 +52,7 @@ export * from "./PutGeofenceCommand";
49
52
  export * from "./SearchPlaceIndexForPositionCommand";
50
53
  export * from "./SearchPlaceIndexForSuggestionsCommand";
51
54
  export * from "./SearchPlaceIndexForTextCommand";
55
+ export * from "./StartJobCommand";
52
56
  export * from "./TagResourceCommand";
53
57
  export * from "./UntagResourceCommand";
54
58
  export * from "./UpdateGeofenceCollectionCommand";
@@ -0,0 +1,2 @@
1
+ import { BinaryDecisionDiagram } from "@smithy/util-endpoints";
2
+ export declare const bdd: BinaryDecisionDiagram;
@@ -11,6 +11,7 @@ export type { LocationExtensionConfiguration } from "./extensionConfiguration";
11
11
  export * from "./commands";
12
12
  export * from "./schemas/schemas_0";
13
13
  export * from "./pagination";
14
+ export * from "./waiters";
14
15
  export * from "./models/enums";
15
16
  export * from "./models/errors";
16
17
  export * from "./models/models_0";
@@ -34,6 +34,40 @@ export type VehicleWeightUnit = "Kilograms" | "Pounds";
34
34
  * @public
35
35
  */
36
36
  export type RouteMatrixErrorCode = "DeparturePositionNotFound" | "DestinationPositionNotFound" | "OtherValidationError" | "PositionsNotFound" | "RouteNotFound" | "RouteTooLong";
37
+ /**
38
+ * @public
39
+ * @enum
40
+ */
41
+ export declare const JobStatus: {
42
+ /**
43
+ * The job has been cancelled and cannot be resumed.
44
+ */
45
+ readonly CANCELLED: "Cancelled";
46
+ /**
47
+ * The job is being cancelled.
48
+ */
49
+ readonly CANCELLING: "Cancelling";
50
+ /**
51
+ * The job has processed all records and is complete.
52
+ */
53
+ readonly COMPLETED: "Completed";
54
+ /**
55
+ * The job has failed to process all records.
56
+ */
57
+ readonly FAILED: "Failed";
58
+ /**
59
+ * The job has not yet started.
60
+ */
61
+ readonly PENDING: "Pending";
62
+ /**
63
+ * The job is currently running.
64
+ */
65
+ readonly RUNNING: "Running";
66
+ };
67
+ /**
68
+ * @public
69
+ */
70
+ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
37
71
  /**
38
72
  * @public
39
73
  */
@@ -54,3 +88,63 @@ export type ForecastedGeofenceEventType = "ENTER" | "EXIT" | "IDLE";
54
88
  * @public
55
89
  */
56
90
  export type SpeedUnit = "KilometersPerHour" | "MilesPerHour";
91
+ /**
92
+ * @public
93
+ * @enum
94
+ */
95
+ export declare const JobAction: {
96
+ /**
97
+ * The job will perform address validation over the job's input.
98
+ */
99
+ readonly VALIDATE_ADDRESS: "ValidateAddress";
100
+ };
101
+ /**
102
+ * @public
103
+ */
104
+ export type JobAction = (typeof JobAction)[keyof typeof JobAction];
105
+ /**
106
+ * @public
107
+ * @enum
108
+ */
109
+ export declare const ValidateAddressAdditionalFeature: {
110
+ readonly COUNTRY_SPECIFIC_ATTRIBUTES: "CountrySpecificAttributes";
111
+ readonly POSITION: "Position";
112
+ };
113
+ /**
114
+ * @public
115
+ */
116
+ export type ValidateAddressAdditionalFeature = (typeof ValidateAddressAdditionalFeature)[keyof typeof ValidateAddressAdditionalFeature];
117
+ /**
118
+ * @public
119
+ * @enum
120
+ */
121
+ export declare const JobErrorCode: {
122
+ readonly INTERNAL_SERVER_ERROR: "InternalServerError";
123
+ readonly VALIDATION_ERROR: "ValidationError";
124
+ };
125
+ /**
126
+ * @public
127
+ */
128
+ export type JobErrorCode = (typeof JobErrorCode)[keyof typeof JobErrorCode];
129
+ /**
130
+ * @public
131
+ * @enum
132
+ */
133
+ export declare const JobInputFormat: {
134
+ readonly PARQUET: "Parquet";
135
+ };
136
+ /**
137
+ * @public
138
+ */
139
+ export type JobInputFormat = (typeof JobInputFormat)[keyof typeof JobInputFormat];
140
+ /**
141
+ * @public
142
+ * @enum
143
+ */
144
+ export declare const JobOutputFormat: {
145
+ readonly PARQUET: "Parquet";
146
+ };
147
+ /**
148
+ * @public
149
+ */
150
+ export type JobOutputFormat = (typeof JobOutputFormat)[keyof typeof JobOutputFormat];