Data retrieval APIs for AWS IoT - AWS Online Register of Data Formats

Data retrieval APIs for AWS IoT

AWS IoT provides the following APIs for data retrieval.

Actions Description Access level
DescribeAccountAuditConfigurationGet information about audit configurations for the accountRead
DescribeAuditFindingGet information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was startedRead
DescribeAuditMitigationActionsTaskGet information about an audit mitigation task that is used to apply mitigation actions to a set of audit findingsRead
DescribeAuditSuppressionGet information about a Device Defender audit suppressionRead
DescribeAuditTaskGet information about a Device Defender auditRead
DescribeAuthorizerDescribe an authorizerRead
DescribeBillingGroupGet information about the specified billing groupRead
DescribeCACertificateDescribe a registered CA certificateRead
DescribeCertificateGet information about the specified certificateRead
DescribeCertificateProviderDescribe a certificate providerRead
DescribeCustomMetricDescribe a custom metric that is defined in your AWS accountRead
DescribeDefaultAuthorizerDescribe the default authorizerRead
DescribeDetectMitigationActionsTaskDescribe a Device Defender ML Detect mitigation actionRead
DescribeDimensionGet details about a dimension that is defined in your AWS accountRead
DescribeDomainConfigurationGet information about the domain configurationRead
DescribeEncryptionConfigurationDescribe the encryption configuration for the accountRead
DescribeEndpointGet a unique endpoint specific to the AWS account making the callRead
DescribeEventConfigurationsGet account event configurationsRead
DescribeFleetMetricGet information about the specified fleet metricRead
DescribeIndexGet information about the specified indexRead
DescribeJobDescribe a jobRead
DescribeJobExecutionDescribe a job executionRead
DescribeJobTemplateDescribe a job templateRead
DescribeManagedJobTemplateDescribe a managed job templateRead
DescribeMitigationActionGet information about a mitigation actionRead
DescribeProvisioningTemplateGet information about a fleet provisioning templateRead
DescribeProvisioningTemplateVersionGet information about a fleet provisioning template versionRead
DescribeRoleAliasDescribe a role aliasRead
DescribeScheduledAuditGet information about a scheduled auditRead
DescribeSecurityProfileGet information about a Device Defender security profileRead
DescribeStreamGet information about the specified streamRead
DescribeThingGet information about the specified thingRead
DescribeThingGroupGet information about the specified thing groupRead
DescribeThingRegistrationTaskGet information about the bulk thing registration taskRead
DescribeThingTypeGet information about the specified thing typeRead
DescribeTunnelDescribe a tunnelRead
GetBehaviorModelTrainingSummariesFetch a Device Defender's ML Detect Security Profile training model's statusList
GetBucketsAggregationGet buckets aggregation for IoT fleet indexRead
GetCardinalityGet cardinality for IoT fleet indexRead
GetCommandGet the information about the commandRead
GetCommandExecutionGet the information of a command executionRead
GetEffectivePoliciesGet effective policiesRead
GetIndexingConfigurationGet current fleet indexing configurationRead
GetJobDocumentGet a job documentRead
GetLoggingOptionsGet the logging optionsRead
GetOTAUpdateGet the information about the OTA update jobRead
GetPackageGet the information about the packageRead
GetPackageConfigurationGet the package configuration of the accountRead
GetPackageVersionGet the version of the packageRead
GetPercentilesGet percentiles for IoT fleet indexRead
GetPolicyGet information about the specified policy with the policy document of the default versionRead
GetPolicyVersionGet information about the specified policy versionRead
GetRegistrationCodeGet a registration code used to register a CA certificate with AWS IoTRead
GetRetainedMessageGet the retained message on the specified topicRead
GetStatisticsGet statistics for IoT fleet indexRead
GetThingConnectivityDataGet the thing's connectivity dataRead
GetThingShadowGet the thing shadowRead
GetTopicRuleGet information about the specified ruleRead
GetTopicRuleDestinationGet a TopicRuleDestinationRead
GetV2LoggingOptionsGet v2 logging optionsRead
ListActiveViolationsList the active violations for a given Device Defender security profile or ThingList
ListAttachedPoliciesList the policies attached to the specified thing groupList
ListAuditFindingsList the findings (results) of a Device Defender audit or of the audits performed during a specified time periodList
ListAuditMitigationActionsExecutionsGet the status of audit mitigation action tasks that were executedList
ListAuditMitigationActionsTasksGet a list of audit mitigation action tasks that match the specified filtersList
ListAuditSuppressionsList your Device Defender audit suppressionsList
ListAuditTasksList the Device Defender audits that have been performed during a given time periodList
ListAuthorizersList the authorizers registered in your accountList
ListBillingGroupsList all billing groupsList
ListCACertificatesList the CA certificates registered for your AWS accountList
ListCertificateProvidersList certificate providers in the accountList
ListCertificatesList your certificatesList
ListCertificatesByCAList the device certificates signed by the specified CA certificateList
ListCommandExecutionsList commands executions in the accountList
ListCommandsList commands in the accountList
ListCustomMetricsList the custom metrics in your AWS accountList
ListDetectMitigationActionsExecutionsLists mitigation actions executions for a Device Defender ML Detect Security ProfileList
ListDetectMitigationActionsTasksList Device Defender ML Detect mitigation actions tasksList
ListDimensionsList the dimensions that are defined for your AWS accountList
ListDomainConfigurationsList the domain configuration created by your AWS accountList
ListFleetMetricsList the fleet metrics in your accountList
ListIndicesList all indices for fleet indexList
ListJobExecutionsForJobList the job executions for a jobList
ListJobExecutionsForThingList the job executions for the specified thingList
ListJobTemplatesList job templatesList
ListJobsList jobsList
ListManagedJobTemplatesList managed job templatesList
ListMetricValuesGrants permissions to list the metric values for a thing based on the metricName, and dimension if specifiedList
ListMitigationActionsGet a list of all mitigation actions that match the specified filter criteriaList
ListNamedShadowsForThingList all named shadows for a given thingList
ListOTAUpdatesList OTA update jobs in the accountList
ListOutgoingCertificatesList certificates that are being transfered but not yet acceptedList
ListPackageVersionsList versions for a package in the accountList
ListPackagesList packages in the accountList
ListPoliciesList your policiesList
ListPolicyPrincipalsList the principals associated with the specified policyList
ListPolicyVersionsList the versions of the specified policy, and identifies the default versionList
ListPrincipalPoliciesList the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity formatList
ListPrincipalThingsList the things associated with the specified principalList
ListPrincipalThingsV2List the things associated with the specified principalList
ListProvisioningTemplateVersionsGet a list of fleet provisioning template versionsList
ListProvisioningTemplatesList the fleet provisioning templates in your AWS accountList
ListRelatedResourcesForAuditFindingList related resources for a single audit findingList
ListRetainedMessagesList the retained messages for your accountList
ListRoleAliasesList role aliasesList
ListSbomValidationResultsList SBOM validation results of a package versionList
ListScheduledAuditsList all of your scheduled auditsList
ListSecurityProfilesList the Device Defender security profiles you have createdList
ListSecurityProfilesForTargetList the Device Defender security profiles attached to a targetList
ListStreamsList the streams in your accountList
ListTagsForResourceList all tags for a given resourceRead
ListTargetsForPolicyList targets for the specified policyList
ListTargetsForSecurityProfileList the targets associated with a given Device Defender security profileList
ListThingGroupsList all thing groupsList
ListThingGroupsForThingList thing groups to which the specified thing belongsList
ListThingPrincipalsList the principals associated with the specified thingList
ListThingPrincipalsV2List the principals associated with the specified thingList
ListThingRegistrationTaskReportsList information about bulk thing registration tasksList
ListThingRegistrationTasksList bulk thing registration tasksList
ListThingTypesList all thing typesList
ListThingsList all thingsList
ListThingsInBillingGroupList all things in the specified billing groupList
ListThingsInThingGroupList all things in the specified thing groupList
ListTopicRuleDestinationsList all TopicRuleDestinationsList
ListTopicRulesList the rules for the specific topicList
ListTunnelsList tunnelsList
ListV2LoggingLevelsList the v2 logging levelsList
ListViolationEventsList the Device Defender security profile violations discovered during the given time periodList
SearchIndexSearch IoT fleet indexRead
TestAuthorizationTest the policies evaluation for group policiesRead
TestInvokeAuthorizerTest invoke the specified custom authorizer for testing purposesRead
ValidateSecurityProfileBehaviorsValidate a Device Defender security profile behaviors specificationRead