AWS IoT - API Reference - docs.aws.amazon.com

1 AWS IoTAPI ReferenceAWS IoT: API ReferenceCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights IoT API ReferenceAmazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored IoT API ReferenceTable of ContentsWelcome .. 1 AWS IoT .. 1 AWS IoT Data Plane .. 1 AWS IoT Jobs Data Plane .. 1 Actions .. 2 AWS IoT .. 6 AcceptCertificateTransfer .. 10 AddThingToBillingGroup .. 12 AddThingToThingGroup .. 14 AssociateTargetsWithJob .. 17 AttachPolicy .. 20 AttachPrincipalPolicy .. 22 AttachSecurityProfile.

2 24 AttachThingPrincipal .. 26 CancelAuditTask .. 28 CancelCertificateTransfer .. 30 CancelJob .. 32 CancelJobExecution .. 35 ClearDefaultAuthorizer .. 38 CreateAuthorizer .. 40 CreateBillingGroup .. 43 CreateCertificateFromCsr .. 46 CreateDynamicThingGroup .. 49 CreateJob .. 53 CreateKeysAndCertificate .. 58 CreateOTAU pdate .. 61 CreatePolicy .. 66 CreatePolicyVersion .. 69 CreateRoleAlias .. 72 CreateScheduledAudit .. 75 CreateSecurityProfile .. 78 CreateStream .. 81 CreateThing .. 85 CreateThingGroup .. 88 CreateThingType .. 91 CreateTopicRule .. 94 DeleteAccountAuditConfiguration .. 99 DeleteAuthorizer .. 101 DeleteBillingGroup .. 103 DeleteCACertificate .. 105 DeleteCertificate .. 107 DeleteDynamicThingGroup .. 111 DeleteJobExecution .. 113 DeleteOTAU pdate .. 115 DeletePolicy .. 117 DeletePolicyVersion .. 119 DeleteRegistrationCode.

3 121 DeleteRoleAlias .. 125 DeleteSecurityProfile .. 127 DeleteStream .. 131 DeleteThingGroup .. 133iiiAWS IoT API ReferenceDeleteThingType .. 135 DeleteTopicRule .. 137 DeleteV2 LoggingLevel .. 139 DeprecateThingType .. 141 DescribeAccountAuditConfiguration .. 143 DescribeAuditTask .. 145 DescribeAuthorizer .. 148 DescribeBillingGroup .. 150 DescribeCACertificate .. 153 DescribeCertificate .. 156 DescribeDefaultAuthorizer .. 161 DescribeEventConfigurations .. 168 DescribeJobExecution .. 171 DescribeRoleAlias .. 175 DescribeSecurityProfile .. 178 DescribeStream .. 183 DescribeThingGroup .. 186 DescribeThingRegistrationTask .. 189 DescribeThingType .. 192 DetachPolicy .. 195 DetachPrincipalPolicy .. 197 DetachSecurityProfile .. 201 DisableTopicRule .. 203 EnableTopicRule .. 205 GetEffectivePolicies .. 214 GetOTAU pdate.

4 216 GetPolicy .. 219 GetPolicyVersion .. 222 GetRegistrationCode .. 225 GetTopicRule .. 232 ListActiveViolations .. 234 ListAttachedPolicies .. 240 ListAuditTasks .. 244 ListAuthorizers .. 247 ListBillingGroups .. 250 ListCACertificates .. 252 ListCertificates .. 255 ListCertificatesByCA .. 258 ListIndices .. 261 ListJobExecutionsForJob .. 263 ListJobExecutionsForThing .. 269 ListOTAU pdates .. 272 ListOutgoingCertificates .. 274 ListPolicies .. 277 ListPolicyPrincipals .. 279ivAWS IoT API ReferenceListPolicyVersions .. 282 ListPrincipalPolicies .. 287 ListRoleAliases .. 291 ListSecurityProfiles .. 293 ListSecurityProfilesForTarget .. 295 ListStreams .. 297 ListTagsForResource .. 299 ListTargetsForPolicy .. 301 ListTargetsForSecurityProfile .. 304 ListThingGroups .. 306 ListThingGroupsForThing .. 310 ListThingRegistrationTaskReports.

5 312 ListThingRegistrationTasks .. 317 ListThingsInBillingGroup .. 320 ListThingsInThingGroup .. 322 ListThingTypes .. 324 ListTopicRules .. 327 ListV2 LoggingLevels .. 329 ListViolationEvents .. 331 RegisterCACertificate .. 334 RegisterCertificate .. 337 RegisterThing .. 340 RejectCertificateTransfer .. 343 RemoveThingFromBillingGroup .. 345 RemoveThingFromThingGroup .. 347 ReplaceTopicRule .. 349 SearchIndex .. 354 SetDefaultAuthorizer .. 358 SetDefaultPolicyVersion .. 363 SetV2 LoggingLevel .. 367 StartOnDemandAuditTask .. 369 StartThingRegistrationTask .. 371 StopThingRegistrationTask .. 374 TagResource .. 376 TestAuthorization .. 378 TestInvokeAuthorizer .. 382 TransferCertificate .. 385 UntagResource .. 388 UpdateAccountAuditConfiguration .. 390 UpdateAuthorizer .. 393 UpdateBillingGroup .. 396 UpdateCACertificate.

6 399 UpdateCertificate .. 402 UpdateDynamicThingGroup .. 404 UpdateEventConfigurations .. 411 UpdateRoleAlias .. 417 UpdateSecurityProfile .. 420 UpdateStream .. 424vAWS IoT API 427 UpdateThingGroup .. 430 UpdateThingGroupsForThing .. 433 ValidateSecurityProfileBehaviors .. 436 AWS IoT Data Plane .. 438 DeleteThingShadow .. 439 GetThingShadow .. 443 UpdateThingShadow .. 445 AWS IoT Jobs Data Plane .. 447 DescribeJobExecution .. 448 GetPendingJobExecutions .. 451 StartNextPendingJobExecution .. 454 UpdateJobExecution .. 457 Data Types .. 461 AWS IoT .. 463 AbortConfig .. 467 AbortCriteria .. 468 Action .. 469 ActiveViolation .. 472 AlertTarget .. 474 Allowed .. 475 AttributePayload .. 480 AuditNotificationTarget .. 482 AuditTaskMetadata .. 484 AuthorizerDescription .. 485 AuthorizerSummary .. 487 AuthResult.

7 488 AwsJobExecutionsRolloutConfig .. 489 Behavior .. 490 BehaviorCriteria .. 491 BillingGroupMetadata .. 492 BillingGroupProperties .. 493 CACertificate .. 494 CACertificateDescription .. 495 Certificate .. 497 CertificateDescription .. 498 CertificateValidity .. 501 CloudwatchAlarmAction .. 502 CloudwatchMetricAction .. 505 CodeSigningCertificateChain .. 506 CodeSigningSignature .. 511 DynamoDBAction .. 512 DynamoDBv2 Action .. 514 EffectivePolicy .. 515 ElasticsearchAction .. 516 ErrorInfo .. 517 ExplicitDeny .. 518viAWS IoT API ReferenceExponentialRolloutRate .. 520 FirehoseAction .. 521 GroupNameAndArn .. 522 ImplicitDeny .. 523 IotAnalyticsAction .. 524 Job .. 525 JobExecution .. 528 JobExecutionsRolloutConfig .. 530 JobExecutionStatusDetails .. 531 JobExecutionSummary .. 532 JobExecutionSummaryForJob .. 534 JobExecutionSummaryForThing.

8 535 JobProcessDetails .. 536 JobSummary .. 538 KeyPair .. 540 KinesisAction .. 541 LambdaAction .. 542 LoggingOptionsPayload .. 543 LogTarget .. 544 LogTargetConfiguration .. 545 MetricValue .. 546 NonCompliantResource .. 547 OTAU pdateFile .. 548 OTAU pdateInfo .. 549 OTAU pdateSummary .. 552 OutgoingCertificate .. 553 Policy .. 555 PolicyVersion .. 556 PolicyVersionIdentifier .. 557 PresignedUrlConfig .. 559 RateIncreaseCriteria .. 560 RegistrationConfig .. 561 RelatedResource .. 562 RepublishAction .. 563 ResourceIdentifier .. 564 RoleAliasDescription .. 566S3 Action .. 570 SalesforceAction .. 572 SecurityProfileIdentifier .. 574 SecurityProfileTarget .. 575 SecurityProfileTargetMapping .. 576 SigningProfileParameter .. 577 SnsAction .. 578 SqsAction .. 579 StartSigningJobParameter .. 580 StepFunctionsAction .. 581 Stream.

9 582 StreamFile .. 583 StreamInfo .. 584 StreamSummary .. 586 Tag .. 587 TaskStatistics .. 588viiAWS IoT API ReferenceThingAttribute .. 590 ThingConnectivity .. 593 ThingGroupDocument .. 595 ThingGroupIndexingConfiguration .. 597 ThingGroupMetadata .. 598 ThingGroupProperties .. 600 ThingTypeDefinition .. 601 ThingTypeMetadata .. 602 ThingTypeProperties .. 604 TopicRule .. 605 TopicRuleListItem .. 607 TopicRulePayload .. 608 TransferData .. 610 ValidationError .. 611 ViolationEvent .. 612 AWS IoT Data Plane .. 613 AWS IoT Jobs Data Plane .. 613 JobExecution .. 614 JobExecutionState .. 617 JobExecutionSummary .. 618 Common Parameters .. 620viiiAWS IoT API ReferenceAWS IoTWelcomeAWS IoTAWS IoT provides secure, bi-directional communication between Internet-connected devices (such assensors, actuators, embedded devices, or smart appliances) and the AWS cloud.

10 You can discover yourcustom IoT-Data endpoint to communicate with, configure rules for data processing and integration withother services, organize resources associated with each device (Registry), configure logging, and createand manage policies and credentials to authenticate more information about how AWS IoT works, see the Developer information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls toAWS IoT Data PlaneAWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such assensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a brokerfor applications and things to publish messages over HTTP (Publish) and retrieve, update, and deleteshadows. A shadow is a persistent representation of your things and their state in the AWS IoT Jobs Data PlaneAWS IoT Jobs is a service that allows you to define a set of jobs remote operations that are sent to andexecuted on one or more devices connected to AWS IoT.