Data retrieval APIs for AWS IoT
AWS IoT provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeAccountAuditConfiguration | Get information about audit configurations for the account | Read |
| DescribeAuditFinding | Get 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 started | Read |
| DescribeAuditMitigationActionsTask | Get information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings | Read |
| DescribeAuditSuppression | Get information about a Device Defender audit suppression | Read |
| DescribeAuditTask | Get information about a Device Defender audit | Read |
| DescribeAuthorizer | Describe an authorizer | Read |
| DescribeBillingGroup | Get information about the specified billing group | Read |
| DescribeCACertificate | Describe a registered CA certificate | Read |
| DescribeCertificate | Get information about the specified certificate | Read |
| DescribeCertificateProvider | Describe a certificate provider | Read |
| DescribeCustomMetric | Describe a custom metric that is defined in your AWS account | Read |
| DescribeDefaultAuthorizer | Describe the default authorizer | Read |
| DescribeDetectMitigationActionsTask | Describe a Device Defender ML Detect mitigation action | Read |
| DescribeDimension | Get details about a dimension that is defined in your AWS account | Read |
| DescribeDomainConfiguration | Get information about the domain configuration | Read |
| DescribeEncryptionConfiguration | Describe the encryption configuration for the account | Read |
| DescribeEndpoint | Get a unique endpoint specific to the AWS account making the call | Read |
| DescribeEventConfigurations | Get account event configurations | Read |
| DescribeFleetMetric | Get information about the specified fleet metric | Read |
| DescribeIndex | Get information about the specified index | Read |
| DescribeJob | Describe a job | Read |
| DescribeJobExecution | Describe a job execution | Read |
| DescribeJobTemplate | Describe a job template | Read |
| DescribeManagedJobTemplate | Describe a managed job template | Read |
| DescribeMitigationAction | Get information about a mitigation action | Read |
| DescribeProvisioningTemplate | Get information about a fleet provisioning template | Read |
| DescribeProvisioningTemplateVersion | Get information about a fleet provisioning template version | Read |
| DescribeRoleAlias | Describe a role alias | Read |
| DescribeScheduledAudit | Get information about a scheduled audit | Read |
| DescribeSecurityProfile | Get information about a Device Defender security profile | Read |
| DescribeStream | Get information about the specified stream | Read |
| DescribeThing | Get information about the specified thing | Read |
| DescribeThingGroup | Get information about the specified thing group | Read |
| DescribeThingRegistrationTask | Get information about the bulk thing registration task | Read |
| DescribeThingType | Get information about the specified thing type | Read |
| DescribeTunnel | Describe a tunnel | Read |
| GetBehaviorModelTrainingSummaries | Fetch a Device Defender's ML Detect Security Profile training model's status | List |
| GetBucketsAggregation | Get buckets aggregation for IoT fleet index | Read |
| GetCardinality | Get cardinality for IoT fleet index | Read |
| GetCommand | Get the information about the command | Read |
| GetCommandExecution | Get the information of a command execution | Read |
| GetEffectivePolicies | Get effective policies | Read |
| GetIndexingConfiguration | Get current fleet indexing configuration | Read |
| GetJobDocument | Get a job document | Read |
| GetLoggingOptions | Get the logging options | Read |
| GetOTAUpdate | Get the information about the OTA update job | Read |
| GetPackage | Get the information about the package | Read |
| GetPackageConfiguration | Get the package configuration of the account | Read |
| GetPackageVersion | Get the version of the package | Read |
| GetPercentiles | Get percentiles for IoT fleet index | Read |
| GetPolicy | Get information about the specified policy with the policy document of the default version | Read |
| GetPolicyVersion | Get information about the specified policy version | Read |
| GetRegistrationCode | Get a registration code used to register a CA certificate with AWS IoT | Read |
| GetRetainedMessage | Get the retained message on the specified topic | Read |
| GetStatistics | Get statistics for IoT fleet index | Read |
| GetThingConnectivityData | Get the thing's connectivity data | Read |
| GetThingShadow | Get the thing shadow | Read |
| GetTopicRule | Get information about the specified rule | Read |
| GetTopicRuleDestination | Get a TopicRuleDestination | Read |
| GetV2LoggingOptions | Get v2 logging options | Read |
| ListActiveViolations | List the active violations for a given Device Defender security profile or Thing | List |
| ListAttachedPolicies | List the policies attached to the specified thing group | List |
| ListAuditFindings | List the findings (results) of a Device Defender audit or of the audits performed during a specified time period | List |
| ListAuditMitigationActionsExecutions | Get the status of audit mitigation action tasks that were executed | List |
| ListAuditMitigationActionsTasks | Get a list of audit mitigation action tasks that match the specified filters | List |
| ListAuditSuppressions | List your Device Defender audit suppressions | List |
| ListAuditTasks | List the Device Defender audits that have been performed during a given time period | List |
| ListAuthorizers | List the authorizers registered in your account | List |
| ListBillingGroups | List all billing groups | List |
| ListCACertificates | List the CA certificates registered for your AWS account | List |
| ListCertificateProviders | List certificate providers in the account | List |
| ListCertificates | List your certificates | List |
| ListCertificatesByCA | List the device certificates signed by the specified CA certificate | List |
| ListCommandExecutions | List commands executions in the account | List |
| ListCommands | List commands in the account | List |
| ListCustomMetrics | List the custom metrics in your AWS account | List |
| ListDetectMitigationActionsExecutions | Lists mitigation actions executions for a Device Defender ML Detect Security Profile | List |
| ListDetectMitigationActionsTasks | List Device Defender ML Detect mitigation actions tasks | List |
| ListDimensions | List the dimensions that are defined for your AWS account | List |
| ListDomainConfigurations | List the domain configuration created by your AWS account | List |
| ListFleetMetrics | List the fleet metrics in your account | List |
| ListIndices | List all indices for fleet index | List |
| ListJobExecutionsForJob | List the job executions for a job | List |
| ListJobExecutionsForThing | List the job executions for the specified thing | List |
| ListJobTemplates | List job templates | List |
| ListJobs | List jobs | List |
| ListManagedJobTemplates | List managed job templates | List |
| ListMetricValues | Grants permissions to list the metric values for a thing based on the metricName, and dimension if specified | List |
| ListMitigationActions | Get a list of all mitigation actions that match the specified filter criteria | List |
| ListNamedShadowsForThing | List all named shadows for a given thing | List |
| ListOTAUpdates | List OTA update jobs in the account | List |
| ListOutgoingCertificates | List certificates that are being transfered but not yet accepted | List |
| ListPackageVersions | List versions for a package in the account | List |
| ListPackages | List packages in the account | List |
| ListPolicies | List your policies | List |
| ListPolicyPrincipals | List the principals associated with the specified policy | List |
| ListPolicyVersions | List the versions of the specified policy, and identifies the default version | List |
| ListPrincipalPolicies | List the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in Amazon Cognito Identity format | List |
| ListPrincipalThings | List the things associated with the specified principal | List |
| ListPrincipalThingsV2 | List the things associated with the specified principal | List |
| ListProvisioningTemplateVersions | Get a list of fleet provisioning template versions | List |
| ListProvisioningTemplates | List the fleet provisioning templates in your AWS account | List |
| ListRelatedResourcesForAuditFinding | List related resources for a single audit finding | List |
| ListRetainedMessages | List the retained messages for your account | List |
| ListRoleAliases | List role aliases | List |
| ListSbomValidationResults | List SBOM validation results of a package version | List |
| ListScheduledAudits | List all of your scheduled audits | List |
| ListSecurityProfiles | List the Device Defender security profiles you have created | List |
| ListSecurityProfilesForTarget | List the Device Defender security profiles attached to a target | List |
| ListStreams | List the streams in your account | List |
| ListTagsForResource | List all tags for a given resource | Read |
| ListTargetsForPolicy | List targets for the specified policy | List |
| ListTargetsForSecurityProfile | List the targets associated with a given Device Defender security profile | List |
| ListThingGroups | List all thing groups | List |
| ListThingGroupsForThing | List thing groups to which the specified thing belongs | List |
| ListThingPrincipals | List the principals associated with the specified thing | List |
| ListThingPrincipalsV2 | List the principals associated with the specified thing | List |
| ListThingRegistrationTaskReports | List information about bulk thing registration tasks | List |
| ListThingRegistrationTasks | List bulk thing registration tasks | List |
| ListThingTypes | List all thing types | List |
| ListThings | List all things | List |
| ListThingsInBillingGroup | List all things in the specified billing group | List |
| ListThingsInThingGroup | List all things in the specified thing group | List |
| ListTopicRuleDestinations | List all TopicRuleDestinations | List |
| ListTopicRules | List the rules for the specific topic | List |
| ListTunnels | List tunnels | List |
| ListV2LoggingLevels | List the v2 logging levels | List |
| ListViolationEvents | List the Device Defender security profile violations discovered during the given time period | List |
| SearchIndex | Search IoT fleet index | Read |
| TestAuthorization | Test the policies evaluation for group policies | Read |
| TestInvokeAuthorizer | Test invoke the specified custom authorizer for testing purposes | Read |
| ValidateSecurityProfileBehaviors | Validate a Device Defender security profile behaviors specification | Read |
