Skip to content

Commit db3f2d7

Browse files
author
awstools
committed
docs(client-iot): Documentation update for China region ListMetricValues for IoT
1 parent 67fcba1 commit db3f2d7

File tree

3 files changed

+144
-13
lines changed

3 files changed

+144
-13
lines changed

clients/client-iot/src/models/models_0.ts

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4746,6 +4746,11 @@ export interface CreateJobRequest {
47464746
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
47474747
* when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
47484748
* target group, even after the job was completed by all things originally in the group.</p>
4749+
* <note>
4750+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
4751+
* By using continuous jobs, devices that join the group receive the job execution even after the job has
4752+
* been created.</p>
4753+
* </note>
47494754
*/
47504755
targetSelection?: TargetSelection | string;
47514756

@@ -4796,7 +4801,13 @@ export interface CreateJobRequest {
47964801
jobExecutionsRetryConfig?: JobExecutionsRetryConfig;
47974802

47984803
/**
4799-
* <p>Parameters of a managed template that you can specify to create the job document.</p>
4804+
* <p>Parameters of an Amazon Web Services managed template that you can specify to create the job document.</p>
4805+
* <note>
4806+
* <p>
4807+
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
4808+
* managed templates. This parameter can't be used with custom job templates or to
4809+
* create jobs from them.</p>
4810+
* </note>
48004811
*/
48014812
documentParameters?: { [key: string]: string };
48024813
}
@@ -5506,12 +5517,12 @@ export interface CustomCodeSigning {
55065517
certificateChain?: CodeSigningCertificateChain;
55075518

55085519
/**
5509-
* <p>The hash algorithm used to code sign the file.</p>
5520+
* <p>The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>SHA256</code> or <code>SHA1</code>, so you can pass either of them based on which was used for generating the signature.</p>
55105521
*/
55115522
hashAlgorithm?: string;
55125523

55135524
/**
5514-
* <p>The signature algorithm used to code sign the file.</p>
5525+
* <p>The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>ECDSA</code> or <code>RSA</code>, so you can pass either of them based on which was used for generating the signature.</p>
55155526
*/
55165527
signatureAlgorithm?: string;
55175528
}

clients/client-iot/src/models/models_1.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2078,6 +2078,11 @@ export interface Job {
20782078
* when a change is detected in a target. For example, a job will run on a device when the thing representing
20792079
* the device is added to a target group, even after the job was completed by all things originally in the
20802080
* group. </p>
2081+
* <note>
2082+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
2083+
* By using continuous jobs, devices that join the group receive the job execution even after the job has
2084+
* been created.</p>
2085+
* </note>
20812086
*/
20822087
targetSelection?: TargetSelection | string;
20832088

@@ -2183,6 +2188,12 @@ export interface Job {
21832188
* <p>A key-value map that pairs the patterns that need to be replaced in a managed
21842189
* template job document schema. You can use the description of each key as a guidance
21852190
* to specify the inputs during runtime when creating a job.</p>
2191+
* <note>
2192+
* <p>
2193+
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
2194+
* managed templates. This parameter can't be used with custom job templates or to
2195+
* create jobs from them.</p>
2196+
* </note>
21862197
*/
21872198
documentParameters?: { [key: string]: string };
21882199

@@ -2481,6 +2492,12 @@ export namespace DescribeManagedJobTemplateRequest {
24812492
* <p>A map of key-value pairs containing the patterns that need to be replaced in a managed
24822493
* template job document schema. You can use the description of each key as a guidance to specify
24832494
* the inputs during runtime when creating a job.</p>
2495+
* <note>
2496+
* <p>
2497+
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
2498+
* managed templates. This parameter can't be used with custom job templates or to
2499+
* create jobs from them.</p>
2500+
* </note>
24842501
*/
24852502
export interface DocumentParameter {
24862503
/**
@@ -2552,6 +2569,12 @@ export interface DescribeManagedJobTemplateResponse {
25522569
/**
25532570
* <p>A map of key-value pairs that you can use as guidance to specify the inputs for creating
25542571
* a job from a managed template.</p>
2572+
* <note>
2573+
* <p>
2574+
* <code>documentParameters</code> can only be used when creating jobs from Amazon Web Services
2575+
* managed templates. This parameter can't be used with custom job templates or to
2576+
* create jobs from them.</p>
2577+
* </note>
25552578
*/
25562579
documentParameters?: DocumentParameter[];
25572580

@@ -6611,6 +6634,11 @@ export interface ListJobsRequest {
66116634
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
66126635
* when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
66136636
* target group, even after the job was completed by all things originally in the group. </p>
6637+
* <note>
6638+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
6639+
* By using continuous jobs, devices that join the group receive the job execution even after the job has
6640+
* been created.</p>
6641+
* </note>
66146642
*/
66156643
targetSelection?: TargetSelection | string;
66166644

@@ -6681,6 +6709,11 @@ export interface JobSummary {
66816709
* specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing
66826710
* when a change is detected in a target. For example, a job will run on a thing when the thing is added to a
66836711
* target group, even after the job was completed by all things originally in the group.</p>
6712+
* <note>
6713+
* <p>We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets.
6714+
* By using continuous jobs, devices that join the group receive the job execution even after the job has
6715+
* been created.</p>
6716+
* </note>
66846717
*/
66856718
targetSelection?: TargetSelection | string;
66866719

0 commit comments

Comments
 (0)