@aws-sdk/client-iot 3.696.0 → 3.699.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 +64 -0
- package/dist-cjs/index.js +555 -0
- package/dist-es/IoT.js +16 -0
- package/dist-es/commands/CreateCommandCommand.js +22 -0
- package/dist-es/commands/DeleteCommandCommand.js +22 -0
- package/dist-es/commands/DeleteCommandExecutionCommand.js +22 -0
- package/dist-es/commands/GetCommandCommand.js +22 -0
- package/dist-es/commands/GetCommandExecutionCommand.js +22 -0
- package/dist-es/commands/ListCommandExecutionsCommand.js +22 -0
- package/dist-es/commands/ListCommandsCommand.js +22 -0
- package/dist-es/commands/UpdateCommandCommand.js +22 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/pagination/ListCommandExecutionsPaginator.js +4 -0
- package/dist-es/pagination/ListCommandsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +387 -0
- package/dist-types/IoT.d.ts +58 -0
- package/dist-types/IoTClient.d.ts +10 -2
- package/dist-types/commands/AssociateSbomWithPackageVersionCommand.d.ts +2 -2
- package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +4 -3
- package/dist-types/commands/CreateCommandCommand.d.ts +127 -0
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +1 -1
- package/dist-types/commands/CreatePackageCommand.d.ts +2 -2
- package/dist-types/commands/CreatePackageVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateTopicRuleDestinationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCommandCommand.d.ts +84 -0
- package/dist-types/commands/DeleteCommandExecutionCommand.d.ts +87 -0
- package/dist-types/commands/DeleteJobCommand.d.ts +6 -7
- package/dist-types/commands/DisassociateSbomFromPackageVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandCommand.d.ts +121 -0
- package/dist-types/commands/GetCommandExecutionCommand.d.ts +117 -0
- package/dist-types/commands/ListCommandExecutionsCommand.d.ts +116 -0
- package/dist-types/commands/ListCommandsCommand.d.ts +96 -0
- package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -1
- package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/commands/ListJobTemplatesCommand.d.ts +1 -2
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCommandCommand.d.ts +94 -0
- package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageVersionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +332 -236
- package/dist-types/models/models_1.d.ts +880 -784
- package/dist-types/models/models_2.d.ts +671 -11
- package/dist-types/pagination/ListCommandExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCommandsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/ts3.4/IoT.d.ts +138 -0
- package/dist-types/ts3.4/IoTClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateTopicRuleDestinationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DeleteAccountAuditConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAuditSuppressionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteCommandExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCommandCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetCommandExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCommandExecutionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCommandsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListDetectMitigationActionsTasksCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDimensionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainConfigurationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFleetMetricsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIndicesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobExecutionsForThingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListJobTemplatesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateCommandCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +39 -21
- package/dist-types/ts3.4/models/models_1.d.ts +148 -129
- package/dist-types/ts3.4/models/models_2.d.ts +147 -1
- package/dist-types/ts3.4/pagination/ListCommandExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCommandsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +4 -4
|
@@ -41,14 +41,16 @@ export interface AbortCriteria {
|
|
|
41
41
|
*/
|
|
42
42
|
action: AbortAction | undefined;
|
|
43
43
|
/**
|
|
44
|
-
* <p>The minimum percentage of job execution failures that must occur to initiate the
|
|
45
|
-
*
|
|
44
|
+
* <p>The minimum percentage of job execution failures that must occur to initiate the
|
|
45
|
+
* job abort.</p>
|
|
46
|
+
* <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99,
|
|
47
|
+
* but not 10.999).</p>
|
|
46
48
|
* @public
|
|
47
49
|
*/
|
|
48
50
|
thresholdPercentage: number | undefined;
|
|
49
51
|
/**
|
|
50
|
-
* <p>The minimum number of things which must receive job execution notifications before
|
|
51
|
-
* can be aborted.</p>
|
|
52
|
+
* <p>The minimum number of things which must receive job execution notifications before
|
|
53
|
+
* the job can be aborted.</p>
|
|
52
54
|
* @public
|
|
53
55
|
*/
|
|
54
56
|
minNumberOfExecutedThings: number | undefined;
|
|
@@ -2101,7 +2103,7 @@ export interface AssociateSbomWithPackageVersionResponse {
|
|
|
2101
2103
|
sbomValidationStatus?: SbomValidationStatus | undefined;
|
|
2102
2104
|
}
|
|
2103
2105
|
/**
|
|
2104
|
-
* <p>
|
|
2106
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
2105
2107
|
* @public
|
|
2106
2108
|
*/
|
|
2107
2109
|
export declare class ConflictException extends __BaseException {
|
|
@@ -2131,7 +2133,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
2131
2133
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
2132
2134
|
}
|
|
2133
2135
|
/**
|
|
2134
|
-
* <p>
|
|
2136
|
+
* <p>Service quota has been exceeded.</p>
|
|
2135
2137
|
* @public
|
|
2136
2138
|
*/
|
|
2137
2139
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -2169,21 +2171,21 @@ export interface AssociateTargetsWithJobRequest {
|
|
|
2169
2171
|
*/
|
|
2170
2172
|
jobId: string | undefined;
|
|
2171
2173
|
/**
|
|
2172
|
-
* <p>An optional comment string describing why the job was associated with the
|
|
2174
|
+
* <p>An optional comment string describing why the job was associated with the
|
|
2175
|
+
* targets.</p>
|
|
2173
2176
|
* @public
|
|
2174
2177
|
*/
|
|
2175
2178
|
comment?: string | undefined;
|
|
2176
2179
|
/**
|
|
2177
2180
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
2178
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
2179
|
-
* contain the value in the following format.</p>
|
|
2181
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
2182
|
+
* MQTT topics that contain the value in the following format.</p>
|
|
2180
2183
|
* <p>
|
|
2181
2184
|
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
2182
2185
|
* </p>
|
|
2183
2186
|
* <note>
|
|
2184
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
2185
|
-
*
|
|
2186
|
-
* up IoT Greengrass core devices.</a>
|
|
2187
|
+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
2188
|
+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
2187
2189
|
* </p>
|
|
2188
2190
|
* </note>
|
|
2189
2191
|
* @public
|
|
@@ -3274,12 +3276,12 @@ export interface CancelJobRequest {
|
|
|
3274
3276
|
*/
|
|
3275
3277
|
comment?: string | undefined;
|
|
3276
3278
|
/**
|
|
3277
|
-
* <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and
|
|
3278
|
-
*
|
|
3279
|
-
*
|
|
3280
|
-
* <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing
|
|
3281
|
-
*
|
|
3282
|
-
*
|
|
3279
|
+
* <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and
|
|
3280
|
+
* "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled.
|
|
3281
|
+
* The default is <code>false</code>.</p>
|
|
3282
|
+
* <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the
|
|
3283
|
+
* job to be unable to update the job execution status. Use caution and ensure that each
|
|
3284
|
+
* device executing a job which is canceled is able to recover to a valid state.</p>
|
|
3283
3285
|
* @public
|
|
3284
3286
|
*/
|
|
3285
3287
|
force?: boolean | undefined;
|
|
@@ -3320,29 +3322,31 @@ export interface CancelJobExecutionRequest {
|
|
|
3320
3322
|
thingName: string | undefined;
|
|
3321
3323
|
/**
|
|
3322
3324
|
* <p>(Optional) If <code>true</code> the job execution will be canceled if it has status
|
|
3323
|
-
*
|
|
3324
|
-
*
|
|
3325
|
-
*
|
|
3326
|
-
*
|
|
3327
|
-
*
|
|
3328
|
-
*
|
|
3329
|
-
*
|
|
3325
|
+
* IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has
|
|
3326
|
+
* status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do
|
|
3327
|
+
* not set <code>force</code> to <code>true</code>, then an
|
|
3328
|
+
* <code>InvalidStateTransitionException</code> will be thrown. The default is
|
|
3329
|
+
* <code>false</code>.</p>
|
|
3330
|
+
* <p>Canceling a job execution which is "IN_PROGRESS", will cause the device to be
|
|
3331
|
+
* unable to update the job execution status. Use caution and ensure that the device is
|
|
3332
|
+
* able to recover to a valid state.</p>
|
|
3330
3333
|
* @public
|
|
3331
3334
|
*/
|
|
3332
3335
|
force?: boolean | undefined;
|
|
3333
3336
|
/**
|
|
3334
|
-
* <p>(Optional) The expected current version of the job execution. Each time you update
|
|
3335
|
-
*
|
|
3336
|
-
*
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3337
|
+
* <p>(Optional) The expected current version of the job execution. Each time you update
|
|
3338
|
+
* the job execution, its version is incremented. If the version of the job execution
|
|
3339
|
+
* stored in Jobs does not match, the update is rejected with a VersionMismatch error, and
|
|
3340
|
+
* an ErrorResponse that contains the current job execution status data is returned. (This
|
|
3341
|
+
* makes it unnecessary to perform a separate DescribeJobExecution request in order to
|
|
3342
|
+
* obtain the job execution status data.)</p>
|
|
3340
3343
|
* @public
|
|
3341
3344
|
*/
|
|
3342
3345
|
expectedVersion?: number | undefined;
|
|
3343
3346
|
/**
|
|
3344
|
-
* <p>A collection of name/value pairs that describe the status of the job execution. If
|
|
3345
|
-
*
|
|
3347
|
+
* <p>A collection of name/value pairs that describe the status of the job execution. If
|
|
3348
|
+
* not specified, the statusDetails are unchanged. You can specify at most 10 name/value
|
|
3349
|
+
* pairs.</p>
|
|
3346
3350
|
* @public
|
|
3347
3351
|
*/
|
|
3348
3352
|
statusDetails?: Record<string, string> | undefined;
|
|
@@ -3721,6 +3725,193 @@ export interface CreateCertificateProviderResponse {
|
|
|
3721
3725
|
*/
|
|
3722
3726
|
certificateProviderArn?: string | undefined;
|
|
3723
3727
|
}
|
|
3728
|
+
/**
|
|
3729
|
+
* <p>The range of possible values that's used to describe a specific command
|
|
3730
|
+
* parameter.</p>
|
|
3731
|
+
* <note>
|
|
3732
|
+
* <p>The <code>commandParameterValue</code> can only have one of the below fields
|
|
3733
|
+
* listed.</p>
|
|
3734
|
+
* </note>
|
|
3735
|
+
* @public
|
|
3736
|
+
*/
|
|
3737
|
+
export interface CommandParameterValue {
|
|
3738
|
+
/**
|
|
3739
|
+
* <p>An attribute of type String. For example:</p>
|
|
3740
|
+
* <p>
|
|
3741
|
+
* <code>"S": "Hello"</code>
|
|
3742
|
+
* </p>
|
|
3743
|
+
* @public
|
|
3744
|
+
*/
|
|
3745
|
+
S?: string | undefined;
|
|
3746
|
+
/**
|
|
3747
|
+
* <p>An attribute of type Boolean. For example:</p>
|
|
3748
|
+
* <p>
|
|
3749
|
+
* <code>"BOOL": true</code>
|
|
3750
|
+
* </p>
|
|
3751
|
+
* @public
|
|
3752
|
+
*/
|
|
3753
|
+
B?: boolean | undefined;
|
|
3754
|
+
/**
|
|
3755
|
+
* <p>An attribute of type Integer (Thirty-Two Bits).</p>
|
|
3756
|
+
* @public
|
|
3757
|
+
*/
|
|
3758
|
+
I?: number | undefined;
|
|
3759
|
+
/**
|
|
3760
|
+
* <p>An attribute of type Long.</p>
|
|
3761
|
+
* @public
|
|
3762
|
+
*/
|
|
3763
|
+
L?: number | undefined;
|
|
3764
|
+
/**
|
|
3765
|
+
* <p>An attribute of type Double (Sixty-Four Bits).</p>
|
|
3766
|
+
* @public
|
|
3767
|
+
*/
|
|
3768
|
+
D?: number | undefined;
|
|
3769
|
+
/**
|
|
3770
|
+
* <p>An attribute of type Binary. For example:</p>
|
|
3771
|
+
* <p>
|
|
3772
|
+
* <code>"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"</code>
|
|
3773
|
+
* </p>
|
|
3774
|
+
* @public
|
|
3775
|
+
*/
|
|
3776
|
+
BIN?: Uint8Array | undefined;
|
|
3777
|
+
/**
|
|
3778
|
+
* <p>An attribute of type unsigned long.</p>
|
|
3779
|
+
* @public
|
|
3780
|
+
*/
|
|
3781
|
+
UL?: string | undefined;
|
|
3782
|
+
}
|
|
3783
|
+
/**
|
|
3784
|
+
* <p>A map of key-value pairs that describe the command.</p>
|
|
3785
|
+
* @public
|
|
3786
|
+
*/
|
|
3787
|
+
export interface CommandParameter {
|
|
3788
|
+
/**
|
|
3789
|
+
* <p>The name of a specific parameter used in a command and command execution.</p>
|
|
3790
|
+
* @public
|
|
3791
|
+
*/
|
|
3792
|
+
name: string | undefined;
|
|
3793
|
+
/**
|
|
3794
|
+
* <p>The value used to describe the command. When you assign a value to a parameter, it
|
|
3795
|
+
* will override any default value that you had already specified.</p>
|
|
3796
|
+
* @public
|
|
3797
|
+
*/
|
|
3798
|
+
value?: CommandParameterValue | undefined;
|
|
3799
|
+
/**
|
|
3800
|
+
* <p>The default value used to describe the command. This is the value assumed by the
|
|
3801
|
+
* parameter if no other value is assigned to it.</p>
|
|
3802
|
+
* @public
|
|
3803
|
+
*/
|
|
3804
|
+
defaultValue?: CommandParameterValue | undefined;
|
|
3805
|
+
/**
|
|
3806
|
+
* <p>The description of the command parameter.</p>
|
|
3807
|
+
* @public
|
|
3808
|
+
*/
|
|
3809
|
+
description?: string | undefined;
|
|
3810
|
+
}
|
|
3811
|
+
/**
|
|
3812
|
+
* @public
|
|
3813
|
+
* @enum
|
|
3814
|
+
*/
|
|
3815
|
+
export declare const CommandNamespace: {
|
|
3816
|
+
readonly AWSIoT: "AWS-IoT";
|
|
3817
|
+
readonly AWSIoTFleetWise: "AWS-IoT-FleetWise";
|
|
3818
|
+
};
|
|
3819
|
+
/**
|
|
3820
|
+
* @public
|
|
3821
|
+
*/
|
|
3822
|
+
export type CommandNamespace = (typeof CommandNamespace)[keyof typeof CommandNamespace];
|
|
3823
|
+
/**
|
|
3824
|
+
* <p>The command payload object that contains the instructions for the device
|
|
3825
|
+
* to process.</p>
|
|
3826
|
+
* @public
|
|
3827
|
+
*/
|
|
3828
|
+
export interface CommandPayload {
|
|
3829
|
+
/**
|
|
3830
|
+
* <p>The static payload file for the command.</p>
|
|
3831
|
+
* @public
|
|
3832
|
+
*/
|
|
3833
|
+
content?: Uint8Array | undefined;
|
|
3834
|
+
/**
|
|
3835
|
+
* <p>The content type that specifies the format type of the payload file. This
|
|
3836
|
+
* field must use a type/subtype format, such as <code>application/json</code>.
|
|
3837
|
+
* For information about various content types, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types">Common MIME types</a>.</p>
|
|
3838
|
+
* @public
|
|
3839
|
+
*/
|
|
3840
|
+
contentType?: string | undefined;
|
|
3841
|
+
}
|
|
3842
|
+
/**
|
|
3843
|
+
* @public
|
|
3844
|
+
*/
|
|
3845
|
+
export interface CreateCommandRequest {
|
|
3846
|
+
/**
|
|
3847
|
+
* <p>A unique identifier for the command. We recommend using UUID. Alpha-numeric
|
|
3848
|
+
* characters, hyphens, and underscores are valid for use here.</p>
|
|
3849
|
+
* @public
|
|
3850
|
+
*/
|
|
3851
|
+
commandId: string | undefined;
|
|
3852
|
+
/**
|
|
3853
|
+
* <p>The namespace of the command. The MQTT reserved topics and validations will be used
|
|
3854
|
+
* for command executions according to the namespace setting.</p>
|
|
3855
|
+
* @public
|
|
3856
|
+
*/
|
|
3857
|
+
namespace?: CommandNamespace | undefined;
|
|
3858
|
+
/**
|
|
3859
|
+
* <p>The user-friendly name in the console for the command. This name doesn't have to be
|
|
3860
|
+
* unique. You can update the user-friendly name after you define it.</p>
|
|
3861
|
+
* @public
|
|
3862
|
+
*/
|
|
3863
|
+
displayName?: string | undefined;
|
|
3864
|
+
/**
|
|
3865
|
+
* <p>A short text decription of the command.</p>
|
|
3866
|
+
* @public
|
|
3867
|
+
*/
|
|
3868
|
+
description?: string | undefined;
|
|
3869
|
+
/**
|
|
3870
|
+
* <p>The payload object for the command. You must specify this information when using
|
|
3871
|
+
* the <code>AWS-IoT</code> namespace.</p>
|
|
3872
|
+
* <p>You can upload a static payload file from your local storage that contains the
|
|
3873
|
+
* instructions for the device to process. The payload file can use any format. To
|
|
3874
|
+
* make sure that the device correctly interprets the payload, we recommend you to
|
|
3875
|
+
* specify the payload content type.</p>
|
|
3876
|
+
* @public
|
|
3877
|
+
*/
|
|
3878
|
+
payload?: CommandPayload | undefined;
|
|
3879
|
+
/**
|
|
3880
|
+
* <p>A list of parameters that are required by the <code>StartCommandExecution</code> API.
|
|
3881
|
+
* These parameters need to be specified only when using the <code>AWS-IoT-FleetWise</code>
|
|
3882
|
+
* namespace. You can either specify them here or when running the command using the
|
|
3883
|
+
* <code>StartCommandExecution</code> API.</p>
|
|
3884
|
+
* @public
|
|
3885
|
+
*/
|
|
3886
|
+
mandatoryParameters?: CommandParameter[] | undefined;
|
|
3887
|
+
/**
|
|
3888
|
+
* <p>The IAM role that allows access to create the command.</p>
|
|
3889
|
+
* @public
|
|
3890
|
+
*/
|
|
3891
|
+
roleArn?: string | undefined;
|
|
3892
|
+
/**
|
|
3893
|
+
* <p>Name-value pairs that are used as metadata to manage a command.</p>
|
|
3894
|
+
* @public
|
|
3895
|
+
*/
|
|
3896
|
+
tags?: Tag[] | undefined;
|
|
3897
|
+
}
|
|
3898
|
+
/**
|
|
3899
|
+
* @public
|
|
3900
|
+
*/
|
|
3901
|
+
export interface CreateCommandResponse {
|
|
3902
|
+
/**
|
|
3903
|
+
* <p>The unique identifier for the command.</p>
|
|
3904
|
+
* @public
|
|
3905
|
+
*/
|
|
3906
|
+
commandId?: string | undefined;
|
|
3907
|
+
/**
|
|
3908
|
+
* <p>The Amazon Resource Number (ARN) of the command. For example,
|
|
3909
|
+
* <code>arn:aws:iot:<region>:<accountid>:command/<commandId></code>
|
|
3910
|
+
* </p>
|
|
3911
|
+
* @public
|
|
3912
|
+
*/
|
|
3913
|
+
commandArn?: string | undefined;
|
|
3914
|
+
}
|
|
3724
3915
|
/**
|
|
3725
3916
|
* @public
|
|
3726
3917
|
* @enum
|
|
@@ -3900,21 +4091,22 @@ export interface ServerCertificateConfig {
|
|
|
3900
4091
|
/**
|
|
3901
4092
|
* <p>The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments
|
|
3902
4093
|
* (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic
|
|
3903
|
-
* OCSP responses.
|
|
3904
|
-
*
|
|
3905
|
-
*
|
|
3906
|
-
* function
|
|
3907
|
-
*
|
|
3908
|
-
*
|
|
4094
|
+
* OCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the
|
|
4095
|
+
* Distinguished Encoding Rules (DER) format. The Lambda function's response is also a
|
|
4096
|
+
* base64-encoded OCSP response in the DER format. The response size must not exceed 4
|
|
4097
|
+
* kilobytes (KiB). The Lambda function must be in the same Amazon Web Services account and region as the
|
|
4098
|
+
* domain configuration. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html#iot-custom-endpoints-cert-config-ocsp-private-endpoint.html">Configuring server certificate OCSP for private endpoints in Amazon Web Services IoT Core</a> from the
|
|
4099
|
+
* Amazon Web Services IoT Core developer guide.</p>
|
|
3909
4100
|
* @public
|
|
3910
4101
|
*/
|
|
3911
4102
|
ocspLambdaArn?: string | undefined;
|
|
3912
4103
|
/**
|
|
3913
|
-
* <p>The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate
|
|
3914
|
-
* If provided, Amazon Web Services IoT Core will use this certificate to validate the signature
|
|
3915
|
-
* The OCSP responder must sign responses using either this
|
|
3916
|
-
*
|
|
3917
|
-
*
|
|
4104
|
+
* <p>The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate
|
|
4105
|
+
* Manager (ACM). If provided, Amazon Web Services IoT Core will use this certificate to validate the signature
|
|
4106
|
+
* of the received OCSP response. The OCSP responder must sign responses using either this
|
|
4107
|
+
* authorized responder certificate or the issuing certificate, depending on whether the ARN
|
|
4108
|
+
* is provided or not. The certificate must be in the same Amazon Web Services account and region as the
|
|
4109
|
+
* domain configuration.</p>
|
|
3918
4110
|
* @public
|
|
3919
4111
|
*/
|
|
3920
4112
|
ocspAuthorizedResponderArn?: string | undefined;
|
|
@@ -4347,8 +4539,8 @@ export declare const RetryableFailureType: {
|
|
|
4347
4539
|
*/
|
|
4348
4540
|
export type RetryableFailureType = (typeof RetryableFailureType)[keyof typeof RetryableFailureType];
|
|
4349
4541
|
/**
|
|
4350
|
-
* <p>The criteria that determines how many retries are allowed for each failure
|
|
4351
|
-
*
|
|
4542
|
+
* <p>The criteria that determines how many retries are allowed for each failure type for a
|
|
4543
|
+
* job.</p>
|
|
4352
4544
|
* @public
|
|
4353
4545
|
*/
|
|
4354
4546
|
export interface RetryCriteria {
|
|
@@ -4364,8 +4556,8 @@ export interface RetryCriteria {
|
|
|
4364
4556
|
numberOfRetries: number | undefined;
|
|
4365
4557
|
}
|
|
4366
4558
|
/**
|
|
4367
|
-
* <p>The configuration that determines how many retries are allowed for each failure
|
|
4368
|
-
*
|
|
4559
|
+
* <p>The configuration that determines how many retries are allowed for each failure type
|
|
4560
|
+
* for a job.</p>
|
|
4369
4561
|
* @public
|
|
4370
4562
|
*/
|
|
4371
4563
|
export interface JobExecutionsRetryConfig {
|
|
@@ -4377,17 +4569,20 @@ export interface JobExecutionsRetryConfig {
|
|
|
4377
4569
|
criteriaList: RetryCriteria[] | undefined;
|
|
4378
4570
|
}
|
|
4379
4571
|
/**
|
|
4380
|
-
* <p>Allows you to define a criteria to initiate the increase in rate of rollout for a
|
|
4572
|
+
* <p>Allows you to define a criteria to initiate the increase in rate of rollout for a
|
|
4573
|
+
* job.</p>
|
|
4381
4574
|
* @public
|
|
4382
4575
|
*/
|
|
4383
4576
|
export interface RateIncreaseCriteria {
|
|
4384
4577
|
/**
|
|
4385
|
-
* <p>The threshold for number of notified things that will initiate the increase in rate
|
|
4578
|
+
* <p>The threshold for number of notified things that will initiate the increase in rate
|
|
4579
|
+
* of rollout.</p>
|
|
4386
4580
|
* @public
|
|
4387
4581
|
*/
|
|
4388
4582
|
numberOfNotifiedThings?: number | undefined;
|
|
4389
4583
|
/**
|
|
4390
|
-
* <p>The threshold for number of succeeded things that will initiate the increase in
|
|
4584
|
+
* <p>The threshold for number of succeeded things that will initiate the increase in
|
|
4585
|
+
* rate of rollout.</p>
|
|
4391
4586
|
* @public
|
|
4392
4587
|
*/
|
|
4393
4588
|
numberOfSucceededThings?: number | undefined;
|
|
@@ -4398,14 +4593,16 @@ export interface RateIncreaseCriteria {
|
|
|
4398
4593
|
*/
|
|
4399
4594
|
export interface ExponentialRolloutRate {
|
|
4400
4595
|
/**
|
|
4401
|
-
* <p>The minimum number of things that will be notified of a pending job, per minute at
|
|
4402
|
-
* This parameter allows you to define the initial rate of
|
|
4596
|
+
* <p>The minimum number of things that will be notified of a pending job, per minute at
|
|
4597
|
+
* the start of job rollout. This parameter allows you to define the initial rate of
|
|
4598
|
+
* rollout.</p>
|
|
4403
4599
|
* @public
|
|
4404
4600
|
*/
|
|
4405
4601
|
baseRatePerMinute: number | undefined;
|
|
4406
4602
|
/**
|
|
4407
4603
|
* <p>The exponential factor to increase the rate of rollout for a job.</p>
|
|
4408
|
-
* <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not
|
|
4604
|
+
* <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not
|
|
4605
|
+
* 1.55).</p>
|
|
4409
4606
|
* @public
|
|
4410
4607
|
*/
|
|
4411
4608
|
incrementFactor: number | undefined;
|
|
@@ -4422,13 +4619,13 @@ export interface ExponentialRolloutRate {
|
|
|
4422
4619
|
export interface JobExecutionsRolloutConfig {
|
|
4423
4620
|
/**
|
|
4424
4621
|
* <p>The maximum number of things that will be notified of a pending job, per minute.
|
|
4425
|
-
*
|
|
4622
|
+
* This parameter allows you to create a staged rollout.</p>
|
|
4426
4623
|
* @public
|
|
4427
4624
|
*/
|
|
4428
4625
|
maximumPerMinute?: number | undefined;
|
|
4429
4626
|
/**
|
|
4430
|
-
* <p>The rate of increase for a job rollout.
|
|
4431
|
-
*
|
|
4627
|
+
* <p>The rate of increase for a job rollout. This parameter allows you to define an
|
|
4628
|
+
* exponential rate for a job rollout.</p>
|
|
4432
4629
|
* @public
|
|
4433
4630
|
*/
|
|
4434
4631
|
exponentialRate?: ExponentialRolloutRate | undefined;
|
|
@@ -4443,15 +4640,16 @@ export interface PresignedUrlConfig {
|
|
|
4443
4640
|
* where the job data/updates are stored. The role must also grant permission for IoT to
|
|
4444
4641
|
* download the files.</p>
|
|
4445
4642
|
* <important>
|
|
4446
|
-
* <p>For information about addressing the confused deputy problem, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html">cross-service
|
|
4447
|
-
*
|
|
4643
|
+
* <p>For information about addressing the confused deputy problem, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html">cross-service confused deputy prevention</a> in the <i>Amazon Web Services IoT Core
|
|
4644
|
+
* developer guide</i>.</p>
|
|
4448
4645
|
* </important>
|
|
4449
4646
|
* @public
|
|
4450
4647
|
*/
|
|
4451
4648
|
roleArn?: string | undefined;
|
|
4452
4649
|
/**
|
|
4453
|
-
* <p>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the
|
|
4454
|
-
* seconds. Pre-signed URLs are generated when Jobs receives an MQTT
|
|
4650
|
+
* <p>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the
|
|
4651
|
+
* default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT
|
|
4652
|
+
* request for the job document.</p>
|
|
4455
4653
|
* @public
|
|
4456
4654
|
*/
|
|
4457
4655
|
expiresInSec?: number | undefined;
|
|
@@ -4470,7 +4668,9 @@ export declare const JobEndBehavior: {
|
|
|
4470
4668
|
*/
|
|
4471
4669
|
export type JobEndBehavior = (typeof JobEndBehavior)[keyof typeof JobEndBehavior];
|
|
4472
4670
|
/**
|
|
4473
|
-
* <p>An optional configuration within the <code>SchedulingConfig</code> to setup a
|
|
4671
|
+
* <p>An optional configuration within the <code>SchedulingConfig</code> to setup a
|
|
4672
|
+
* recurring maintenance window with a predetermined start time and duration for the
|
|
4673
|
+
* rollout of a job document to all devices in a target group for a job.</p>
|
|
4474
4674
|
* @public
|
|
4475
4675
|
*/
|
|
4476
4676
|
export interface MaintenanceWindow {
|
|
@@ -4486,7 +4686,9 @@ export interface MaintenanceWindow {
|
|
|
4486
4686
|
durationInMinutes: number | undefined;
|
|
4487
4687
|
}
|
|
4488
4688
|
/**
|
|
4489
|
-
* <p>Specifies the date and time that a job will begin the rollout of the job document to
|
|
4689
|
+
* <p>Specifies the date and time that a job will begin the rollout of the job document to
|
|
4690
|
+
* all devices in the target group. Additionally, you can specify the end behavior for each
|
|
4691
|
+
* job execution when it reaches the scheduled end time.</p>
|
|
4490
4692
|
* @public
|
|
4491
4693
|
*/
|
|
4492
4694
|
export interface SchedulingConfig {
|
|
@@ -4497,7 +4699,7 @@ export interface SchedulingConfig {
|
|
|
4497
4699
|
* format for the <code>startTime</code> is YYYY-MM-DD for the date and HH:MM for the
|
|
4498
4700
|
* time.</p>
|
|
4499
4701
|
* <p>For more information on the syntax for <code>startTime</code> when using an API
|
|
4500
|
-
*
|
|
4702
|
+
* command or the Command Line Interface, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a>.</p>
|
|
4501
4703
|
* @public
|
|
4502
4704
|
*/
|
|
4503
4705
|
startTime?: string | undefined;
|
|
@@ -4522,7 +4724,9 @@ export interface SchedulingConfig {
|
|
|
4522
4724
|
*/
|
|
4523
4725
|
endBehavior?: JobEndBehavior | undefined;
|
|
4524
4726
|
/**
|
|
4525
|
-
* <p>An optional configuration within the <code>SchedulingConfig</code> to setup a
|
|
4727
|
+
* <p>An optional configuration within the <code>SchedulingConfig</code> to setup a
|
|
4728
|
+
* recurring maintenance window with a predetermined start time and duration for the
|
|
4729
|
+
* rollout of a job document to all devices in a target group for a job.</p>
|
|
4526
4730
|
* @public
|
|
4527
4731
|
*/
|
|
4528
4732
|
maintenanceWindows?: MaintenanceWindow[] | undefined;
|
|
@@ -4540,19 +4744,20 @@ export declare const TargetSelection: {
|
|
|
4540
4744
|
*/
|
|
4541
4745
|
export type TargetSelection = (typeof TargetSelection)[keyof typeof TargetSelection];
|
|
4542
4746
|
/**
|
|
4543
|
-
* <p>Specifies the amount of time each device has to finish its execution of the job.
|
|
4544
|
-
*
|
|
4545
|
-
*
|
|
4546
|
-
*
|
|
4747
|
+
* <p>Specifies the amount of time each device has to finish its execution of the job. A
|
|
4748
|
+
* timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
|
|
4749
|
+
* the job execution status is not set to another terminal state before the timer expires,
|
|
4750
|
+
* it will be automatically set to <code>TIMED_OUT</code>.</p>
|
|
4547
4751
|
* @public
|
|
4548
4752
|
*/
|
|
4549
4753
|
export interface TimeoutConfig {
|
|
4550
4754
|
/**
|
|
4551
|
-
* <p>Specifies the amount of time, in minutes, this device has to finish execution of this
|
|
4552
|
-
*
|
|
4553
|
-
*
|
|
4554
|
-
*
|
|
4555
|
-
*
|
|
4755
|
+
* <p>Specifies the amount of time, in minutes, this device has to finish execution of this
|
|
4756
|
+
* job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080
|
|
4757
|
+
* minutes). The in progress timer can't be updated and will apply to all job executions
|
|
4758
|
+
* for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than
|
|
4759
|
+
* this interval, the job execution will fail and switch to the terminal
|
|
4760
|
+
* <code>TIMED_OUT</code> status.</p>
|
|
4556
4761
|
* @public
|
|
4557
4762
|
*/
|
|
4558
4763
|
inProgressTimeoutInMinutes?: number | undefined;
|
|
@@ -4562,8 +4767,8 @@ export interface TimeoutConfig {
|
|
|
4562
4767
|
*/
|
|
4563
4768
|
export interface CreateJobRequest {
|
|
4564
4769
|
/**
|
|
4565
|
-
* <p>A job identifier which must be unique for your
|
|
4566
|
-
* characters, "-" and "_" are valid for use here.</p>
|
|
4770
|
+
* <p>A job identifier which must be unique for your account. We recommend using a UUID.
|
|
4771
|
+
* Alpha-numeric characters, "-" and "_" are valid for use here.</p>
|
|
4567
4772
|
* @public
|
|
4568
4773
|
*/
|
|
4569
4774
|
jobId: string | undefined;
|
|
@@ -4573,15 +4778,19 @@ export interface CreateJobRequest {
|
|
|
4573
4778
|
*/
|
|
4574
4779
|
targets: string[] | undefined;
|
|
4575
4780
|
/**
|
|
4576
|
-
* <p>An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL
|
|
4577
|
-
*
|
|
4781
|
+
* <p>An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL
|
|
4782
|
+
* and is required if you don't specify a value for <code>document</code>.</p>
|
|
4783
|
+
* <p>For example, <code>--document-source
|
|
4784
|
+
* https://s3.<i>region-code</i>.amazonaws.com/example-firmware/device-firmware.1.0</code>
|
|
4578
4785
|
* </p>
|
|
4579
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html">Methods for accessing a
|
|
4786
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html">Methods for accessing a
|
|
4787
|
+
* bucket</a>.</p>
|
|
4580
4788
|
* @public
|
|
4581
4789
|
*/
|
|
4582
4790
|
documentSource?: string | undefined;
|
|
4583
4791
|
/**
|
|
4584
|
-
* <p>The job document. Required if you don't specify a value for
|
|
4792
|
+
* <p>The job document. Required if you don't specify a value for
|
|
4793
|
+
* <code>documentSource</code>.</p>
|
|
4585
4794
|
* @public
|
|
4586
4795
|
*/
|
|
4587
4796
|
document?: string | undefined;
|
|
@@ -4596,14 +4805,15 @@ export interface CreateJobRequest {
|
|
|
4596
4805
|
*/
|
|
4597
4806
|
presignedUrlConfig?: PresignedUrlConfig | undefined;
|
|
4598
4807
|
/**
|
|
4599
|
-
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
4600
|
-
* specified as targets have completed the job (SNAPSHOT). If
|
|
4601
|
-
*
|
|
4602
|
-
*
|
|
4808
|
+
* <p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete
|
|
4809
|
+
* after all those things specified as targets have completed the job (SNAPSHOT). If
|
|
4810
|
+
* continuous, the job may also be run on a thing when a change is detected in a target.
|
|
4811
|
+
* For example, a job will run on a thing when the thing is added to a target group, even
|
|
4812
|
+
* after the job was completed by all things originally in the group.</p>
|
|
4603
4813
|
* <note>
|
|
4604
|
-
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
4605
|
-
* By using continuous jobs, devices that join the group receive
|
|
4606
|
-
* been created.</p>
|
|
4814
|
+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic
|
|
4815
|
+
* thing group targets. By using continuous jobs, devices that join the group receive
|
|
4816
|
+
* the job execution even after the job has been created.</p>
|
|
4607
4817
|
* </note>
|
|
4608
4818
|
* @public
|
|
4609
4819
|
*/
|
|
@@ -4619,10 +4829,10 @@ export interface CreateJobRequest {
|
|
|
4619
4829
|
*/
|
|
4620
4830
|
abortConfig?: AbortConfig | undefined;
|
|
4621
4831
|
/**
|
|
4622
|
-
* <p>Specifies the amount of time each device has to finish its execution of the job. The
|
|
4623
|
-
*
|
|
4624
|
-
*
|
|
4625
|
-
*
|
|
4832
|
+
* <p>Specifies the amount of time each device has to finish its execution of the job. The
|
|
4833
|
+
* timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
|
|
4834
|
+
* the job execution status is not set to another terminal state before the time expires,
|
|
4835
|
+
* it will be automatically set to <code>TIMED_OUT</code>.</p>
|
|
4626
4836
|
* @public
|
|
4627
4837
|
*/
|
|
4628
4838
|
timeoutConfig?: TimeoutConfig | undefined;
|
|
@@ -4633,15 +4843,14 @@ export interface CreateJobRequest {
|
|
|
4633
4843
|
tags?: Tag[] | undefined;
|
|
4634
4844
|
/**
|
|
4635
4845
|
* <p>The namespace used to indicate that a job is a customer-managed job.</p>
|
|
4636
|
-
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
4637
|
-
* contain the value in the following format.</p>
|
|
4846
|
+
* <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to
|
|
4847
|
+
* MQTT topics that contain the value in the following format.</p>
|
|
4638
4848
|
* <p>
|
|
4639
4849
|
* <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>
|
|
4640
4850
|
* </p>
|
|
4641
4851
|
* <note>
|
|
4642
|
-
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at
|
|
4643
|
-
*
|
|
4644
|
-
* up IoT Greengrass core devices.</a>
|
|
4852
|
+
* <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For
|
|
4853
|
+
* more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a>
|
|
4645
4854
|
* </p>
|
|
4646
4855
|
* </note>
|
|
4647
4856
|
* @public
|
|
@@ -4658,7 +4867,8 @@ export interface CreateJobRequest {
|
|
|
4658
4867
|
*/
|
|
4659
4868
|
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
4660
4869
|
/**
|
|
4661
|
-
* <p>Parameters of an Amazon Web Services managed template that you can specify to create the job
|
|
4870
|
+
* <p>Parameters of an Amazon Web Services managed template that you can specify to create the job
|
|
4871
|
+
* document.</p>
|
|
4662
4872
|
* <note>
|
|
4663
4873
|
* <p>
|
|
4664
4874
|
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
|
|
@@ -4675,11 +4885,12 @@ export interface CreateJobRequest {
|
|
|
4675
4885
|
*/
|
|
4676
4886
|
schedulingConfig?: SchedulingConfig | undefined;
|
|
4677
4887
|
/**
|
|
4678
|
-
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
4679
|
-
*
|
|
4888
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job
|
|
4889
|
+
* successfully completes. The package version must be in either the Published or
|
|
4890
|
+
* Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>. </p>
|
|
4680
4891
|
* <p>
|
|
4681
|
-
* <b>Note:</b>The following Length Constraints relates to a
|
|
4682
|
-
*
|
|
4892
|
+
* <b>Note:</b>The following Length Constraints relates to a
|
|
4893
|
+
* single ARN. Up to 25 package version ARNs are allowed.</p>
|
|
4683
4894
|
* @public
|
|
4684
4895
|
*/
|
|
4685
4896
|
destinationPackageVersions?: string[] | undefined;
|
|
@@ -4710,7 +4921,7 @@ export interface CreateJobResponse {
|
|
|
4710
4921
|
export interface CreateJobTemplateRequest {
|
|
4711
4922
|
/**
|
|
4712
4923
|
* <p>A unique identifier for the job template. We recommend using a UUID. Alpha-numeric
|
|
4713
|
-
*
|
|
4924
|
+
* characters, "-", and "_" are valid for use here.</p>
|
|
4714
4925
|
* @public
|
|
4715
4926
|
*/
|
|
4716
4927
|
jobTemplateId: string | undefined;
|
|
@@ -4720,15 +4931,19 @@ export interface CreateJobTemplateRequest {
|
|
|
4720
4931
|
*/
|
|
4721
4932
|
jobArn?: string | undefined;
|
|
4722
4933
|
/**
|
|
4723
|
-
* <p>An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL
|
|
4724
|
-
*
|
|
4934
|
+
* <p>An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL
|
|
4935
|
+
* and is required if you don't specify a value for <code>document</code>.</p>
|
|
4936
|
+
* <p>For example, <code>--document-source
|
|
4937
|
+
* https://s3.<i>region-code</i>.amazonaws.com/example-firmware/device-firmware.1.0</code>
|
|
4725
4938
|
* </p>
|
|
4726
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html">Methods for accessing a
|
|
4939
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html">Methods for accessing a
|
|
4940
|
+
* bucket</a>.</p>
|
|
4727
4941
|
* @public
|
|
4728
4942
|
*/
|
|
4729
4943
|
documentSource?: string | undefined;
|
|
4730
4944
|
/**
|
|
4731
|
-
* <p>The job document. Required if you don't specify a value for
|
|
4945
|
+
* <p>The job document. Required if you don't specify a value for
|
|
4946
|
+
* <code>documentSource</code>.</p>
|
|
4732
4947
|
* @public
|
|
4733
4948
|
*/
|
|
4734
4949
|
document?: string | undefined;
|
|
@@ -4753,10 +4968,10 @@ export interface CreateJobTemplateRequest {
|
|
|
4753
4968
|
*/
|
|
4754
4969
|
abortConfig?: AbortConfig | undefined;
|
|
4755
4970
|
/**
|
|
4756
|
-
* <p>Specifies the amount of time each device has to finish its execution of the job.
|
|
4757
|
-
*
|
|
4758
|
-
*
|
|
4759
|
-
*
|
|
4971
|
+
* <p>Specifies the amount of time each device has to finish its execution of the job. A
|
|
4972
|
+
* timer is started when the job execution status is set to <code>IN_PROGRESS</code>. If
|
|
4973
|
+
* the job execution status is not set to another terminal state before the timer expires,
|
|
4974
|
+
* it will be automatically set to <code>TIMED_OUT</code>.</p>
|
|
4760
4975
|
* @public
|
|
4761
4976
|
*/
|
|
4762
4977
|
timeoutConfig?: TimeoutConfig | undefined;
|
|
@@ -4771,16 +4986,18 @@ export interface CreateJobTemplateRequest {
|
|
|
4771
4986
|
*/
|
|
4772
4987
|
jobExecutionsRetryConfig?: JobExecutionsRetryConfig | undefined;
|
|
4773
4988
|
/**
|
|
4774
|
-
* <p>Allows you to configure an optional maintenance window for the rollout of a job
|
|
4989
|
+
* <p>Allows you to configure an optional maintenance window for the rollout of a job
|
|
4990
|
+
* document to all devices in the target group for a job.</p>
|
|
4775
4991
|
* @public
|
|
4776
4992
|
*/
|
|
4777
4993
|
maintenanceWindows?: MaintenanceWindow[] | undefined;
|
|
4778
4994
|
/**
|
|
4779
|
-
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the
|
|
4780
|
-
*
|
|
4995
|
+
* <p>The package version Amazon Resource Names (ARNs) that are installed on the device when the job
|
|
4996
|
+
* successfully completes. The package version must be in either the Published or
|
|
4997
|
+
* Deprecated state when the job deploys. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>
|
|
4781
4998
|
* <p>
|
|
4782
|
-
* <b>Note:</b>The following Length Constraints relates to a
|
|
4783
|
-
* Up to 25
|
|
4999
|
+
* <b>Note:</b>The following Length Constraints relates to a
|
|
5000
|
+
* single ARN. Up to 25 package version ARNs are allowed.</p>
|
|
4784
5001
|
* @public
|
|
4785
5002
|
*/
|
|
4786
5003
|
destinationPackageVersions?: string[] | undefined;
|
|
@@ -6701,127 +6918,6 @@ export interface VpcDestinationProperties {
|
|
|
6701
6918
|
*/
|
|
6702
6919
|
roleArn?: string | undefined;
|
|
6703
6920
|
}
|
|
6704
|
-
/**
|
|
6705
|
-
* <p>A topic rule destination.</p>
|
|
6706
|
-
* @public
|
|
6707
|
-
*/
|
|
6708
|
-
export interface TopicRuleDestination {
|
|
6709
|
-
/**
|
|
6710
|
-
* <p>The topic rule destination URL.</p>
|
|
6711
|
-
* @public
|
|
6712
|
-
*/
|
|
6713
|
-
arn?: string | undefined;
|
|
6714
|
-
/**
|
|
6715
|
-
* <p>The status of the topic rule destination. Valid values are:</p>
|
|
6716
|
-
* <dl>
|
|
6717
|
-
* <dt>IN_PROGRESS</dt>
|
|
6718
|
-
* <dd>
|
|
6719
|
-
* <p>A topic rule destination was created but has not been confirmed. You can set
|
|
6720
|
-
* <code>status</code> to <code>IN_PROGRESS</code> by calling
|
|
6721
|
-
* <code>UpdateTopicRuleDestination</code>. Calling
|
|
6722
|
-
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
|
|
6723
|
-
* be sent to your confirmation endpoint.</p>
|
|
6724
|
-
* </dd>
|
|
6725
|
-
* <dt>ENABLED</dt>
|
|
6726
|
-
* <dd>
|
|
6727
|
-
* <p>Confirmation was completed, and traffic to this destination is allowed. You can
|
|
6728
|
-
* set <code>status</code> to <code>DISABLED</code> by calling
|
|
6729
|
-
* <code>UpdateTopicRuleDestination</code>.</p>
|
|
6730
|
-
* </dd>
|
|
6731
|
-
* <dt>DISABLED</dt>
|
|
6732
|
-
* <dd>
|
|
6733
|
-
* <p>Confirmation was completed, and traffic to this destination is not allowed. You
|
|
6734
|
-
* can set <code>status</code> to <code>ENABLED</code> by calling
|
|
6735
|
-
* <code>UpdateTopicRuleDestination</code>.</p>
|
|
6736
|
-
* </dd>
|
|
6737
|
-
* <dt>ERROR</dt>
|
|
6738
|
-
* <dd>
|
|
6739
|
-
* <p>Confirmation could not be completed, for example if the confirmation timed out.
|
|
6740
|
-
* You can call <code>GetTopicRuleDestination</code> for details about the error. You
|
|
6741
|
-
* can set <code>status</code> to <code>IN_PROGRESS</code> by calling
|
|
6742
|
-
* <code>UpdateTopicRuleDestination</code>. Calling
|
|
6743
|
-
* <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to
|
|
6744
|
-
* be sent to your confirmation endpoint.</p>
|
|
6745
|
-
* </dd>
|
|
6746
|
-
* </dl>
|
|
6747
|
-
* @public
|
|
6748
|
-
*/
|
|
6749
|
-
status?: TopicRuleDestinationStatus | undefined;
|
|
6750
|
-
/**
|
|
6751
|
-
* <p>The date and time when the topic rule destination was created.</p>
|
|
6752
|
-
* @public
|
|
6753
|
-
*/
|
|
6754
|
-
createdAt?: Date | undefined;
|
|
6755
|
-
/**
|
|
6756
|
-
* <p>The date and time when the topic rule destination was last updated.</p>
|
|
6757
|
-
* @public
|
|
6758
|
-
*/
|
|
6759
|
-
lastUpdatedAt?: Date | undefined;
|
|
6760
|
-
/**
|
|
6761
|
-
* <p>Additional details or reason why the topic rule destination is in the current
|
|
6762
|
-
* status.</p>
|
|
6763
|
-
* @public
|
|
6764
|
-
*/
|
|
6765
|
-
statusReason?: string | undefined;
|
|
6766
|
-
/**
|
|
6767
|
-
* <p>Properties of the HTTP URL.</p>
|
|
6768
|
-
* @public
|
|
6769
|
-
*/
|
|
6770
|
-
httpUrlProperties?: HttpUrlDestinationProperties | undefined;
|
|
6771
|
-
/**
|
|
6772
|
-
* <p>Properties of the virtual private cloud (VPC) connection.</p>
|
|
6773
|
-
* @public
|
|
6774
|
-
*/
|
|
6775
|
-
vpcProperties?: VpcDestinationProperties | undefined;
|
|
6776
|
-
}
|
|
6777
|
-
/**
|
|
6778
|
-
* @public
|
|
6779
|
-
*/
|
|
6780
|
-
export interface CreateTopicRuleDestinationResponse {
|
|
6781
|
-
/**
|
|
6782
|
-
* <p>The topic rule destination.</p>
|
|
6783
|
-
* @public
|
|
6784
|
-
*/
|
|
6785
|
-
topicRuleDestination?: TopicRuleDestination | undefined;
|
|
6786
|
-
}
|
|
6787
|
-
/**
|
|
6788
|
-
* @public
|
|
6789
|
-
*/
|
|
6790
|
-
export interface DeleteAccountAuditConfigurationRequest {
|
|
6791
|
-
/**
|
|
6792
|
-
* <p>If true, all scheduled audits are deleted.</p>
|
|
6793
|
-
* @public
|
|
6794
|
-
*/
|
|
6795
|
-
deleteScheduledAudits?: boolean | undefined;
|
|
6796
|
-
}
|
|
6797
|
-
/**
|
|
6798
|
-
* @public
|
|
6799
|
-
*/
|
|
6800
|
-
export interface DeleteAccountAuditConfigurationResponse {
|
|
6801
|
-
}
|
|
6802
|
-
/**
|
|
6803
|
-
* @public
|
|
6804
|
-
*/
|
|
6805
|
-
export interface DeleteAuditSuppressionRequest {
|
|
6806
|
-
/**
|
|
6807
|
-
* <p>An audit check name. Checks must be enabled
|
|
6808
|
-
* for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list
|
|
6809
|
-
* of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code>
|
|
6810
|
-
* to select which checks are enabled.)</p>
|
|
6811
|
-
* @public
|
|
6812
|
-
*/
|
|
6813
|
-
checkName: string | undefined;
|
|
6814
|
-
/**
|
|
6815
|
-
* <p>Information that identifies the noncompliant resource.</p>
|
|
6816
|
-
* @public
|
|
6817
|
-
*/
|
|
6818
|
-
resourceIdentifier: ResourceIdentifier | undefined;
|
|
6819
|
-
}
|
|
6820
|
-
/**
|
|
6821
|
-
* @public
|
|
6822
|
-
*/
|
|
6823
|
-
export interface DeleteAuditSuppressionResponse {
|
|
6824
|
-
}
|
|
6825
6921
|
/**
|
|
6826
6922
|
* @internal
|
|
6827
6923
|
*/
|