@aws-sdk/client-iot 3.261.0 → 3.262.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/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +2 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +2 -0
- package/dist-types/IoT.d.ts +88 -94
- package/dist-types/IoTClient.d.ts +5 -5
- package/dist-types/commands/AddThingToBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/AddThingToThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +5 -5
- package/dist-types/commands/AttachThingPrincipalCommand.d.ts +1 -1
- package/dist-types/commands/CancelJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateCertificateFromCsrCommand.d.ts +0 -3
- package/dist-types/commands/CreateDynamicThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +1 -1
- package/dist-types/commands/CreateOTAUpdateCommand.d.ts +1 -1
- package/dist-types/commands/CreateStreamCommand.d.ts +1 -1
- package/dist-types/commands/CreateThingCommand.d.ts +4 -4
- package/dist-types/commands/CreateThingGroupCommand.d.ts +4 -4
- package/dist-types/commands/CreateThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOTAUpdateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteStreamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DeprecateThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeJobExecutionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStreamCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThingRegistrationTaskCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThingTypeCommand.d.ts +1 -1
- package/dist-types/commands/DetachThingPrincipalCommand.d.ts +4 -4
- package/dist-types/commands/GetJobDocumentCommand.d.ts +1 -1
- package/dist-types/commands/GetOTAUpdateCommand.d.ts +1 -1
- package/dist-types/commands/ListBillingGroupsCommand.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 -1
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListOTAUpdatesCommand.d.ts +1 -1
- package/dist-types/commands/ListPrincipalThingsCommand.d.ts +1 -1
- package/dist-types/commands/ListStreamsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListThingGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListThingGroupsForThingCommand.d.ts +1 -1
- package/dist-types/commands/ListThingPrincipalsCommand.d.ts +1 -1
- package/dist-types/commands/ListThingRegistrationTasksCommand.d.ts +1 -1
- package/dist-types/commands/ListThingTypesCommand.d.ts +1 -1
- package/dist-types/commands/ListThingsCommand.d.ts +4 -5
- package/dist-types/commands/ListThingsInBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/ListThingsInThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/RemoveThingFromBillingGroupCommand.d.ts +2 -2
- package/dist-types/commands/RemoveThingFromThingGroupCommand.d.ts +2 -2
- package/dist-types/commands/StartThingRegistrationTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopThingRegistrationTaskCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TransferCertificateCommand.d.ts +0 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBillingGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCertificateCommand.d.ts +0 -1
- package/dist-types/commands/UpdateDynamicThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEventConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateJobCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStreamCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThingCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThingGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThingGroupsForThingCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +51 -46
- package/dist-types/models/models_1.d.ts +27 -27
- package/dist-types/models/models_2.d.ts +18 -18
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +2 -2
|
@@ -362,21 +362,21 @@ export interface IoTClientResolvedConfig extends IoTClientResolvedConfigType {
|
|
|
362
362
|
}
|
|
363
363
|
/**
|
|
364
364
|
* <fullname>IoT</fullname>
|
|
365
|
-
*
|
|
365
|
+
* <p>IoT provides secure, bi-directional communication between Internet-connected
|
|
366
366
|
* devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services
|
|
367
367
|
* cloud. You can discover your custom IoT-Data endpoint to communicate with, configure
|
|
368
368
|
* rules for data processing and integration with other services, organize resources
|
|
369
369
|
* associated with each device (Registry), configure logging, and create and manage
|
|
370
370
|
* policies and credentials to authenticate devices.</p>
|
|
371
|
-
*
|
|
371
|
+
* <p>The service endpoints that expose this API are listed in
|
|
372
372
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>.
|
|
373
373
|
* You must use the endpoint for the region that has the resources you want to access.</p>
|
|
374
|
-
*
|
|
374
|
+
* <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
|
|
375
375
|
* Signature Version 4</a> to sign the request is:
|
|
376
376
|
* <i>execute-api</i>.</p>
|
|
377
|
-
*
|
|
377
|
+
* <p>For more information about how IoT works, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html">Developer
|
|
378
378
|
* Guide</a>.</p>
|
|
379
|
-
*
|
|
379
|
+
* <p>For information about how to use the credentials provider for IoT, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html">Authorizing Direct Calls to Amazon Web Services Services</a>.</p>
|
|
380
380
|
*/
|
|
381
381
|
export declare class IoTClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTClientResolvedConfig> {
|
|
382
382
|
/**
|
|
@@ -9,7 +9,7 @@ export interface AddThingToBillingGroupCommandOutput extends AddThingToBillingGr
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds a thing to a billing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AddThingToBillingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface AddThingToThingGroupCommandOutput extends AddThingToThingGroupR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds a thing to a thing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AddThingToThingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,19 +9,19 @@ export interface AssociateTargetsWithJobCommandOutput extends AssociateTargetsWi
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Associates a group with a continuous job. The following criteria must be met: </p>
|
|
12
|
-
*
|
|
12
|
+
* <ul>
|
|
13
13
|
* <li>
|
|
14
|
-
*
|
|
14
|
+
* <p>The job must have been created with the <code>targetSelection</code> field set to
|
|
15
15
|
* "CONTINUOUS".</p>
|
|
16
16
|
* </li>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>The job status must currently be "IN_PROGRESS".</p>
|
|
19
19
|
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
21
|
+
* <p>The total number of targets associated with a job must not exceed 100.</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* </ul>
|
|
24
|
-
*
|
|
24
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AssociateTargetsWithJob</a> action.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface AttachThingPrincipalCommandOutput extends AttachThingPrincipalR
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Attaches the specified principal to the specified thing. A principal can be X.509
|
|
12
12
|
* certificates, Amazon Cognito identities or federated identities.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AttachThingPrincipal</a> action.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Cancels a job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelJob</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateBillingGroupCommandOutput extends CreateBillingGroupRespo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a billing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateBillingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -19,16 +19,13 @@ export interface CreateCertificateFromCsrCommandOutput extends CreateCertificate
|
|
|
19
19
|
* <b>Note:</b> Reusing the same certificate signing request (CSR)
|
|
20
20
|
* results in a distinct certificate.</p>
|
|
21
21
|
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateCertificateFromCsr</a> action.</p>
|
|
22
|
-
*
|
|
23
22
|
* <p>You can create multiple certificates in a batch by creating a directory, copying
|
|
24
23
|
* multiple .csr files into that directory, and then specifying that directory on the command
|
|
25
24
|
* line. The following commands show how to create a batch of certificates given a batch of
|
|
26
25
|
* CSRs.</p>
|
|
27
26
|
* <p>Assuming a set of CSRs are located inside of the directory
|
|
28
27
|
* my-csr-directory:</p>
|
|
29
|
-
*
|
|
30
28
|
* <p>On Linux and OS X, the command is:</p>
|
|
31
|
-
*
|
|
32
29
|
* <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr
|
|
33
30
|
* --certificate-signing-request file://my-csr-directory/{}</p>
|
|
34
31
|
* <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name
|
|
@@ -9,7 +9,7 @@ export interface CreateDynamicThingGroupCommandOutput extends CreateDynamicThing
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a dynamic thing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateDynamicThingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateJob</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateJobTemplateCommandOutput extends CreateJobTemplateRespons
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a job template.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateJobTemplate</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateOTAUpdateCommandOutput extends CreateOTAUpdateResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an IoT OTA update on a target group of things or groups.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateOTAUpdate</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface CreateStreamCommandOutput extends CreateStreamResponse, __Metad
|
|
|
11
11
|
* <p>Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data
|
|
12
12
|
* bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files
|
|
13
13
|
* associated with a stream.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateStream</a> action.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -12,11 +12,11 @@ export interface CreateThingCommandOutput extends CreateThingResponse, __Metadat
|
|
|
12
12
|
* the same thing name and configuration, the call will succeed. If this call is made with
|
|
13
13
|
* the same thing name but different configuration a
|
|
14
14
|
* <code>ResourceAlreadyExistsException</code> is thrown.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>This is a control plane operation. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for
|
|
17
17
|
* information about authorizing control plane actions.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* </note>
|
|
19
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateThing</a> action.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -9,11 +9,11 @@ export interface CreateThingGroupCommandOutput extends CreateThingGroupResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Create a thing group.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>This is a control plane operation. See <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html">Authorization</a> for
|
|
14
14
|
* information about authorizing control plane actions.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* </note>
|
|
16
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateThingGroup</a> action.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface CreateThingTypeCommandOutput extends CreateThingTypeResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new thing type.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateThingType</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteBillingGroupCommandOutput extends DeleteBillingGroupRespo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the billing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteBillingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteDynamicThingGroupCommandOutput extends DeleteDynamicThing
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a dynamic thing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteDynamicThingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteOTAUpdateCommandOutput extends DeleteOTAUpdateResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Delete an OTA update.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteOTAUpdate</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteStreamCommandOutput extends DeleteStreamResponse, __Metad
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a stream.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteStream</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DeleteThingCommandOutput extends DeleteThingResponse, __Metadat
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified thing. Returns successfully with no error if the deletion is
|
|
12
12
|
* successful or you specify a thing that doesn't exist.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThing</a> action.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DeleteThingGroupCommandOutput extends DeleteThingGroupResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a thing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface DeleteThingTypeCommandOutput extends DeleteThingTypeResponse, _
|
|
|
11
11
|
* <p>Deletes the specified thing type. You cannot delete a thing type if it has things
|
|
12
12
|
* associated with it. To delete a thing type, first mark it as deprecated by calling <a>DeprecateThingType</a>, then remove any associated things by calling <a>UpdateThing</a> to change the thing type on any associated thing, and
|
|
13
13
|
* finally use <a>DeleteThingType</a> to delete the thing type.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingType</a> action.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DeprecateThingTypeCommandOutput extends DeprecateThingTypeRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deprecates a thing type. You can not associate new things with deprecated thing
|
|
12
12
|
* type.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeprecateThingType</a> action.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeBillingGroupCommandOutput extends DescribeBillingGroupR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns information about a billing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeBillingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeEventConfigurationsCommandOutput extends DescribeEventC
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes event configurations.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeEventConfigurations</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes a job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeJob</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes a job execution.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeJobExecution</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeStreamCommandOutput extends DescribeStreamResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about a stream.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeStream</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeThingCommandOutput extends DescribeThingResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about the specified thing.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeThing</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeThingGroupCommandOutput extends DescribeThingGroupRespo
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describe a thing group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeThingGroup</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeThingRegistrationTaskCommandOutput extends DescribeThin
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes a bulk thing provisioning task.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeThingRegistrationTask</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeThingTypeCommandOutput extends DescribeThingTypeRespons
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about the specified thing type.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeThingType</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,11 +11,11 @@ export interface DetachThingPrincipalCommandOutput extends DetachThingPrincipalR
|
|
|
11
11
|
* <p>Detaches the specified principal from the specified thing. A principal can be X.509
|
|
12
12
|
* certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
|
|
13
13
|
* identities.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>This call is asynchronous. It might take several seconds for the detachment to
|
|
16
16
|
* propagate.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* </note>
|
|
18
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DetachThingPrincipal</a> action.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface GetJobDocumentCommandOutput extends GetJobDocumentResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets a job document.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetJobDocument</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface GetOTAUpdateCommandOutput extends GetOTAUpdateResponse, __Metad
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets an OTA update.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetOTAUpdate</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListBillingGroupsCommandOutput extends ListBillingGroupsRespons
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the billing groups you have created.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListBillingGroups</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListJobExecutionsForJobCommandOutput extends ListJobExecutionsF
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the job executions for a job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListJobExecutionsForJob</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListJobExecutionsForThingCommandOutput extends ListJobExecution
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the job executions for the specified thing.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListJobExecutionsForThing</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListJobTemplatesCommandOutput extends ListJobTemplatesResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of job templates.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListJobTemplates</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists jobs.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListJobs</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListOTAUpdatesCommandOutput extends ListOTAUpdatesResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists OTA updates.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListOTAUpdates</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface ListPrincipalThingsCommandOutput extends ListPrincipalThingsRes
|
|
|
11
11
|
* <p>Lists the things associated with the specified principal. A principal can be X.509
|
|
12
12
|
* certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
|
|
13
13
|
* identities. </p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListPrincipalThings</a> action.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface ListStreamsCommandOutput extends ListStreamsResponse, __Metadat
|
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
12
|
* <p>Lists all of the streams in your Amazon Web Services account.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListStreams</a> action.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the tags (metadata) you have assigned to the resource.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTagsForResource</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListThingGroupsCommandOutput extends ListThingGroupsResponse, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>List the thing groups in your account.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingGroups</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListThingGroupsForThingCommandOutput extends ListThingGroupsFor
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>List the thing groups to which the specified thing belongs.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingGroupsForThing</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface ListThingPrincipalsCommandOutput extends ListThingPrincipalsRes
|
|
|
11
11
|
* <p>Lists the principals associated with the specified thing. A principal can be X.509
|
|
12
12
|
* certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
|
|
13
13
|
* identities.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingPrincipals</a> action.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface ListThingRegistrationTasksCommandOutput extends ListThingRegist
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>List bulk thing provisioning tasks.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListThingRegistrationTasks</a> action.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|