Table Of Content

AWS IoT API Reference AWS IoT API Reference AWS IoT: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS IoT API Reference Table of Contents Welcome........................................................................................................................................... 1 AWS IoT.................................................................................................................................... 1 AWS IoT data............................................................................................................................ 1 AWS IoT jobs data ...................................................................................................................... 1 AWS IoT Core Device Advisor ....................................................................................................... 2 AWS IoT Fleet Hub..................................................................................................................... 2 AWS IoT Secure Tunneling .......................................................................................................... 2 Actions............................................................................................................................................. 3 AWS IoT.................................................................................................................................... 9 AcceptCertificateTransfer................................................................................................... 15 AddThingToBillingGroup.................................................................................................... 17 AddThingToThingGroup..................................................................................................... 20 AssociateTargetsWithJob................................................................................................... 23 AttachPolicy.................................................................................................................... 26 AttachPrincipalPolicy........................................................................................................ 28 AttachSecurityProfile........................................................................................................ 30 AttachThingPrincipal ......................................................................................................... 32 CancelAuditMitigationActionsTask....................................................................................... 34 CancelAuditTask............................................................................................................... 36 CancelCertificateTransfer................................................................................................... 38 CancelDetectMitigationActionsTask..................................................................................... 40 CancelJob........................................................................................................................ 42 CancelJobExecution.......................................................................................................... 45 ClearDefaultAuthorizer...................................................................................................... 48 ConfirmTopicRuleDestination............................................................................................. 50 CreateAuditSuppression..................................................................................................... 52 CreateAuthorizer.............................................................................................................. 55 CreateBillingGroup............................................................................................................ 59 CreateCertificateFromCsr................................................................................................... 62 CreateCustomMetric.......................................................................................................... 65 CreateDimension.............................................................................................................. 68 CreateDomainConfiguration............................................................................................... 71 CreateDynamicThingGroup................................................................................................ 75 CreateFleetMetric............................................................................................................. 79 CreateJob........................................................................................................................ 84 CreateJobTemplate........................................................................................................... 90 CreateKeysAndCertificate................................................................................................... 95 CreateMitigationAction...................................................................................................... 98 CreateOTAUpdate........................................................................................................... 101 CreatePolicy................................................................................................................... 107 CreatePolicyVersion......................................................................................................... 110 CreateProvisioningClaim.................................................................................................. 113 CreateProvisioningTemplate............................................................................................. 116 CreateProvisioningTemplateVersion................................................................................... 120 CreateRoleAlias.............................................................................................................. 123 CreateScheduledAudit..................................................................................................... 126 CreateSecurityProfile....................................................................................................... 129 CreateStream................................................................................................................. 133 CreateThing................................................................................................................... 137 CreateThingGroup........................................................................................................... 140 CreateThingType............................................................................................................. 143 CreateTopicRule.............................................................................................................. 146 CreateTopicRuleDestination.............................................................................................. 155 DeleteAccountAuditConfiguration..................................................................................... 158 iii AWS IoT API Reference DeleteAuditSuppression................................................................................................... 160 DeleteAuthorizer............................................................................................................ 162 DeleteBillingGroup.......................................................................................................... 164 DeleteCACertificate......................................................................................................... 166 DeleteCertificate............................................................................................................. 168 DeleteCustomMetric........................................................................................................ 170 DeleteDimension............................................................................................................ 172 DeleteDomainConfiguration............................................................................................. 174 DeleteDynamicThingGroup............................................................................................... 176 DeleteFleetMetric........................................................................................................... 178 DeleteJob...................................................................................................................... 180 DeleteJobExecution......................................................................................................... 183 DeleteJobTemplate......................................................................................................... 186 DeleteMitigationAction.................................................................................................... 188 DeleteOTAUpdate........................................................................................................... 190 DeletePolicy................................................................................................................... 192 DeletePolicyVersion......................................................................................................... 194 DeleteProvisioningTemplate............................................................................................. 196 DeleteProvisioningTemplateVersion................................................................................... 198 DeleteRegistrationCode................................................................................................... 200 DeleteRoleAlias.............................................................................................................. 202 DeleteScheduledAudit..................................................................................................... 204 DeleteSecurityProfile....................................................................................................... 206 DeleteStream................................................................................................................. 208 DeleteThing................................................................................................................... 210 DeleteThingGroup........................................................................................................... 212 DeleteThingType............................................................................................................. 214 DeleteTopicRule.............................................................................................................. 216 DeleteTopicRuleDestination.............................................................................................. 218 DeleteV2LoggingLevel ..................................................................................................... 220 DeprecateThingType....................................................................................................... 222 DescribeAccountAuditConfiguration.................................................................................. 224 DescribeAuditFinding...................................................................................................... 226 DescribeAuditMitigationActionsTask.................................................................................. 229 DescribeAuditSuppression................................................................................................ 233 DescribeAuditTask........................................................................................................... 236 DescribeAuthorizer.......................................................................................................... 239 DescribeBillingGroup....................................................................................................... 241 DescribeCACertificate...................................................................................................... 244 DescribeCertificate.......................................................................................................... 247 DescribeCustomMetric..................................................................................................... 250 DescribeDefaultAuthorizer............................................................................................... 253 DescribeDetectMitigationActionsTask................................................................................ 255 DescribeDimension.......................................................................................................... 258 DescribeDomainConfiguration.......................................................................................... 261 DescribeEndpoint............................................................................................................ 264 DescribeEventConfigurations............................................................................................ 266 DescribeFleetMetric......................................................................................................... 268 DescribeIndex................................................................................................................. 272 DescribeJob................................................................................................................... 275 DescribeJobExecution...................................................................................................... 278 DescribeJobTemplate...................................................................................................... 281 DescribeManagedJobTemplate......................................................................................... 285 DescribeMitigationAction................................................................................................. 288 DescribeProvisioningTemplate.......................................................................................... 291 DescribeProvisioningTemplateVersion................................................................................ 295 DescribeRoleAlias............................................................................................................ 298 iv AWS IoT API Reference DescribeScheduledAudit.................................................................................................. 300 DescribeSecurityProfile.................................................................................................... 303 DescribeStream.............................................................................................................. 307 DescribeThing................................................................................................................ 310 DescribeThingGroup........................................................................................................ 313 DescribeThingRegistrationTask......................................................................................... 317 DescribeThingType.......................................................................................................... 321 DetachPolicy.................................................................................................................. 324 DetachPrincipalPolicy...................................................................................................... 326 DetachSecurityProfile...................................................................................................... 328 DetachThingPrincipal...................................................................................................... 330 DisableTopicRule............................................................................................................ 332 EnableTopicRule............................................................................................................. 334 GetBehaviorModelTrainingSummaries................................................................................ 336 GetBucketsAggregation................................................................................................... 338 GetCardinality................................................................................................................ 342 GetEffectivePolicies......................................................................................................... 345 GetIndexingConfiguration................................................................................................ 348 GetJobDocument............................................................................................................ 351 GetLoggingOptions......................................................................................................... 353 GetOTAUpdate............................................................................................................... 355 GetPercentiles................................................................................................................ 359 GetPolicy....................................................................................................................... 362 GetPolicyVersion............................................................................................................. 365 GetRegistrationCode....................................................................................................... 368 GetStatistics................................................................................................................... 370 GetTopicRule.................................................................................................................. 373 GetTopicRuleDestination.................................................................................................. 381 GetV2LoggingOptions..................................................................................................... 383 ListActiveViolations......................................................................................................... 385 ListAttachedPolicies........................................................................................................ 388 ListAuditFindings............................................................................................................ 391 ListAuditMitigationActionsExecutions................................................................................ 395 ListAuditMitigationActionsTasks........................................................................................ 398 ListAuditSuppressions...................................................................................................... 401 ListAuditTasks................................................................................................................ 404 ListAuthorizers............................................................................................................... 407 ListBillingGroups............................................................................................................. 410 ListCACertificates............................................................................................................ 412 ListCertificates............................................................................................................... 415 ListCertificatesByCA........................................................................................................ 418 ListCustomMetrics........................................................................................................... 421 ListDetectMitigationActionsExecutions............................................................................... 423 ListDetectMitigationActionsTasks...................................................................................... 426 ListDimensions............................................................................................................... 429 ListDomainConfigurations................................................................................................ 431 ListFleetMetrics.............................................................................................................. 434 ListIndices...................................................................................................................... 436 ListJobExecutionsForJob.................................................................................................. 438 ListJobExecutionsForThing ............................................................................................... 441 ListJobs......................................................................................................................... 444 ListJobTemplates............................................................................................................ 447 ListManagedJobTemplates............................................................................................... 449 ListMetricValues............................................................................................................. 451 ListMitigationActions....................................................................................................... 454 ListOTAUpdates.............................................................................................................. 456 ListOutgoingCertificates.................................................................................................. 459 v AWS IoT API Reference ListPolicies..................................................................................................................... 462 ListPolicyPrincipals.......................................................................................................... 465 ListPolicyVersions........................................................................................................... 468 ListPrincipalPolicies......................................................................................................... 470 ListPrincipalThings.......................................................................................................... 473 ListProvisioningTemplates................................................................................................ 476 ListProvisioningTemplateVersions..................................................................................... 478 ListRelatedResourcesForAuditFinding................................................................................. 481 ListRoleAliases................................................................................................................ 484 ListScheduledAudits........................................................................................................ 487 ListSecurityProfiles.......................................................................................................... 489 ListSecurityProfilesForTarget............................................................................................ 492 ListStreams.................................................................................................................... 495 ListTagsForResource........................................................................................................ 497 ListTargetsForPolicy........................................................................................................ 499 ListTargetsForSecurityProfile............................................................................................ 502 ListThingGroups............................................................................................................. 504 ListThingGroupsForThing ................................................................................................. 507 ListThingPrincipals.......................................................................................................... 509 ListThingRegistrationTaskReports...................................................................................... 512 ListThingRegistrationTasks............................................................................................... 515 ListThings...................................................................................................................... 517 ListThingsInBillingGroup.................................................................................................. 520 ListThingsInThingGroup................................................................................................... 522 ListThingTypes............................................................................................................... 524 ListTopicRuleDestinations................................................................................................ 527 ListTopicRules................................................................................................................ 529 ListV2LoggingLevels........................................................................................................ 531 ListViolationEvents......................................................................................................... 533 PutVerificationStateOnViolation....................................................................................... 537 RegisterCACertificate....................................................................................................... 539 RegisterCertificate.......................................................................................................... 543 RegisterCertificateWithoutCA........................................................................................... 546 RegisterThing................................................................................................................. 549 RejectCertificateTransfer.................................................................................................. 552 RemoveThingFromBillingGroup......................................................................................... 555 RemoveThingFromThingGroup......................................................................................... 558 ReplaceTopicRule............................................................................................................ 561 SearchIndex................................................................................................................... 569 SetDefaultAuthorizer....................................................................................................... 573 SetDefaultPolicyVersion................................................................................................... 576 SetLoggingOptions......................................................................................................... 578 SetV2LoggingLevel......................................................................................................... 580 SetV2LoggingOptions..................................................................................................... 582 StartAuditMitigationActionsTask....................................................................................... 584 StartDetectMitigationActionsTask..................................................................................... 587 StartOnDemandAuditTask................................................................................................ 590 StartThingRegistrationTask.............................................................................................. 592 StopThingRegistrationTask............................................................................................... 595 TagResource................................................................................................................... 597 TestAuthorization........................................................................................................... 599 TestInvokeAuthorizer....................................................................................................... 603 TransferCertificate.......................................................................................................... 607 UntagResource............................................................................................................... 610 UpdateAccountAuditConfiguration.................................................................................... 612 UpdateAuditSuppression.................................................................................................. 615 UpdateAuthorizer........................................................................................................... 618 vi AWS IoT API Reference UpdateBillingGroup......................................................................................................... 622 UpdateCACertificate........................................................................................................ 625 UpdateCertificate............................................................................................................ 628 UpdateCustomMetric....................................................................................................... 631 UpdateDimension........................................................................................................... 634 UpdateDomainConfiguration............................................................................................ 637 UpdateDynamicThingGroup............................................................................................. 640 UpdateEventConfigurations.............................................................................................. 643 UpdateFleetMetric.......................................................................................................... 645 UpdateIndexingConfiguration........................................................................................... 649 UpdateJob..................................................................................................................... 652 UpdateMitigationAction................................................................................................... 656 UpdateProvisioningTemplate............................................................................................ 659 UpdateRoleAlias............................................................................................................. 662 UpdateScheduledAudit.................................................................................................... 665 UpdateSecurityProfile...................................................................................................... 668 UpdateStream................................................................................................................ 674 UpdateThing.................................................................................................................. 677 UpdateThingGroup......................................................................................................... 680 UpdateThingGroupsForThing............................................................................................ 683 UpdateTopicRuleDestination............................................................................................ 686 ValidateSecurityProfileBehaviors....................................................................................... 689 AWS IoT data ......................................................................................................................... 691 DeleteThingShadow........................................................................................................ 692 GetRetainedMessage....................................................................................................... 695 GetThingShadow............................................................................................................ 698 ListNamedShadowsForThing ............................................................................................ 701 ListRetainedMessages...................................................................................................... 704 Publish.......................................................................................................................... 707 UpdateThingShadow....................................................................................................... 710 AWS IoT jobs data .................................................................................................................. 712 DescribeJobExecution...................................................................................................... 713 GetPendingJobExecutions................................................................................................ 716 StartNextPendingJobExecution......................................................................................... 719 UpdateJobExecution....................................................................................................... 722 AWS IoT Core Device Advisor ................................................................................................... 725 CreateSuiteDefinition...................................................................................................... 727 DeleteSuiteDefinition...................................................................................................... 730 GetEndpoint................................................................................................................... 732 GetSuiteDefinition.......................................................................................................... 734 GetSuiteRun................................................................................................................... 737 GetSuiteRunReport......................................................................................................... 741 ListSuiteDefinitions......................................................................................................... 743 ListSuiteRuns................................................................................................................. 745 ListTagsForResource........................................................................................................ 748 StartSuiteRun................................................................................................................. 750 StopSuiteRun................................................................................................................. 753 TagResource................................................................................................................... 755 UntagResource............................................................................................................... 757 UpdateSuiteDefinition..................................................................................................... 759 AWS IoT Fleet Hub ................................................................................................................. 761 CreateApplication........................................................................................................... 762 DeleteApplication........................................................................................................... 765 DescribeApplication........................................................................................................ 767 ListApplications.............................................................................................................. 771 ListTagsForResource........................................................................................................ 773 TagResource................................................................................................................... 775 vii AWS IoT API Reference UntagResource............................................................................................................... 777 UpdateApplication.......................................................................................................... 779 AWS IoT Secure Tunneling ....................................................................................................... 781 CloseTunnel................................................................................................................... 782 DescribeTunnel ............................................................................................................... 784 ListTagsForResource........................................................................................................ 786 ListTunnels.................................................................................................................... 788 OpenTunnel................................................................................................................... 790 RotateTunnelAccessToken................................................................................................ 793 TagResource................................................................................................................... 796 UntagResource............................................................................................................... 798 Data Types.................................................................................................................................... 800 AWS IoT................................................................................................................................ 805 AbortConfig................................................................................................................... 810 AbortCriteria.................................................................................................................. 811 Action........................................................................................................................... 813 ActiveViolation............................................................................................................... 817 AddThingsToThingGroupParams....................................................................................... 819 AggregationType............................................................................................................ 820 AlertTarget.................................................................................................................... 821 Allowed......................................................................................................................... 822 AssetPropertyTimestamp................................................................................................. 823 AssetPropertyValue......................................................................................................... 824 AssetPropertyVariant....................................................................................................... 825 AttributePayload............................................................................................................ 826 AuditCheckConfiguration................................................................................................. 827 AuditCheckDetails........................................................................................................... 828 AuditFinding.................................................................................................................. 830 AuditMitigationActionExecutionMetadata........................................................................... 832 AuditMitigationActionsTaskMetadata................................................................................. 834 AuditMitigationActionsTaskTarget..................................................................................... 835 AuditNotificationTarget................................................................................................... 836 AuditSuppression............................................................................................................ 837 AuditTaskMetadata......................................................................................................... 839 AuthInfo........................................................................................................................ 840 AuthorizerConfig ............................................................................................................ 841 AuthorizerDescription...................................................................................................... 842 AuthorizerSummary........................................................................................................ 844 AuthResult..................................................................................................................... 845 AwsJobAbortConfig ......................................................................................................... 846 AwsJobAbortCriteria........................................................................................................ 847 AwsJobExecutionsRolloutConfig........................................................................................ 849 AwsJobExponentialRolloutRate......................................................................................... 850 AwsJobPresignedUrlConfig............................................................................................... 851 AwsJobRateIncreaseCriteria.............................................................................................. 852 AwsJobTimeoutConfig..................................................................................................... 853 Behavior........................................................................................................................ 854 BehaviorCriteria.............................................................................................................. 856 BehaviorModelTrainingSummary....................................................................................... 858 BillingGroupMetadata...................................................................................................... 860 BillingGroupProperties.................................................................................................... 861 Bucket........................................................................................................................... 862 BucketsAggregationType.................................................................................................. 863 CACertificate.................................................................................................................. 864 CACertificateDescription.................................................................................................. 865 Certificate...................................................................................................................... 868 CertificateDescription...................................................................................................... 870 viii AWS IoT API Reference CertificateValidity........................................................................................................... 873 CloudwatchAlarmAction.................................................................................................. 874 CloudwatchLogsAction.................................................................................................... 875 CloudwatchMetricAction.................................................................................................. 876 CodeSigning................................................................................................................... 878 CodeSigningCertificateChain............................................................................................ 879 CodeSigningSignature..................................................................................................... 880 Configuration................................................................................................................. 881 CustomCodeSigning........................................................................................................ 882 Denied.......................................................................................................................... 883 Destination.................................................................................................................... 884 DetectMitigationActionExecution...................................................................................... 885 DetectMitigationActionsTaskStatistics................................................................................ 887 DetectMitigationActionsTaskSummary............................................................................... 888 DetectMitigationActionsTaskTarget................................................................................... 890 DocumentParameter....................................................................................................... 891 DomainConfigurationSummary......................................................................................... 893 DynamoDBAction............................................................................................................ 894 DynamoDBv2Action........................................................................................................ 896 EffectivePolicy................................................................................................................ 897 ElasticsearchAction......................................................................................................... 898 EnableIoTLoggingParams................................................................................................. 900 ErrorInfo........................................................................................................................ 901 ExplicitDeny................................................................................................................... 902 ExponentialRolloutRate................................................................................................... 903 Field............................................................................................................................. 904 FileLocation................................................................................................................... 905 FirehoseAction................................................................................................................ 906 FleetMetricNameAndArn.................................................................................................. 907 GroupNameAndArn......................................................................................................... 908 HttpAction..................................................................................................................... 909 HttpActionHeader........................................................................................................... 911 HttpAuthorization........................................................................................................... 912 HttpContext................................................................................................................... 913 HttpUrlDestinationConfiguration...................................................................................... 914 HttpUrlDestinationProperties........................................................................................... 915 HttpUrlDestinationSummary............................................................................................ 916 ImplicitDeny................................................................................................................... 917 IndexingFilter................................................................................................................. 918 IotAnalyticsAction........................................................................................................... 919 IotEventsAction.............................................................................................................. 920 IotSiteWiseAction........................................................................................................... 922 IssuerCertificateIdentifier................................................................................................. 923 Job............................................................................................................................... 924 JobExecution.................................................................................................................. 929 JobExecutionsRetryConfig................................................................................................ 931 JobExecutionsRolloutConfig............................................................................................. 932 JobExecutionStatusDetails............................................................................................... 933 JobExecutionSummary.................................................................................................... 934 JobExecutionSummaryForJob........................................................................................... 936 JobExecutionSummaryForThing ........................................................................................ 937 JobProcessDetails........................................................................................................... 938 JobSummary.................................................................................................................. 940 JobTemplateSummary..................................................................................................... 942 KafkaAction................................................................................................................... 944 KeyPair.......................................................................................................................... 945 KinesisAction.................................................................................................................. 946 ix AWS IoT API Reference LambdaAction................................................................................................................ 947 LocationAction............................................................................................................... 948 LocationTimestamp......................................................................................................... 950 LoggingOptionsPayload................................................................................................... 951 LogTarget...................................................................................................................... 952 LogTargetConfiguration................................................................................................... 953 MachineLearningDetectionConfig ...................................................................................... 954 ManagedJobTemplateSummary........................................................................................ 955 MetricDatum.................................................................................................................. 957 MetricDimension............................................................................................................. 958 MetricToRetain............................................................................................................... 959 MetricValue.................................................................................................................... 960 MitigationAction............................................................................................................. 962 MitigationActionIdentifier................................................................................................ 963 MitigationActionParams................................................................................................... 964 MqttContext.................................................................................................................. 966 MqttHeaders.................................................................................................................. 967 NonCompliantResource................................................................................................... 969 OpenSearchAction.......................................................................................................... 970 OTAUpdateFile............................................................................................................... 971 OTAUpdateInfo............................................................................................................... 973 OTAUpdateSummary....................................................................................................... 976 OutgoingCertificate........................................................................................................ 977 PercentPair.................................................................................................................... 979 Policy............................................................................................................................ 980 PolicyVersion.................................................................................................................. 981 PolicyVersionIdentifier..................................................................................................... 982 PresignedUrlConfig......................................................................................................... 983 ProvisioningHook............................................................................................................ 984 ProvisioningTemplateSummary......................................................................................... 985 ProvisioningTemplateVersionSummary.............................................................................. 987 PublishFindingToSnsParams............................................................................................. 988 PutAssetPropertyValueEntry............................................................................................ 989 PutItemInput.................................................................................................................. 991 RateIncreaseCriteria........................................................................................................ 992 RegistrationConfig .......................................................................................................... 993 RelatedResource............................................................................................................. 994 ReplaceDefaultPolicyVersionParams.................................................................................. 995 RepublishAction.............................................................................................................. 996 ResourceIdentifier........................................................................................................... 997 RetryCriteria................................................................................................................... 999 RoleAliasDescription...................................................................................................... 1000 S3Action...................................................................................................................... 1002 S3Destination............................................................................................................... 1003 S3Location................................................................................................................... 1004 SalesforceAction........................................................................................................... 1005 ScheduledAuditMetadata............................................................................................... 1006 SchedulingConfig.......................................................................................................... 1008 SecurityProfileIdentifier................................................................................................. 1009 SecurityProfileTarget..................................................................................................... 1010 SecurityProfileTargetMapping......................................................................................... 1011 ServerCertificateSummary.............................................................................................. 1012 SigningProfileParameter................................................................................................ 1013 SigV4Authorization....................................................................................................... 1014 SnsAction..................................................................................................................... 1015 SqsAction..................................................................................................................... 1016 StartSigningJobParameter............................................................................................. 1017 x

Description:
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of
ebook img

AWS IoT - API Reference PDF

472 Pages·2017·3.21 MB·English
by  
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview AWS IoT - API Reference

AWS IoT API Reference AWS IoT API Reference AWS IoT: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS IoT API Reference Table of Contents Welcome........................................................................................................................................... 1 AWS IoT.................................................................................................................................... 1 AWS IoT data............................................................................................................................ 1 AWS IoT jobs data ...................................................................................................................... 1 AWS IoT Core Device Advisor ....................................................................................................... 2 AWS IoT Fleet Hub..................................................................................................................... 2 AWS IoT Secure Tunneling .......................................................................................................... 2 Actions............................................................................................................................................. 3 AWS IoT.................................................................................................................................... 9 AcceptCertificateTransfer................................................................................................... 15 AddThingToBillingGroup.................................................................................................... 17 AddThingToThingGroup..................................................................................................... 20 AssociateTargetsWithJob................................................................................................... 23 AttachPolicy.................................................................................................................... 26 AttachPrincipalPolicy........................................................................................................ 28 AttachSecurityProfile........................................................................................................ 30 AttachThingPrincipal ......................................................................................................... 32 CancelAuditMitigationActionsTask....................................................................................... 34 CancelAuditTask............................................................................................................... 36 CancelCertificateTransfer................................................................................................... 38 CancelDetectMitigationActionsTask..................................................................................... 40 CancelJob........................................................................................................................ 42 CancelJobExecution.......................................................................................................... 45 ClearDefaultAuthorizer...................................................................................................... 48 ConfirmTopicRuleDestination............................................................................................. 50 CreateAuditSuppression..................................................................................................... 52 CreateAuthorizer.............................................................................................................. 55 CreateBillingGroup............................................................................................................ 59 CreateCertificateFromCsr................................................................................................... 62 CreateCustomMetric.......................................................................................................... 65 CreateDimension.............................................................................................................. 68 CreateDomainConfiguration............................................................................................... 71 CreateDynamicThingGroup................................................................................................ 75 CreateFleetMetric............................................................................................................. 79 CreateJob........................................................................................................................ 84 CreateJobTemplate........................................................................................................... 90 CreateKeysAndCertificate................................................................................................... 95 CreateMitigationAction...................................................................................................... 98 CreateOTAUpdate........................................................................................................... 101 CreatePolicy................................................................................................................... 107 CreatePolicyVersion......................................................................................................... 110 CreateProvisioningClaim.................................................................................................. 113 CreateProvisioningTemplate............................................................................................. 116 CreateProvisioningTemplateVersion................................................................................... 120 CreateRoleAlias.............................................................................................................. 123 CreateScheduledAudit..................................................................................................... 126 CreateSecurityProfile....................................................................................................... 129 CreateStream................................................................................................................. 133 CreateThing................................................................................................................... 137 CreateThingGroup........................................................................................................... 140 CreateThingType............................................................................................................. 143 CreateTopicRule.............................................................................................................. 146 CreateTopicRuleDestination.............................................................................................. 155 DeleteAccountAuditConfiguration..................................................................................... 158 iii AWS IoT API Reference DeleteAuditSuppression................................................................................................... 160 DeleteAuthorizer............................................................................................................ 162 DeleteBillingGroup.......................................................................................................... 164 DeleteCACertificate......................................................................................................... 166 DeleteCertificate............................................................................................................. 168 DeleteCustomMetric........................................................................................................ 170 DeleteDimension............................................................................................................ 172 DeleteDomainConfiguration............................................................................................. 174 DeleteDynamicThingGroup............................................................................................... 176 DeleteFleetMetric........................................................................................................... 178 DeleteJob...................................................................................................................... 180 DeleteJobExecution......................................................................................................... 183 DeleteJobTemplate......................................................................................................... 186 DeleteMitigationAction.................................................................................................... 188 DeleteOTAUpdate........................................................................................................... 190 DeletePolicy................................................................................................................... 192 DeletePolicyVersion......................................................................................................... 194 DeleteProvisioningTemplate............................................................................................. 196 DeleteProvisioningTemplateVersion................................................................................... 198 DeleteRegistrationCode................................................................................................... 200 DeleteRoleAlias.............................................................................................................. 202 DeleteScheduledAudit..................................................................................................... 204 DeleteSecurityProfile....................................................................................................... 206 DeleteStream................................................................................................................. 208 DeleteThing................................................................................................................... 210 DeleteThingGroup........................................................................................................... 212 DeleteThingType............................................................................................................. 214 DeleteTopicRule.............................................................................................................. 216 DeleteTopicRuleDestination.............................................................................................. 218 DeleteV2LoggingLevel ..................................................................................................... 220 DeprecateThingType....................................................................................................... 222 DescribeAccountAuditConfiguration.................................................................................. 224 DescribeAuditFinding...................................................................................................... 226 DescribeAuditMitigationActionsTask.................................................................................. 229 DescribeAuditSuppression................................................................................................ 233 DescribeAuditTask........................................................................................................... 236 DescribeAuthorizer.......................................................................................................... 239 DescribeBillingGroup....................................................................................................... 241 DescribeCACertificate...................................................................................................... 244 DescribeCertificate.......................................................................................................... 247 DescribeCustomMetric..................................................................................................... 250 DescribeDefaultAuthorizer............................................................................................... 253 DescribeDetectMitigationActionsTask................................................................................ 255 DescribeDimension.......................................................................................................... 258 DescribeDomainConfiguration.......................................................................................... 261 DescribeEndpoint............................................................................................................ 264 DescribeEventConfigurations............................................................................................ 266 DescribeFleetMetric......................................................................................................... 268 DescribeIndex................................................................................................................. 272 DescribeJob................................................................................................................... 275 DescribeJobExecution...................................................................................................... 278 DescribeJobTemplate...................................................................................................... 281 DescribeManagedJobTemplate......................................................................................... 285 DescribeMitigationAction................................................................................................. 288 DescribeProvisioningTemplate.......................................................................................... 291 DescribeProvisioningTemplateVersion................................................................................ 295 DescribeRoleAlias............................................................................................................ 298 iv AWS IoT API Reference DescribeScheduledAudit.................................................................................................. 300 DescribeSecurityProfile.................................................................................................... 303 DescribeStream.............................................................................................................. 307 DescribeThing................................................................................................................ 310 DescribeThingGroup........................................................................................................ 313 DescribeThingRegistrationTask......................................................................................... 317 DescribeThingType.......................................................................................................... 321 DetachPolicy.................................................................................................................. 324 DetachPrincipalPolicy...................................................................................................... 326 DetachSecurityProfile...................................................................................................... 328 DetachThingPrincipal...................................................................................................... 330 DisableTopicRule............................................................................................................ 332 EnableTopicRule............................................................................................................. 334 GetBehaviorModelTrainingSummaries................................................................................ 336 GetBucketsAggregation................................................................................................... 338 GetCardinality................................................................................................................ 342 GetEffectivePolicies......................................................................................................... 345 GetIndexingConfiguration................................................................................................ 348 GetJobDocument............................................................................................................ 351 GetLoggingOptions......................................................................................................... 353 GetOTAUpdate............................................................................................................... 355 GetPercentiles................................................................................................................ 359 GetPolicy....................................................................................................................... 362 GetPolicyVersion............................................................................................................. 365 GetRegistrationCode....................................................................................................... 368 GetStatistics................................................................................................................... 370 GetTopicRule.................................................................................................................. 373 GetTopicRuleDestination.................................................................................................. 381 GetV2LoggingOptions..................................................................................................... 383 ListActiveViolations......................................................................................................... 385 ListAttachedPolicies........................................................................................................ 388 ListAuditFindings............................................................................................................ 391 ListAuditMitigationActionsExecutions................................................................................ 395 ListAuditMitigationActionsTasks........................................................................................ 398 ListAuditSuppressions...................................................................................................... 401 ListAuditTasks................................................................................................................ 404 ListAuthorizers............................................................................................................... 407 ListBillingGroups............................................................................................................. 410 ListCACertificates............................................................................................................ 412 ListCertificates............................................................................................................... 415 ListCertificatesByCA........................................................................................................ 418 ListCustomMetrics........................................................................................................... 421 ListDetectMitigationActionsExecutions............................................................................... 423 ListDetectMitigationActionsTasks...................................................................................... 426 ListDimensions............................................................................................................... 429 ListDomainConfigurations................................................................................................ 431 ListFleetMetrics.............................................................................................................. 434 ListIndices...................................................................................................................... 436 ListJobExecutionsForJob.................................................................................................. 438 ListJobExecutionsForThing ............................................................................................... 441 ListJobs......................................................................................................................... 444 ListJobTemplates............................................................................................................ 447 ListManagedJobTemplates............................................................................................... 449 ListMetricValues............................................................................................................. 451 ListMitigationActions....................................................................................................... 454 ListOTAUpdates.............................................................................................................. 456 ListOutgoingCertificates.................................................................................................. 459 v AWS IoT API Reference ListPolicies..................................................................................................................... 462 ListPolicyPrincipals.......................................................................................................... 465 ListPolicyVersions........................................................................................................... 468 ListPrincipalPolicies......................................................................................................... 470 ListPrincipalThings.......................................................................................................... 473 ListProvisioningTemplates................................................................................................ 476 ListProvisioningTemplateVersions..................................................................................... 478 ListRelatedResourcesForAuditFinding................................................................................. 481 ListRoleAliases................................................................................................................ 484 ListScheduledAudits........................................................................................................ 487 ListSecurityProfiles.......................................................................................................... 489 ListSecurityProfilesForTarget............................................................................................ 492 ListStreams.................................................................................................................... 495 ListTagsForResource........................................................................................................ 497 ListTargetsForPolicy........................................................................................................ 499 ListTargetsForSecurityProfile............................................................................................ 502 ListThingGroups............................................................................................................. 504 ListThingGroupsForThing ................................................................................................. 507 ListThingPrincipals.......................................................................................................... 509 ListThingRegistrationTaskReports...................................................................................... 512 ListThingRegistrationTasks............................................................................................... 515 ListThings...................................................................................................................... 517 ListThingsInBillingGroup.................................................................................................. 520 ListThingsInThingGroup................................................................................................... 522 ListThingTypes............................................................................................................... 524 ListTopicRuleDestinations................................................................................................ 527 ListTopicRules................................................................................................................ 529 ListV2LoggingLevels........................................................................................................ 531 ListViolationEvents......................................................................................................... 533 PutVerificationStateOnViolation....................................................................................... 537 RegisterCACertificate....................................................................................................... 539 RegisterCertificate.......................................................................................................... 543 RegisterCertificateWithoutCA........................................................................................... 546 RegisterThing................................................................................................................. 549 RejectCertificateTransfer.................................................................................................. 552 RemoveThingFromBillingGroup......................................................................................... 555 RemoveThingFromThingGroup......................................................................................... 558 ReplaceTopicRule............................................................................................................ 561 SearchIndex................................................................................................................... 569 SetDefaultAuthorizer....................................................................................................... 573 SetDefaultPolicyVersion................................................................................................... 576 SetLoggingOptions......................................................................................................... 578 SetV2LoggingLevel......................................................................................................... 580 SetV2LoggingOptions..................................................................................................... 582 StartAuditMitigationActionsTask....................................................................................... 584 StartDetectMitigationActionsTask..................................................................................... 587 StartOnDemandAuditTask................................................................................................ 590 StartThingRegistrationTask.............................................................................................. 592 StopThingRegistrationTask............................................................................................... 595 TagResource................................................................................................................... 597 TestAuthorization........................................................................................................... 599 TestInvokeAuthorizer....................................................................................................... 603 TransferCertificate.......................................................................................................... 607 UntagResource............................................................................................................... 610 UpdateAccountAuditConfiguration.................................................................................... 612 UpdateAuditSuppression.................................................................................................. 615 UpdateAuthorizer........................................................................................................... 618 vi AWS IoT API Reference UpdateBillingGroup......................................................................................................... 622 UpdateCACertificate........................................................................................................ 625 UpdateCertificate............................................................................................................ 628 UpdateCustomMetric....................................................................................................... 631 UpdateDimension........................................................................................................... 634 UpdateDomainConfiguration............................................................................................ 637 UpdateDynamicThingGroup............................................................................................. 640 UpdateEventConfigurations.............................................................................................. 643 UpdateFleetMetric.......................................................................................................... 645 UpdateIndexingConfiguration........................................................................................... 649 UpdateJob..................................................................................................................... 652 UpdateMitigationAction................................................................................................... 656 UpdateProvisioningTemplate............................................................................................ 659 UpdateRoleAlias............................................................................................................. 662 UpdateScheduledAudit.................................................................................................... 665 UpdateSecurityProfile...................................................................................................... 668 UpdateStream................................................................................................................ 674 UpdateThing.................................................................................................................. 677 UpdateThingGroup......................................................................................................... 680 UpdateThingGroupsForThing............................................................................................ 683 UpdateTopicRuleDestination............................................................................................ 686 ValidateSecurityProfileBehaviors....................................................................................... 689 AWS IoT data ......................................................................................................................... 691 DeleteThingShadow........................................................................................................ 692 GetRetainedMessage....................................................................................................... 695 GetThingShadow............................................................................................................ 698 ListNamedShadowsForThing ............................................................................................ 701 ListRetainedMessages...................................................................................................... 704 Publish.......................................................................................................................... 707 UpdateThingShadow....................................................................................................... 710 AWS IoT jobs data .................................................................................................................. 712 DescribeJobExecution...................................................................................................... 713 GetPendingJobExecutions................................................................................................ 716 StartNextPendingJobExecution......................................................................................... 719 UpdateJobExecution....................................................................................................... 722 AWS IoT Core Device Advisor ................................................................................................... 725 CreateSuiteDefinition...................................................................................................... 727 DeleteSuiteDefinition...................................................................................................... 730 GetEndpoint................................................................................................................... 732 GetSuiteDefinition.......................................................................................................... 734 GetSuiteRun................................................................................................................... 737 GetSuiteRunReport......................................................................................................... 741 ListSuiteDefinitions......................................................................................................... 743 ListSuiteRuns................................................................................................................. 745 ListTagsForResource........................................................................................................ 748 StartSuiteRun................................................................................................................. 750 StopSuiteRun................................................................................................................. 753 TagResource................................................................................................................... 755 UntagResource............................................................................................................... 757 UpdateSuiteDefinition..................................................................................................... 759 AWS IoT Fleet Hub ................................................................................................................. 761 CreateApplication........................................................................................................... 762 DeleteApplication........................................................................................................... 765 DescribeApplication........................................................................................................ 767 ListApplications.............................................................................................................. 771 ListTagsForResource........................................................................................................ 773 TagResource................................................................................................................... 775 vii AWS IoT API Reference UntagResource............................................................................................................... 777 UpdateApplication.......................................................................................................... 779 AWS IoT Secure Tunneling ....................................................................................................... 781 CloseTunnel................................................................................................................... 782 DescribeTunnel ............................................................................................................... 784 ListTagsForResource........................................................................................................ 786 ListTunnels.................................................................................................................... 788 OpenTunnel................................................................................................................... 790 RotateTunnelAccessToken................................................................................................ 793 TagResource................................................................................................................... 796 UntagResource............................................................................................................... 798 Data Types.................................................................................................................................... 800 AWS IoT................................................................................................................................ 805 AbortConfig................................................................................................................... 810 AbortCriteria.................................................................................................................. 811 Action........................................................................................................................... 813 ActiveViolation............................................................................................................... 817 AddThingsToThingGroupParams....................................................................................... 819 AggregationType............................................................................................................ 820 AlertTarget.................................................................................................................... 821 Allowed......................................................................................................................... 822 AssetPropertyTimestamp................................................................................................. 823 AssetPropertyValue......................................................................................................... 824 AssetPropertyVariant....................................................................................................... 825 AttributePayload............................................................................................................ 826 AuditCheckConfiguration................................................................................................. 827 AuditCheckDetails........................................................................................................... 828 AuditFinding.................................................................................................................. 830 AuditMitigationActionExecutionMetadata........................................................................... 832 AuditMitigationActionsTaskMetadata................................................................................. 834 AuditMitigationActionsTaskTarget..................................................................................... 835 AuditNotificationTarget................................................................................................... 836 AuditSuppression............................................................................................................ 837 AuditTaskMetadata......................................................................................................... 839 AuthInfo........................................................................................................................ 840 AuthorizerConfig ............................................................................................................ 841 AuthorizerDescription...................................................................................................... 842 AuthorizerSummary........................................................................................................ 844 AuthResult..................................................................................................................... 845 AwsJobAbortConfig ......................................................................................................... 846 AwsJobAbortCriteria........................................................................................................ 847 AwsJobExecutionsRolloutConfig........................................................................................ 849 AwsJobExponentialRolloutRate......................................................................................... 850 AwsJobPresignedUrlConfig............................................................................................... 851 AwsJobRateIncreaseCriteria.............................................................................................. 852 AwsJobTimeoutConfig..................................................................................................... 853 Behavior........................................................................................................................ 854 BehaviorCriteria.............................................................................................................. 856 BehaviorModelTrainingSummary....................................................................................... 858 BillingGroupMetadata...................................................................................................... 860 BillingGroupProperties.................................................................................................... 861 Bucket........................................................................................................................... 862 BucketsAggregationType.................................................................................................. 863 CACertificate.................................................................................................................. 864 CACertificateDescription.................................................................................................. 865 Certificate...................................................................................................................... 868 CertificateDescription...................................................................................................... 870 viii AWS IoT API Reference CertificateValidity........................................................................................................... 873 CloudwatchAlarmAction.................................................................................................. 874 CloudwatchLogsAction.................................................................................................... 875 CloudwatchMetricAction.................................................................................................. 876 CodeSigning................................................................................................................... 878 CodeSigningCertificateChain............................................................................................ 879 CodeSigningSignature..................................................................................................... 880 Configuration................................................................................................................. 881 CustomCodeSigning........................................................................................................ 882 Denied.......................................................................................................................... 883 Destination.................................................................................................................... 884 DetectMitigationActionExecution...................................................................................... 885 DetectMitigationActionsTaskStatistics................................................................................ 887 DetectMitigationActionsTaskSummary............................................................................... 888 DetectMitigationActionsTaskTarget................................................................................... 890 DocumentParameter....................................................................................................... 891 DomainConfigurationSummary......................................................................................... 893 DynamoDBAction............................................................................................................ 894 DynamoDBv2Action........................................................................................................ 896 EffectivePolicy................................................................................................................ 897 ElasticsearchAction......................................................................................................... 898 EnableIoTLoggingParams................................................................................................. 900 ErrorInfo........................................................................................................................ 901 ExplicitDeny................................................................................................................... 902 ExponentialRolloutRate................................................................................................... 903 Field............................................................................................................................. 904 FileLocation................................................................................................................... 905 FirehoseAction................................................................................................................ 906 FleetMetricNameAndArn.................................................................................................. 907 GroupNameAndArn......................................................................................................... 908 HttpAction..................................................................................................................... 909 HttpActionHeader........................................................................................................... 911 HttpAuthorization........................................................................................................... 912 HttpContext................................................................................................................... 913 HttpUrlDestinationConfiguration...................................................................................... 914 HttpUrlDestinationProperties........................................................................................... 915 HttpUrlDestinationSummary............................................................................................ 916 ImplicitDeny................................................................................................................... 917 IndexingFilter................................................................................................................. 918 IotAnalyticsAction........................................................................................................... 919 IotEventsAction.............................................................................................................. 920 IotSiteWiseAction........................................................................................................... 922 IssuerCertificateIdentifier................................................................................................. 923 Job............................................................................................................................... 924 JobExecution.................................................................................................................. 929 JobExecutionsRetryConfig................................................................................................ 931 JobExecutionsRolloutConfig............................................................................................. 932 JobExecutionStatusDetails............................................................................................... 933 JobExecutionSummary.................................................................................................... 934 JobExecutionSummaryForJob........................................................................................... 936 JobExecutionSummaryForThing ........................................................................................ 937 JobProcessDetails........................................................................................................... 938 JobSummary.................................................................................................................. 940 JobTemplateSummary..................................................................................................... 942 KafkaAction................................................................................................................... 944 KeyPair.......................................................................................................................... 945 KinesisAction.................................................................................................................. 946 ix AWS IoT API Reference LambdaAction................................................................................................................ 947 LocationAction............................................................................................................... 948 LocationTimestamp......................................................................................................... 950 LoggingOptionsPayload................................................................................................... 951 LogTarget...................................................................................................................... 952 LogTargetConfiguration................................................................................................... 953 MachineLearningDetectionConfig ...................................................................................... 954 ManagedJobTemplateSummary........................................................................................ 955 MetricDatum.................................................................................................................. 957 MetricDimension............................................................................................................. 958 MetricToRetain............................................................................................................... 959 MetricValue.................................................................................................................... 960 MitigationAction............................................................................................................. 962 MitigationActionIdentifier................................................................................................ 963 MitigationActionParams................................................................................................... 964 MqttContext.................................................................................................................. 966 MqttHeaders.................................................................................................................. 967 NonCompliantResource................................................................................................... 969 OpenSearchAction.......................................................................................................... 970 OTAUpdateFile............................................................................................................... 971 OTAUpdateInfo............................................................................................................... 973 OTAUpdateSummary....................................................................................................... 976 OutgoingCertificate........................................................................................................ 977 PercentPair.................................................................................................................... 979 Policy............................................................................................................................ 980 PolicyVersion.................................................................................................................. 981 PolicyVersionIdentifier..................................................................................................... 982 PresignedUrlConfig......................................................................................................... 983 ProvisioningHook............................................................................................................ 984 ProvisioningTemplateSummary......................................................................................... 985 ProvisioningTemplateVersionSummary.............................................................................. 987 PublishFindingToSnsParams............................................................................................. 988 PutAssetPropertyValueEntry............................................................................................ 989 PutItemInput.................................................................................................................. 991 RateIncreaseCriteria........................................................................................................ 992 RegistrationConfig .......................................................................................................... 993 RelatedResource............................................................................................................. 994 ReplaceDefaultPolicyVersionParams.................................................................................. 995 RepublishAction.............................................................................................................. 996 ResourceIdentifier........................................................................................................... 997 RetryCriteria................................................................................................................... 999 RoleAliasDescription...................................................................................................... 1000 S3Action...................................................................................................................... 1002 S3Destination............................................................................................................... 1003 S3Location................................................................................................................... 1004 SalesforceAction........................................................................................................... 1005 ScheduledAuditMetadata............................................................................................... 1006 SchedulingConfig.......................................................................................................... 1008 SecurityProfileIdentifier................................................................................................. 1009 SecurityProfileTarget..................................................................................................... 1010 SecurityProfileTargetMapping......................................................................................... 1011 ServerCertificateSummary.............................................................................................. 1012 SigningProfileParameter................................................................................................ 1013 SigV4Authorization....................................................................................................... 1014 SnsAction..................................................................................................................... 1015 SqsAction..................................................................................................................... 1016 StartSigningJobParameter............................................................................................. 1017 x

Description:
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of
See more

The list of books you might like

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
DMCA & Copyright: Dear all, most of the website is community built, users are uploading hundred of books everyday, which makes really hard for us to identify copyrighted material, please contact us if you want any material removed.
Copyright @ PDFdrive.to, 2022 | We love our users