@aws-sdk/client-iot-jobs-data-plane 3.33.0 → 3.36.1

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 (115) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/IoTJobsDataPlane.js +1 -15
  3. package/dist-cjs/IoTJobsDataPlaneClient.js +35 -0
  4. package/{dist/cjs → dist-cjs}/commands/DescribeJobExecutionCommand.js +2 -27
  5. package/{dist/cjs → dist-cjs}/commands/GetPendingJobExecutionsCommand.js +2 -27
  6. package/{dist/cjs → dist-cjs}/commands/StartNextPendingJobExecutionCommand.js +2 -27
  7. package/{dist/cjs → dist-cjs}/commands/UpdateJobExecutionCommand.js +2 -27
  8. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  9. package/{dist/cjs → dist-cjs}/index.js +0 -1
  10. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  11. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -55
  12. package/{dist/cjs → dist-cjs}/protocols/Aws_restJson1.js +0 -6
  13. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  14. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  15. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  16. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  17. package/{dist/es → dist-es}/IoTJobsDataPlane.js +2 -16
  18. package/{dist/es → dist-es}/IoTJobsDataPlaneClient.js +2 -21
  19. package/{dist/es → dist-es}/commands/DescribeJobExecutionCommand.js +4 -30
  20. package/{dist/es → dist-es}/commands/GetPendingJobExecutionsCommand.js +4 -30
  21. package/{dist/es → dist-es}/commands/StartNextPendingJobExecutionCommand.js +4 -30
  22. package/{dist/es → dist-es}/commands/UpdateJobExecutionCommand.js +4 -30
  23. package/{dist/es → dist-es}/endpoints.js +1 -2
  24. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  25. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  26. package/{dist/es → dist-es}/models/models_0.js +0 -55
  27. package/{dist/es → dist-es}/protocols/Aws_restJson1.js +127 -133
  28. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  29. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  30. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  31. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  32. package/{dist/types → dist-types}/IoTJobsDataPlane.d.ts +2 -2
  33. package/{dist/types → dist-types}/IoTJobsDataPlaneClient.d.ts +5 -5
  34. package/{dist/types → dist-types}/commands/DescribeJobExecutionCommand.d.ts +2 -2
  35. package/{dist/types → dist-types}/commands/GetPendingJobExecutionsCommand.d.ts +2 -2
  36. package/{dist/types → dist-types}/commands/StartNextPendingJobExecutionCommand.d.ts +2 -2
  37. package/{dist/types → dist-types}/commands/UpdateJobExecutionCommand.d.ts +2 -2
  38. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  39. package/{index.ts → dist-types/index.d.ts} +0 -0
  40. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  41. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  42. package/{dist/types → dist-types}/protocols/Aws_restJson1.d.ts +2 -2
  43. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  44. package/{dist/types → dist-types}/runtimeConfig.d.ts +2 -4
  45. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  46. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  47. package/{dist/types → dist-types}/ts3.4/IoTJobsDataPlane.d.ts +7 -27
  48. package/dist-types/ts3.4/IoTJobsDataPlaneClient.d.ts +71 -0
  49. package/{dist/types → dist-types}/ts3.4/commands/DescribeJobExecutionCommand.d.ts +4 -22
  50. package/{dist/types → dist-types}/ts3.4/commands/GetPendingJobExecutionsCommand.d.ts +4 -22
  51. package/{dist/types → dist-types}/ts3.4/commands/StartNextPendingJobExecutionCommand.d.ts +4 -22
  52. package/{dist/types → dist-types}/ts3.4/commands/UpdateJobExecutionCommand.d.ts +4 -22
  53. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  54. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  55. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  56. package/dist-types/ts3.4/models/models_0.d.ts +251 -0
  57. package/{dist/types → dist-types}/ts3.4/protocols/Aws_restJson1.d.ts +2 -2
  58. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  59. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +3 -7
  60. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  61. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  62. package/package.json +52 -49
  63. package/IoTJobsDataPlane.ts +0 -165
  64. package/IoTJobsDataPlaneClient.ts +0 -266
  65. package/commands/DescribeJobExecutionCommand.ts +0 -94
  66. package/commands/GetPendingJobExecutionsCommand.ts +0 -94
  67. package/commands/StartNextPendingJobExecutionCommand.ts +0 -99
  68. package/commands/UpdateJobExecutionCommand.ts +0 -94
  69. package/dist/cjs/IoTJobsDataPlane.js.map +0 -1
  70. package/dist/cjs/IoTJobsDataPlaneClient.js +0 -54
  71. package/dist/cjs/IoTJobsDataPlaneClient.js.map +0 -1
  72. package/dist/cjs/commands/DescribeJobExecutionCommand.js.map +0 -1
  73. package/dist/cjs/commands/GetPendingJobExecutionsCommand.js.map +0 -1
  74. package/dist/cjs/commands/StartNextPendingJobExecutionCommand.js.map +0 -1
  75. package/dist/cjs/commands/UpdateJobExecutionCommand.js.map +0 -1
  76. package/dist/cjs/endpoints.js.map +0 -1
  77. package/dist/cjs/index.js.map +0 -1
  78. package/dist/cjs/models/index.js.map +0 -1
  79. package/dist/cjs/models/models_0.js.map +0 -1
  80. package/dist/cjs/package.json +0 -91
  81. package/dist/cjs/protocols/Aws_restJson1.js.map +0 -1
  82. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  83. package/dist/cjs/runtimeConfig.js.map +0 -1
  84. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  85. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  86. package/dist/es/IoTJobsDataPlane.js.map +0 -1
  87. package/dist/es/IoTJobsDataPlaneClient.js.map +0 -1
  88. package/dist/es/commands/DescribeJobExecutionCommand.js.map +0 -1
  89. package/dist/es/commands/GetPendingJobExecutionsCommand.js.map +0 -1
  90. package/dist/es/commands/StartNextPendingJobExecutionCommand.js.map +0 -1
  91. package/dist/es/commands/UpdateJobExecutionCommand.js.map +0 -1
  92. package/dist/es/endpoints.js.map +0 -1
  93. package/dist/es/index.js +0 -8
  94. package/dist/es/index.js.map +0 -1
  95. package/dist/es/models/index.js +0 -2
  96. package/dist/es/models/index.js.map +0 -1
  97. package/dist/es/models/models_0.js.map +0 -1
  98. package/dist/es/package.json +0 -91
  99. package/dist/es/protocols/Aws_restJson1.js.map +0 -1
  100. package/dist/es/runtimeConfig.browser.js.map +0 -1
  101. package/dist/es/runtimeConfig.js.map +0 -1
  102. package/dist/es/runtimeConfig.native.js.map +0 -1
  103. package/dist/es/runtimeConfig.shared.js.map +0 -1
  104. package/dist/types/ts3.4/IoTJobsDataPlaneClient.d.ts +0 -146
  105. package/dist/types/ts3.4/models/models_0.d.ts +0 -435
  106. package/endpoints.ts +0 -91
  107. package/jest.config.js +0 -4
  108. package/models/models_0.ts +0 -533
  109. package/protocols/Aws_restJson1.ts +0 -848
  110. package/runtimeConfig.browser.ts +0 -40
  111. package/runtimeConfig.native.ts +0 -16
  112. package/runtimeConfig.shared.ts +0 -16
  113. package/runtimeConfig.ts +0 -45
  114. package/tsconfig.es.json +0 -12
  115. package/tsconfig.json +0 -32
@@ -1,146 +0,0 @@
1
- import { DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput } from "./commands/DescribeJobExecutionCommand";
2
- import { GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput } from "./commands/GetPendingJobExecutionsCommand";
3
- import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput } from "./commands/StartNextPendingJobExecutionCommand";
4
- import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "./commands/UpdateJobExecutionCommand";
5
- import { EndpointsInputConfig, EndpointsResolvedConfig, RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
6
- import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
7
- import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
8
- import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
9
- import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
10
- import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
11
- import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
12
- import { Provider, RegionInfoProvider, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
13
- export declare type ServiceInputTypes = DescribeJobExecutionCommandInput | GetPendingJobExecutionsCommandInput | StartNextPendingJobExecutionCommandInput | UpdateJobExecutionCommandInput;
14
- export declare type ServiceOutputTypes = DescribeJobExecutionCommandOutput | GetPendingJobExecutionsCommandOutput | StartNextPendingJobExecutionCommandOutput | UpdateJobExecutionCommandOutput;
15
- export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
16
- /**
17
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
18
- */
19
- requestHandler?: __HttpHandler;
20
- /**
21
- * A constructor for a class implementing the {@link __Hash} interface
22
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
23
- * @internal
24
- */
25
- sha256?: __HashConstructor;
26
- /**
27
- * The function that will be used to convert strings into HTTP endpoints.
28
- * @internal
29
- */
30
- urlParser?: __UrlParser;
31
- /**
32
- * A function that can calculate the length of a request body.
33
- * @internal
34
- */
35
- bodyLengthChecker?: (body: any) => number | undefined;
36
- /**
37
- * A function that converts a stream into an array of bytes.
38
- * @internal
39
- */
40
- streamCollector?: __StreamCollector;
41
- /**
42
- * The function that will be used to convert a base64-encoded string to a byte array.
43
- * @internal
44
- */
45
- base64Decoder?: __Decoder;
46
- /**
47
- * The function that will be used to convert binary data to a base64-encoded string.
48
- * @internal
49
- */
50
- base64Encoder?: __Encoder;
51
- /**
52
- * The function that will be used to convert a UTF8-encoded string to a byte array.
53
- * @internal
54
- */
55
- utf8Decoder?: __Decoder;
56
- /**
57
- * The function that will be used to convert binary data to a UTF-8 encoded string.
58
- * @internal
59
- */
60
- utf8Encoder?: __Encoder;
61
- /**
62
- * The runtime environment.
63
- * @internal
64
- */
65
- runtime?: string;
66
- /**
67
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
68
- * trait of an operation.
69
- */
70
- disableHostPrefix?: boolean;
71
- /**
72
- * Value for how many times a request will be made at most in case of retry.
73
- */
74
- maxAttempts?: number | __Provider<number>;
75
- /**
76
- * Specifies which retry algorithm to use.
77
- */
78
- retryMode?: string | __Provider<string>;
79
- /**
80
- * Optional logger for logging debug/info/warn/error.
81
- */
82
- logger?: __Logger;
83
- /**
84
- * Unique service identifier.
85
- * @internal
86
- */
87
- serviceId?: string;
88
- /**
89
- * The AWS region to which this client will send requests
90
- */
91
- region?: string | __Provider<string>;
92
- /**
93
- * Default credentials provider; Not available in browser runtime.
94
- * @internal
95
- */
96
- credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
97
- /**
98
- * Fetch related hostname, signing name or signing region with given region.
99
- * @internal
100
- */
101
- regionInfoProvider?: RegionInfoProvider;
102
- /**
103
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
104
- * @internal
105
- */
106
- defaultUserAgentProvider?: Provider<__UserAgent>;
107
- }
108
- declare type IoTJobsDataPlaneClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
109
- /**
110
- * The configuration interface of IoTJobsDataPlaneClient class constructor that set the region, credentials and other options.
111
- */
112
- export interface IoTJobsDataPlaneClientConfig extends IoTJobsDataPlaneClientConfigType {
113
- }
114
- declare type IoTJobsDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
115
- /**
116
- * The resolved configuration interface of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
117
- */
118
- export interface IoTJobsDataPlaneClientResolvedConfig extends IoTJobsDataPlaneClientResolvedConfigType {
119
- }
120
- /**
121
- * <p>AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to
122
- * and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a
123
- * set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform
124
- * remote troubleshooting operations.</p>
125
- * <p> To create a job, you make a job document which is a description of the remote operations to be
126
- * performed, and you specify a list of targets that should perform the operations. The targets can be individual
127
- * things, thing groups or both.</p>
128
- * <p> AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the
129
- * execution of the job by downloading the job document, performing the operations it specifies, and reporting its
130
- * progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and
131
- * for all the targets of the job</p>
132
- */
133
- export declare class IoTJobsDataPlaneClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTJobsDataPlaneClientResolvedConfig> {
134
- /**
135
- * The resolved configuration of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
136
- */
137
- readonly config: IoTJobsDataPlaneClientResolvedConfig;
138
- constructor(configuration: IoTJobsDataPlaneClientConfig);
139
- /**
140
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
141
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
142
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
143
- */
144
- destroy(): void;
145
- }
146
- export {};
@@ -1,435 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>The certificate is invalid.</p>
4
- */
5
- export interface CertificateValidationException extends __SmithyException, $MetadataBearer {
6
- name: "CertificateValidationException";
7
- $fault: "client";
8
- /**
9
- * <p>Additional information about the exception.</p>
10
- */
11
- message?: string;
12
- }
13
- export declare namespace CertificateValidationException {
14
- /**
15
- * @internal
16
- */
17
- const filterSensitiveLog: (obj: CertificateValidationException) => any;
18
- }
19
- export interface DescribeJobExecutionRequest {
20
- /**
21
- * <p>The unique identifier assigned to this job when it was created.</p>
22
- */
23
- jobId: string | undefined;
24
- /**
25
- * <p>The thing name associated with the device the job execution is running on.</p>
26
- */
27
- thingName: string | undefined;
28
- /**
29
- * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
30
- */
31
- includeJobDocument?: boolean;
32
- /**
33
- * <p>Optional. A number that identifies a particular job execution on a particular device. If not specified,
34
- * the latest job execution is returned.</p>
35
- */
36
- executionNumber?: number;
37
- }
38
- export declare namespace DescribeJobExecutionRequest {
39
- /**
40
- * @internal
41
- */
42
- const filterSensitiveLog: (obj: DescribeJobExecutionRequest) => any;
43
- }
44
- export declare enum JobExecutionStatus {
45
- CANCELED = "CANCELED",
46
- FAILED = "FAILED",
47
- IN_PROGRESS = "IN_PROGRESS",
48
- QUEUED = "QUEUED",
49
- REJECTED = "REJECTED",
50
- REMOVED = "REMOVED",
51
- SUCCEEDED = "SUCCEEDED",
52
- TIMED_OUT = "TIMED_OUT"
53
- }
54
- /**
55
- * <p>Contains data about a job execution.</p>
56
- */
57
- export interface JobExecution {
58
- /**
59
- * <p>The unique identifier you assigned to this job when it was created.</p>
60
- */
61
- jobId?: string;
62
- /**
63
- * <p>The name of the thing that is executing the job.</p>
64
- */
65
- thingName?: string;
66
- /**
67
- * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
68
- * "REJECTED", or "REMOVED".</p>
69
- */
70
- status?: JobExecutionStatus | string;
71
- /**
72
- * <p>A collection of name/value pairs that describe the status of the job execution.</p>
73
- */
74
- statusDetails?: {
75
- [key: string]: string;
76
- };
77
- /**
78
- * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
79
- */
80
- queuedAt?: number;
81
- /**
82
- * <p>The time, in milliseconds since the epoch, when the job execution was started.</p>
83
- */
84
- startedAt?: number;
85
- /**
86
- * <p>The time, in milliseconds since the epoch, when the job execution was last updated. </p>
87
- */
88
- lastUpdatedAt?: number;
89
- /**
90
- * <p>The estimated number of seconds that remain before the job execution status will be
91
- * changed to <code>TIMED_OUT</code>.</p>
92
- */
93
- approximateSecondsBeforeTimedOut?: number;
94
- /**
95
- * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
96
- * device.</p>
97
- */
98
- versionNumber?: number;
99
- /**
100
- * <p>A number that identifies a particular job execution on a particular device. It can be used later in
101
- * commands that return or update job execution information.</p>
102
- */
103
- executionNumber?: number;
104
- /**
105
- * <p>The content of the job document.</p>
106
- */
107
- jobDocument?: string;
108
- }
109
- export declare namespace JobExecution {
110
- /**
111
- * @internal
112
- */
113
- const filterSensitiveLog: (obj: JobExecution) => any;
114
- }
115
- export interface DescribeJobExecutionResponse {
116
- /**
117
- * <p>Contains data about a job execution.</p>
118
- */
119
- execution?: JobExecution;
120
- }
121
- export declare namespace DescribeJobExecutionResponse {
122
- /**
123
- * @internal
124
- */
125
- const filterSensitiveLog: (obj: DescribeJobExecutionResponse) => any;
126
- }
127
- /**
128
- * <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
129
- */
130
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
131
- name: "InvalidRequestException";
132
- $fault: "client";
133
- /**
134
- * <p>The message for the exception.</p>
135
- */
136
- message?: string;
137
- }
138
- export declare namespace InvalidRequestException {
139
- /**
140
- * @internal
141
- */
142
- const filterSensitiveLog: (obj: InvalidRequestException) => any;
143
- }
144
- /**
145
- * <p>The specified resource does not exist.</p>
146
- */
147
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
148
- name: "ResourceNotFoundException";
149
- $fault: "client";
150
- /**
151
- * <p>The message for the exception.</p>
152
- */
153
- message?: string;
154
- }
155
- export declare namespace ResourceNotFoundException {
156
- /**
157
- * @internal
158
- */
159
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
160
- }
161
- /**
162
- * <p>The service is temporarily unavailable.</p>
163
- */
164
- export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
165
- name: "ServiceUnavailableException";
166
- $fault: "server";
167
- /**
168
- * <p>The message for the exception.</p>
169
- */
170
- message?: string;
171
- }
172
- export declare namespace ServiceUnavailableException {
173
- /**
174
- * @internal
175
- */
176
- const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
177
- }
178
- /**
179
- * <p>The job is in a terminal state.</p>
180
- */
181
- export interface TerminalStateException extends __SmithyException, $MetadataBearer {
182
- name: "TerminalStateException";
183
- $fault: "client";
184
- message?: string;
185
- }
186
- export declare namespace TerminalStateException {
187
- /**
188
- * @internal
189
- */
190
- const filterSensitiveLog: (obj: TerminalStateException) => any;
191
- }
192
- /**
193
- * <p>The rate exceeds the limit.</p>
194
- */
195
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
196
- name: "ThrottlingException";
197
- $fault: "client";
198
- /**
199
- * <p>The message associated with the exception.</p>
200
- */
201
- message?: string;
202
- /**
203
- * <p>The payload associated with the exception.</p>
204
- */
205
- payload?: Uint8Array;
206
- }
207
- export declare namespace ThrottlingException {
208
- /**
209
- * @internal
210
- */
211
- const filterSensitiveLog: (obj: ThrottlingException) => any;
212
- }
213
- export interface GetPendingJobExecutionsRequest {
214
- /**
215
- * <p>The name of the thing that is executing the job.</p>
216
- */
217
- thingName: string | undefined;
218
- }
219
- export declare namespace GetPendingJobExecutionsRequest {
220
- /**
221
- * @internal
222
- */
223
- const filterSensitiveLog: (obj: GetPendingJobExecutionsRequest) => any;
224
- }
225
- /**
226
- * <p>Contains a subset of information about a job execution.</p>
227
- */
228
- export interface JobExecutionSummary {
229
- /**
230
- * <p>The unique identifier you assigned to this job when it was created.</p>
231
- */
232
- jobId?: string;
233
- /**
234
- * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
235
- */
236
- queuedAt?: number;
237
- /**
238
- * <p>The time, in milliseconds since the epoch, when the job execution started.</p>
239
- */
240
- startedAt?: number;
241
- /**
242
- * <p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>
243
- */
244
- lastUpdatedAt?: number;
245
- /**
246
- * <p>The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives
247
- * an update from a device.</p>
248
- */
249
- versionNumber?: number;
250
- /**
251
- * <p>A number that identifies a particular job execution on a particular device.</p>
252
- */
253
- executionNumber?: number;
254
- }
255
- export declare namespace JobExecutionSummary {
256
- /**
257
- * @internal
258
- */
259
- const filterSensitiveLog: (obj: JobExecutionSummary) => any;
260
- }
261
- export interface GetPendingJobExecutionsResponse {
262
- /**
263
- * <p>A list of JobExecutionSummary objects with status IN_PROGRESS.</p>
264
- */
265
- inProgressJobs?: JobExecutionSummary[];
266
- /**
267
- * <p>A list of JobExecutionSummary objects with status QUEUED.</p>
268
- */
269
- queuedJobs?: JobExecutionSummary[];
270
- }
271
- export declare namespace GetPendingJobExecutionsResponse {
272
- /**
273
- * @internal
274
- */
275
- const filterSensitiveLog: (obj: GetPendingJobExecutionsResponse) => any;
276
- }
277
- /**
278
- * <p>An update attempted to change the job execution to a state that is invalid because of the job execution's
279
- * current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this
280
- * case, the body of the error message also contains the executionState field.</p>
281
- */
282
- export interface InvalidStateTransitionException extends __SmithyException, $MetadataBearer {
283
- name: "InvalidStateTransitionException";
284
- $fault: "client";
285
- message?: string;
286
- }
287
- export declare namespace InvalidStateTransitionException {
288
- /**
289
- * @internal
290
- */
291
- const filterSensitiveLog: (obj: InvalidStateTransitionException) => any;
292
- }
293
- export interface StartNextPendingJobExecutionRequest {
294
- /**
295
- * <p>The name of the thing associated with the device.</p>
296
- */
297
- thingName: string | undefined;
298
- /**
299
- * <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the
300
- * statusDetails are unchanged.</p>
301
- */
302
- statusDetails?: {
303
- [key: string]: string;
304
- };
305
- /**
306
- * <p>Specifies the amount of time this device has to finish execution of this job. If the job
307
- * execution status is not set to a terminal state before this timer expires, or before the
308
- * timer is reset (by calling <code>UpdateJobExecution</code>, setting the status to
309
- * <code>IN_PROGRESS</code> and specifying a new timeout value in field <code>stepTimeoutInMinutes</code>)
310
- * the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting
311
- * this timeout has no effect on that job execution timeout which may have been specified when
312
- * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
313
- */
314
- stepTimeoutInMinutes?: number;
315
- }
316
- export declare namespace StartNextPendingJobExecutionRequest {
317
- /**
318
- * @internal
319
- */
320
- const filterSensitiveLog: (obj: StartNextPendingJobExecutionRequest) => any;
321
- }
322
- export interface StartNextPendingJobExecutionResponse {
323
- /**
324
- * <p>A JobExecution object.</p>
325
- */
326
- execution?: JobExecution;
327
- }
328
- export declare namespace StartNextPendingJobExecutionResponse {
329
- /**
330
- * @internal
331
- */
332
- const filterSensitiveLog: (obj: StartNextPendingJobExecutionResponse) => any;
333
- }
334
- export interface UpdateJobExecutionRequest {
335
- /**
336
- * <p>The unique identifier assigned to this job when it was created.</p>
337
- */
338
- jobId: string | undefined;
339
- /**
340
- * <p>The name of the thing associated with the device.</p>
341
- */
342
- thingName: string | undefined;
343
- /**
344
- * <p>The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified
345
- * on every update.</p>
346
- */
347
- status: JobExecutionStatus | string | undefined;
348
- /**
349
- * <p> Optional. A collection of name/value pairs that describe the status of the job execution. If not
350
- * specified, the statusDetails are unchanged.</p>
351
- */
352
- statusDetails?: {
353
- [key: string]: string;
354
- };
355
- /**
356
- * <p>Specifies the amount of time this device has to finish execution of this job. If the job
357
- * execution status is not set to a terminal state before this timer expires, or before the
358
- * timer is reset (by again calling <code>UpdateJobExecution</code>, setting the status to
359
- * <code>IN_PROGRESS</code> and specifying a new timeout value in this field) the job execution
360
- * status will be automatically set to <code>TIMED_OUT</code>. Note that setting or resetting
361
- * this timeout has no effect on that job execution timeout which may have been specified when
362
- * the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).</p>
363
- */
364
- stepTimeoutInMinutes?: number;
365
- /**
366
- * <p>Optional. The expected current version of the job execution. Each time you update the job execution, its
367
- * version is incremented. If the version of the job execution stored in Jobs does not match, the update is
368
- * rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data
369
- * is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain
370
- * the job execution status data.)</p>
371
- */
372
- expectedVersion?: number;
373
- /**
374
- * <p>Optional. When included and set to true, the response contains the JobExecutionState data. The default is
375
- * false.</p>
376
- */
377
- includeJobExecutionState?: boolean;
378
- /**
379
- * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
380
- */
381
- includeJobDocument?: boolean;
382
- /**
383
- * <p>Optional. A number that identifies a particular job execution on a particular device.</p>
384
- */
385
- executionNumber?: number;
386
- }
387
- export declare namespace UpdateJobExecutionRequest {
388
- /**
389
- * @internal
390
- */
391
- const filterSensitiveLog: (obj: UpdateJobExecutionRequest) => any;
392
- }
393
- /**
394
- * <p>Contains data about the state of a job execution.</p>
395
- */
396
- export interface JobExecutionState {
397
- /**
398
- * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
399
- * "REJECTED", or "REMOVED".</p>
400
- */
401
- status?: JobExecutionStatus | string;
402
- /**
403
- * <p>A collection of name/value pairs that describe the status of the job execution.</p>
404
- */
405
- statusDetails?: {
406
- [key: string]: string;
407
- };
408
- /**
409
- * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
410
- * device.</p>
411
- */
412
- versionNumber?: number;
413
- }
414
- export declare namespace JobExecutionState {
415
- /**
416
- * @internal
417
- */
418
- const filterSensitiveLog: (obj: JobExecutionState) => any;
419
- }
420
- export interface UpdateJobExecutionResponse {
421
- /**
422
- * <p>A JobExecutionState object.</p>
423
- */
424
- executionState?: JobExecutionState;
425
- /**
426
- * <p>The contents of the Job Documents.</p>
427
- */
428
- jobDocument?: string;
429
- }
430
- export declare namespace UpdateJobExecutionResponse {
431
- /**
432
- * @internal
433
- */
434
- const filterSensitiveLog: (obj: UpdateJobExecutionResponse) => any;
435
- }
package/endpoints.ts DELETED
@@ -1,91 +0,0 @@
1
- import { PartitionHash, RegionHash, getRegionInfo } from "@aws-sdk/config-resolver";
2
- import { RegionInfoProvider } from "@aws-sdk/types";
3
-
4
- const regionHash: RegionHash = {
5
- "fips-ca-central-1": {
6
- hostname: "data.jobs.iot-fips.ca-central-1.amazonaws.com",
7
- signingRegion: "ca-central-1",
8
- },
9
- "fips-us-east-1": {
10
- hostname: "data.jobs.iot-fips.us-east-1.amazonaws.com",
11
- signingRegion: "us-east-1",
12
- },
13
- "fips-us-east-2": {
14
- hostname: "data.jobs.iot-fips.us-east-2.amazonaws.com",
15
- signingRegion: "us-east-2",
16
- },
17
- "fips-us-gov-east-1": {
18
- hostname: "data.jobs.iot-fips.us-gov-east-1.amazonaws.com",
19
- signingRegion: "us-gov-east-1",
20
- },
21
- "fips-us-gov-west-1": {
22
- hostname: "data.jobs.iot-fips.us-gov-west-1.amazonaws.com",
23
- signingRegion: "us-gov-west-1",
24
- },
25
- "fips-us-west-1": {
26
- hostname: "data.jobs.iot-fips.us-west-1.amazonaws.com",
27
- signingRegion: "us-west-1",
28
- },
29
- "fips-us-west-2": {
30
- hostname: "data.jobs.iot-fips.us-west-2.amazonaws.com",
31
- signingRegion: "us-west-2",
32
- },
33
- };
34
-
35
- const partitionHash: PartitionHash = {
36
- aws: {
37
- regions: [
38
- "af-south-1",
39
- "ap-east-1",
40
- "ap-northeast-1",
41
- "ap-northeast-2",
42
- "ap-northeast-3",
43
- "ap-south-1",
44
- "ap-southeast-1",
45
- "ap-southeast-2",
46
- "ca-central-1",
47
- "eu-central-1",
48
- "eu-north-1",
49
- "eu-south-1",
50
- "eu-west-1",
51
- "eu-west-2",
52
- "eu-west-3",
53
- "fips-ca-central-1",
54
- "fips-us-east-1",
55
- "fips-us-east-2",
56
- "fips-us-west-1",
57
- "fips-us-west-2",
58
- "me-south-1",
59
- "sa-east-1",
60
- "us-east-1",
61
- "us-east-2",
62
- "us-west-1",
63
- "us-west-2",
64
- ],
65
- hostname: "data.jobs.iot.{region}.amazonaws.com",
66
- },
67
- "aws-cn": {
68
- regions: ["cn-north-1", "cn-northwest-1"],
69
- hostname: "data.jobs.iot.{region}.amazonaws.com.cn",
70
- },
71
- "aws-iso": {
72
- regions: ["us-iso-east-1"],
73
- hostname: "data.jobs.iot.{region}.c2s.ic.gov",
74
- },
75
- "aws-iso-b": {
76
- regions: ["us-isob-east-1"],
77
- hostname: "data.jobs.iot.{region}.sc2s.sgov.gov",
78
- },
79
- "aws-us-gov": {
80
- regions: ["fips-us-gov-east-1", "fips-us-gov-west-1", "us-gov-east-1", "us-gov-west-1"],
81
- hostname: "data.jobs.iot.{region}.amazonaws.com",
82
- },
83
- };
84
-
85
- export const defaultRegionInfoProvider: RegionInfoProvider = async (region: string, options?: any) =>
86
- getRegionInfo(region, {
87
- ...options,
88
- signingService: "iot-jobs-data",
89
- regionHash,
90
- partitionHash,
91
- });
package/jest.config.js DELETED
@@ -1,4 +0,0 @@
1
- module.exports = {
2
- preset: "ts-jest",
3
- testMatch: ["**/*.spec.ts", "!**/*.browser.spec.ts", "!**/*.integ.spec.ts"],
4
- };