Expand description
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
If you’re using the service, you’re probably looking for IotClient and Iot.
Structs§
- Abort
Config The criteria that determine when and how a job abort takes place.
- Abort
Criteria The criteria that determine when and how a job abort takes place.
- Accept
Certificate Transfer Request The input for the AcceptCertificateTransfer operation.
- Action
Describes the actions associated with a rule.
- Active
Violation Information about an active Device Defender security profile behavior violation.
- AddThing
ToBilling Group Request - AddThing
ToBilling Group Response - AddThing
ToThing Group Request - AddThing
ToThing Group Response - AddThings
ToThing Group Params Parameters used when defining a mitigation action that move a set of things to a thing group.
- Alert
Target A structure containing the alert target ARN and the role ARN.
- Allowed
Contains information that allowed the authorization.
- Asset
Property Timestamp An asset property timestamp entry containing the following information.
- Asset
Property Value An asset property value entry containing the following information.
- Asset
Property Variant Contains an asset property value (of a single type).
- Associate
Targets With JobRequest - Associate
Targets With JobResponse - Attach
Policy Request - Attach
Principal Policy Request The input for the AttachPrincipalPolicy operation.
- Attach
Security Profile Request - Attach
Security Profile Response - Attach
Thing Principal Request The input for the AttachThingPrincipal operation.
- Attach
Thing Principal Response The output from the AttachThingPrincipal operation.
- Attribute
Payload The attribute payload.
- Audit
Check Configuration Which audit checks are enabled and disabled for this account.
- Audit
Check Details Information about the audit check.
- Audit
Finding The findings (results) of the audit.
- Audit
Mitigation Action Execution Metadata Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
- Audit
Mitigation Actions Task Metadata Information about an audit mitigation actions task that is returned by
ListAuditMitigationActionsTasks.- Audit
Mitigation Actions Task Target Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
- Audit
Notification Target Information about the targets to which audit notifications are sent.
- Audit
Task Metadata The audits that were performed.
- Auth
Info A collection of authorization information.
- Auth
Result The authorizer result.
- Authorizer
Config An object that specifies the authorization service for a domain.
- Authorizer
Description The authorizer description.
- Authorizer
Summary The authorizer summary.
- AwsJob
Abort Config The criteria that determine when and how a job abort takes place.
- AwsJob
Abort Criteria The criteria that determine when and how a job abort takes place.
- AwsJob
Executions Rollout Config Configuration for the rollout of OTA updates.
- AwsJob
Exponential Rollout Rate The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
- AwsJob
Presigned UrlConfig Configuration information for pre-signed URLs. Valid when
protocolscontains HTTP.- AwsJob
Rate Increase Criteria The criteria to initiate the increase in rate of rollout for a job.
- AwsJob
Timeout Config Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT.- Behavior
A Device Defender security profile behavior.
- Behavior
Criteria The criteria by which the behavior is determined to be normal.
- Billing
Group Metadata Additional information about the billing group.
- Billing
Group Properties The properties of a billing group.
- CACertificate
A CA certificate.
- CACertificate
Description Describes a CA certificate.
- Cancel
Audit Mitigation Actions Task Request - Cancel
Audit Mitigation Actions Task Response - Cancel
Audit Task Request - Cancel
Audit Task Response - Cancel
Certificate Transfer Request The input for the CancelCertificateTransfer operation.
- Cancel
JobExecution Request - Cancel
JobRequest - Cancel
JobResponse - Certificate
Information about a certificate.
- Certificate
Description Describes a certificate.
- Certificate
Validity When the certificate is valid.
- Clear
Default Authorizer Request - Clear
Default Authorizer Response - Cloudwatch
Alarm Action Describes an action that updates a CloudWatch alarm.
- Cloudwatch
Logs Action Describes an action that sends data to CloudWatch Logs.
- Cloudwatch
Metric Action Describes an action that captures a CloudWatch metric.
- Code
Signing Describes the method to use when code signing a file.
- Code
Signing Certificate Chain Describes the certificate chain being used when code signing a file.
- Code
Signing Signature Describes the signature for a file.
- Configuration
Configuration.
- Confirm
Topic Rule Destination Request - Confirm
Topic Rule Destination Response - Create
Authorizer Request - Create
Authorizer Response - Create
Billing Group Request - Create
Billing Group Response - Create
Certificate From CsrRequest The input for the CreateCertificateFromCsr operation.
- Create
Certificate From CsrResponse The output from the CreateCertificateFromCsr operation.
- Create
Dimension Request - Create
Dimension Response - Create
Domain Configuration Request - Create
Domain Configuration Response - Create
Dynamic Thing Group Request - Create
Dynamic Thing Group Response - Create
JobRequest - Create
JobResponse - Create
Keys AndCertificate Request The input for the CreateKeysAndCertificate operation.
- Create
Keys AndCertificate Response The output of the CreateKeysAndCertificate operation.
- Create
Mitigation Action Request - Create
Mitigation Action Response - CreateOTA
Update Request - CreateOTA
Update Response - Create
Policy Request The input for the CreatePolicy operation.
- Create
Policy Response The output from the CreatePolicy operation.
- Create
Policy Version Request The input for the CreatePolicyVersion operation.
- Create
Policy Version Response The output of the CreatePolicyVersion operation.
- Create
Provisioning Claim Request - Create
Provisioning Claim Response - Create
Provisioning Template Request - Create
Provisioning Template Response - Create
Provisioning Template Version Request - Create
Provisioning Template Version Response - Create
Role Alias Request - Create
Role Alias Response - Create
Scheduled Audit Request - Create
Scheduled Audit Response - Create
Security Profile Request - Create
Security Profile Response - Create
Stream Request - Create
Stream Response - Create
Thing Group Request - Create
Thing Group Response - Create
Thing Request The input for the CreateThing operation.
- Create
Thing Response The output of the CreateThing operation.
- Create
Thing Type Request The input for the CreateThingType operation.
- Create
Thing Type Response The output of the CreateThingType operation.
- Create
Topic Rule Destination Request - Create
Topic Rule Destination Response - Create
Topic Rule Request The input for the CreateTopicRule operation.
- Custom
Code Signing Describes a custom method used to code sign a file.
- Delete
Account Audit Configuration Request - Delete
Account Audit Configuration Response - Delete
Authorizer Request - Delete
Authorizer Response - Delete
Billing Group Request - Delete
Billing Group Response - DeleteCA
Certificate Request Input for the DeleteCACertificate operation.
- DeleteCA
Certificate Response The output for the DeleteCACertificate operation.
- Delete
Certificate Request The input for the DeleteCertificate operation.
- Delete
Dimension Request - Delete
Dimension Response - Delete
Domain Configuration Request - Delete
Domain Configuration Response - Delete
Dynamic Thing Group Request - Delete
Dynamic Thing Group Response - Delete
JobExecution Request - Delete
JobRequest - Delete
Mitigation Action Request - Delete
Mitigation Action Response - DeleteOTA
Update Request - DeleteOTA
Update Response - Delete
Policy Request The input for the DeletePolicy operation.
- Delete
Policy Version Request The input for the DeletePolicyVersion operation.
- Delete
Provisioning Template Request - Delete
Provisioning Template Response - Delete
Provisioning Template Version Request - Delete
Provisioning Template Version Response - Delete
Registration Code Request The input for the DeleteRegistrationCode operation.
- Delete
Registration Code Response The output for the DeleteRegistrationCode operation.
- Delete
Role Alias Request - Delete
Role Alias Response - Delete
Scheduled Audit Request - Delete
Scheduled Audit Response - Delete
Security Profile Request - Delete
Security Profile Response - Delete
Stream Request - Delete
Stream Response - Delete
Thing Group Request - Delete
Thing Group Response - Delete
Thing Request The input for the DeleteThing operation.
- Delete
Thing Response The output of the DeleteThing operation.
- Delete
Thing Type Request The input for the DeleteThingType operation.
- Delete
Thing Type Response The output for the DeleteThingType operation.
- Delete
Topic Rule Destination Request - Delete
Topic Rule Destination Response - Delete
Topic Rule Request The input for the DeleteTopicRule operation.
- Delete
V2Logging Level Request - Denied
Contains information that denied the authorization.
- Deprecate
Thing Type Request The input for the DeprecateThingType operation.
- Deprecate
Thing Type Response The output for the DeprecateThingType operation.
- Describe
Account Audit Configuration Request - Describe
Account Audit Configuration Response - Describe
Audit Finding Request - Describe
Audit Finding Response - Describe
Audit Mitigation Actions Task Request - Describe
Audit Mitigation Actions Task Response - Describe
Audit Task Request - Describe
Audit Task Response - Describe
Authorizer Request - Describe
Authorizer Response - Describe
Billing Group Request - Describe
Billing Group Response - DescribeCA
Certificate Request The input for the DescribeCACertificate operation.
- DescribeCA
Certificate Response The output from the DescribeCACertificate operation.
- Describe
Certificate Request The input for the DescribeCertificate operation.
- Describe
Certificate Response The output of the DescribeCertificate operation.
- Describe
Default Authorizer Request - Describe
Default Authorizer Response - Describe
Dimension Request - Describe
Dimension Response - Describe
Domain Configuration Request - Describe
Domain Configuration Response - Describe
Endpoint Request The input for the DescribeEndpoint operation.
- Describe
Endpoint Response The output from the DescribeEndpoint operation.
- Describe
Event Configurations Request - Describe
Event Configurations Response - Describe
Index Request - Describe
Index Response - Describe
JobExecution Request - Describe
JobExecution Response - Describe
JobRequest - Describe
JobResponse - Describe
Mitigation Action Request - Describe
Mitigation Action Response - Describe
Provisioning Template Request - Describe
Provisioning Template Response - Describe
Provisioning Template Version Request - Describe
Provisioning Template Version Response - Describe
Role Alias Request - Describe
Role Alias Response - Describe
Scheduled Audit Request - Describe
Scheduled Audit Response - Describe
Security Profile Request - Describe
Security Profile Response - Describe
Stream Request - Describe
Stream Response - Describe
Thing Group Request - Describe
Thing Group Response - Describe
Thing Registration Task Request - Describe
Thing Registration Task Response - Describe
Thing Request The input for the DescribeThing operation.
- Describe
Thing Response The output from the DescribeThing operation.
- Describe
Thing Type Request The input for the DescribeThingType operation.
- Describe
Thing Type Response The output for the DescribeThingType operation.
- Destination
Describes the location of the updated firmware.
- Detach
Policy Request - Detach
Principal Policy Request The input for the DetachPrincipalPolicy operation.
- Detach
Security Profile Request - Detach
Security Profile Response - Detach
Thing Principal Request The input for the DetachThingPrincipal operation.
- Detach
Thing Principal Response The output from the DetachThingPrincipal operation.
- Disable
Topic Rule Request The input for the DisableTopicRuleRequest operation.
- Domain
Configuration Summary The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an AWS-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.
-
Data
-
Jobs
-
CredentialProvider
The domain configuration feature is in public preview and is subject to change.
-
- DynamoDB
Action Describes an action to write to a DynamoDB table.
The
tableName,hashKeyField, andrangeKeyFieldvalues must match the values used when you created the table.The
hashKeyValueandrangeKeyvaluefields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
"hashKeyValue": "${topic(3)}"The following field uses the timestamp:
"rangeKeyValue": "${timestamp()}"- DynamoD
Bv2Action Describes an action to write to a DynamoDB table.
This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.
- Effective
Policy The policy that has the effect on the authorization results.
- Elasticsearch
Action Describes an action that writes data to an Amazon Elasticsearch Service domain.
- Enable
IoTLogging Params Parameters used when defining a mitigation action that enable AWS IoT logging.
- Enable
Topic Rule Request The input for the EnableTopicRuleRequest operation.
- Error
Info Error information.
- Explicit
Deny Information that explicitly denies authorization.
- Exponential
Rollout Rate Allows you to create an exponential rate of rollout for a job.
- Field
Describes the name and data type at a field.
- File
Location The location of the OTA update.
- Firehose
Action Describes an action that writes data to an Amazon Kinesis Firehose stream.
- GetCardinality
Request - GetCardinality
Response - GetEffective
Policies Request - GetEffective
Policies Response - GetIndexing
Configuration Request - GetIndexing
Configuration Response - GetJob
Document Request - GetJob
Document Response - GetLogging
Options Request The input for the GetLoggingOptions operation.
- GetLogging
Options Response The output from the GetLoggingOptions operation.
- GetOTA
Update Request - GetOTA
Update Response - GetPercentiles
Request - GetPercentiles
Response - GetPolicy
Request The input for the GetPolicy operation.
- GetPolicy
Response The output from the GetPolicy operation.
- GetPolicy
Version Request The input for the GetPolicyVersion operation.
- GetPolicy
Version Response The output from the GetPolicyVersion operation.
- GetRegistration
Code Request The input to the GetRegistrationCode operation.
- GetRegistration
Code Response The output from the GetRegistrationCode operation.
- GetStatistics
Request - GetStatistics
Response - GetTopic
Rule Destination Request - GetTopic
Rule Destination Response - GetTopic
Rule Request The input for the GetTopicRule operation.
- GetTopic
Rule Response The output from the GetTopicRule operation.
- GetV2
Logging Options Request - GetV2
Logging Options Response - Group
Name AndArn The name and ARN of a group.
- Http
Action Send data to an HTTPS endpoint.
- Http
Action Header The HTTP action header.
- Http
Authorization The authorization method used to send messages.
- Http
Context Specifies the HTTP context to use for the test authorizer request.
- Http
UrlDestination Configuration HTTP URL destination configuration used by the topic rule's HTTP action.
- Http
UrlDestination Properties HTTP URL destination properties.
- Http
UrlDestination Summary Information about an HTTP URL destination.
- Implicit
Deny Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
- IotAnalytics
Action Sends message data to an AWS IoT Analytics channel.
- IotClient
- A client for the AWS IoT API.
- IotEvents
Action Sends an input to an AWS IoT Events detector.
- IotSite
Wise Action Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- Job
The
Jobobject contains details about a job.- JobExecution
The job execution object represents the execution of a job on a particular device.
- JobExecution
Status Details Details of the job execution status.
- JobExecution
Summary The job execution summary.
- JobExecution
Summary ForJob Contains a summary of information about job executions for a specific job.
- JobExecution
Summary ForThing The job execution summary for a thing.
- JobExecutions
Rollout Config Allows you to create a staged rollout of a job.
- JobProcess
Details The job process details.
- JobSummary
The job summary.
- KeyPair
Describes a key pair.
- Kinesis
Action Describes an action to write data to an Amazon Kinesis stream.
- Lambda
Action Describes an action to invoke a Lambda function.
- List
Active Violations Request - List
Active Violations Response - List
Attached Policies Request - List
Attached Policies Response - List
Audit Findings Request - List
Audit Findings Response - List
Audit Mitigation Actions Executions Request - List
Audit Mitigation Actions Executions Response - List
Audit Mitigation Actions Tasks Request - List
Audit Mitigation Actions Tasks Response - List
Audit Tasks Request - List
Audit Tasks Response - List
Authorizers Request - List
Authorizers Response - List
Billing Groups Request - List
Billing Groups Response - ListCA
Certificates Request Input for the ListCACertificates operation.
- ListCA
Certificates Response The output from the ListCACertificates operation.
- List
Certificates ByCA Request The input to the ListCertificatesByCA operation.
- List
Certificates ByCA Response The output of the ListCertificatesByCA operation.
- List
Certificates Request The input for the ListCertificates operation.
- List
Certificates Response The output of the ListCertificates operation.
- List
Dimensions Request - List
Dimensions Response - List
Domain Configurations Request - List
Domain Configurations Response - List
Indices Request - List
Indices Response - List
JobExecutions ForJob Request - List
JobExecutions ForJob Response - List
JobExecutions ForThing Request - List
JobExecutions ForThing Response - List
Jobs Request - List
Jobs Response - List
Mitigation Actions Request - List
Mitigation Actions Response - ListOTA
Updates Request - ListOTA
Updates Response - List
Outgoing Certificates Request The input to the ListOutgoingCertificates operation.
- List
Outgoing Certificates Response The output from the ListOutgoingCertificates operation.
- List
Policies Request The input for the ListPolicies operation.
- List
Policies Response The output from the ListPolicies operation.
- List
Policy Principals Request The input for the ListPolicyPrincipals operation.
- List
Policy Principals Response The output from the ListPolicyPrincipals operation.
- List
Policy Versions Request The input for the ListPolicyVersions operation.
- List
Policy Versions Response The output from the ListPolicyVersions operation.
- List
Principal Policies Request The input for the ListPrincipalPolicies operation.
- List
Principal Policies Response The output from the ListPrincipalPolicies operation.
- List
Principal Things Request The input for the ListPrincipalThings operation.
- List
Principal Things Response The output from the ListPrincipalThings operation.
- List
Provisioning Template Versions Request - List
Provisioning Template Versions Response - List
Provisioning Templates Request - List
Provisioning Templates Response - List
Role Aliases Request - List
Role Aliases Response - List
Scheduled Audits Request - List
Scheduled Audits Response - List
Security Profiles ForTarget Request - List
Security Profiles ForTarget Response - List
Security Profiles Request - List
Security Profiles Response - List
Streams Request - List
Streams Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Targets ForPolicy Request - List
Targets ForPolicy Response - List
Targets ForSecurity Profile Request - List
Targets ForSecurity Profile Response - List
Thing Groups ForThing Request - List
Thing Groups ForThing Response - List
Thing Groups Request - List
Thing Groups Response - List
Thing Principals Request The input for the ListThingPrincipal operation.
- List
Thing Principals Response The output from the ListThingPrincipals operation.
- List
Thing Registration Task Reports Request - List
Thing Registration Task Reports Response - List
Thing Registration Tasks Request - List
Thing Registration Tasks Response - List
Thing Types Request The input for the ListThingTypes operation.
- List
Thing Types Response The output for the ListThingTypes operation.
- List
Things InBilling Group Request - List
Things InBilling Group Response - List
Things InThing Group Request - List
Things InThing Group Response - List
Things Request The input for the ListThings operation.
- List
Things Response The output from the ListThings operation.
- List
Topic Rule Destinations Request - List
Topic Rule Destinations Response - List
Topic Rules Request The input for the ListTopicRules operation.
- List
Topic Rules Response The output from the ListTopicRules operation.
- List
V2Logging Levels Request - List
V2Logging Levels Response - List
Violation Events Request - List
Violation Events Response - LogTarget
A log target.
- LogTarget
Configuration The target configuration.
- Logging
Options Payload Describes the logging options payload.
- Metric
Dimension The dimension of a metric.
- Metric
ToRetain The metric you want to retain. Dimensions are optional.
- Metric
Value The value to be compared with the
metric.- Mitigation
Action Describes which changes should be applied as part of a mitigation action.
- Mitigation
Action Identifier Information that identifies a mitigation action. This information is returned by ListMitigationActions.
- Mitigation
Action Params The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).
- Mqtt
Context Specifies the MQTT context to use for the test authorizer request
- NonCompliant
Resource Information about the resource that was noncompliant with the audit check.
- OTAUpdate
File Describes a file to be associated with an OTA update.
- OTAUpdate
Info Information about an OTA update.
- OTAUpdate
Summary An OTA update summary.
- Outgoing
Certificate A certificate that has been transferred but not yet accepted.
- Percent
Pair Describes the percentile and percentile value.
- Policy
Describes an AWS IoT policy.
- Policy
Version Describes a policy version.
- Policy
Version Identifier Information about the version of the policy associated with the resource.
- Presigned
UrlConfig Configuration for pre-signed S3 URLs.
- Provisioning
Hook Structure that contains
payloadVersionandtargetArn.- Provisioning
Template Summary A summary of information about a fleet provisioning template.
- Provisioning
Template Version Summary A summary of information about a fleet provision template version.
- Publish
Finding ToSns Params Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
- PutAsset
Property Value Entry An asset property value entry containing the following information.
- PutItem
Input The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
- Rate
Increase Criteria Allows you to define a criteria to initiate the increase in rate of rollout for a job.
- RegisterCA
Certificate Request The input to the RegisterCACertificate operation.
- RegisterCA
Certificate Response The output from the RegisterCACertificateResponse operation.
- Register
Certificate Request The input to the RegisterCertificate operation.
- Register
Certificate Response The output from the RegisterCertificate operation.
- Register
Certificate WithoutCA Request - Register
Certificate WithoutCA Response - Register
Thing Request - Register
Thing Response - Registration
Config The registration configuration.
- Reject
Certificate Transfer Request The input for the RejectCertificateTransfer operation.
- Related
Resource Information about a related resource.
- Remove
Thing From Billing Group Request - Remove
Thing From Billing Group Response - Remove
Thing From Thing Group Request - Remove
Thing From Thing Group Response - Replace
Default Policy Version Params Parameters to define a mitigation action that adds a blank policy to restrict permissions.
- Replace
Topic Rule Request The input for the ReplaceTopicRule operation.
- Republish
Action Describes an action to republish to another topic.
- Resource
Identifier Information that identifies the noncompliant resource.
- Role
Alias Description Role alias description.
- S3Action
Describes an action to write data to an Amazon S3 bucket.
- S3Destination
Describes the location of updated firmware in S3.
- S3Location
The S3 location.
- Salesforce
Action Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
- Scheduled
Audit Metadata Information about the scheduled audit.
- Search
Index Request - Search
Index Response - Security
Profile Identifier Identifying information for a Device Defender security profile.
- Security
Profile Target A target to which an alert is sent when a security profile behavior is violated.
- Security
Profile Target Mapping Information about a security profile and the target associated with it.
- Server
Certificate Summary An object that contains information about a server certificate.
- SetDefault
Authorizer Request - SetDefault
Authorizer Response - SetDefault
Policy Version Request The input for the SetDefaultPolicyVersion operation.
- SetLogging
Options Request The input for the SetLoggingOptions operation.
- SetV2
Logging Level Request - SetV2
Logging Options Request - SigV4
Authorization Use Sig V4 authorization.
- Signing
Profile Parameter Describes the code-signing profile.
- SnsAction
Describes an action to publish to an Amazon SNS topic.
- SqsAction
Describes an action to publish data to an Amazon SQS queue.
- Start
Audit Mitigation Actions Task Request - Start
Audit Mitigation Actions Task Response - Start
OnDemand Audit Task Request - Start
OnDemand Audit Task Response - Start
Signing JobParameter Information required to start a signing job.
- Start
Thing Registration Task Request - Start
Thing Registration Task Response - Statistical
Threshold A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
- Statistics
A map of key-value pairs for all supported statistics. Currently, only count is supported.
- Step
Functions Action Starts execution of a Step Functions state machine.
- Stop
Thing Registration Task Request - Stop
Thing Registration Task Response - Stream
Describes a group of files that can be streamed.
- Stream
File Represents a file to stream.
- Stream
Info Information about a stream.
- Stream
Summary A summary of a stream.
- Tag
A set of key/value pairs that are used to manage the resource.
- TagResource
Request - TagResource
Response - Task
Statistics Statistics for the checks performed during the audit.
- Task
Statistics ForAudit Check Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.
- Test
Authorization Request - Test
Authorization Response - Test
Invoke Authorizer Request - Test
Invoke Authorizer Response - Thing
Attribute The properties of the thing, including thing name, thing type name, and a list of thing attributes.
- Thing
Connectivity The connectivity status of the thing.
- Thing
Document The thing search index document.
- Thing
Group Document The thing group search index document.
- Thing
Group Indexing Configuration Thing group indexing configuration.
- Thing
Group Metadata Thing group metadata.
- Thing
Group Properties Thing group properties.
- Thing
Indexing Configuration The thing indexing configuration. For more information, see Managing Thing Indexing.
- Thing
Type Definition The definition of the thing type, including thing type name and description.
- Thing
Type Metadata The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.
- Thing
Type Properties The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
- Timeout
Config Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT.- TlsContext
Specifies the TLS context to use for the test authorizer request.
- Topic
Rule Describes a rule.
- Topic
Rule Destination A topic rule destination.
- Topic
Rule Destination Configuration Configuration of the topic rule destination.
- Topic
Rule Destination Summary Information about the topic rule destination.
- Topic
Rule List Item Describes a rule.
- Topic
Rule Payload Describes a rule.
- Transfer
Certificate Request The input for the TransferCertificate operation.
- Transfer
Certificate Response The output from the TransferCertificate operation.
- Transfer
Data Data used to transfer a certificate to an AWS account.
- Untag
Resource Request - Untag
Resource Response - Update
Account Audit Configuration Request - Update
Account Audit Configuration Response - Update
Authorizer Request - Update
Authorizer Response - Update
Billing Group Request - Update
Billing Group Response - UpdateCA
Certificate Params Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
- UpdateCA
Certificate Request The input to the UpdateCACertificate operation.
- Update
Certificate Request The input for the UpdateCertificate operation.
- Update
Device Certificate Params Parameters to define a mitigation action that changes the state of the device certificate to inactive.
- Update
Dimension Request - Update
Dimension Response - Update
Domain Configuration Request - Update
Domain Configuration Response - Update
Dynamic Thing Group Request - Update
Dynamic Thing Group Response - Update
Event Configurations Request - Update
Event Configurations Response - Update
Indexing Configuration Request - Update
Indexing Configuration Response - Update
JobRequest - Update
Mitigation Action Request - Update
Mitigation Action Response - Update
Provisioning Template Request - Update
Provisioning Template Response - Update
Role Alias Request - Update
Role Alias Response - Update
Scheduled Audit Request - Update
Scheduled Audit Response - Update
Security Profile Request - Update
Security Profile Response - Update
Stream Request - Update
Stream Response - Update
Thing Group Request - Update
Thing Group Response - Update
Thing Groups ForThing Request - Update
Thing Groups ForThing Response - Update
Thing Request The input for the UpdateThing operation.
- Update
Thing Response The output from the UpdateThing operation.
- Update
Topic Rule Destination Request - Update
Topic Rule Destination Response - Validate
Security Profile Behaviors Request - Validate
Security Profile Behaviors Response - Validation
Error Information about an error found in a behavior specification.
- Violation
Event Information about a Device Defender security profile behavior violation.
Enums§
- Accept
Certificate Transfer Error - Errors returned by AcceptCertificateTransfer
- AddThing
ToBilling Group Error - Errors returned by AddThingToBillingGroup
- AddThing
ToThing Group Error - Errors returned by AddThingToThingGroup
- Associate
Targets With JobError - Errors returned by AssociateTargetsWithJob
- Attach
Policy Error - Errors returned by AttachPolicy
- Attach
Principal Policy Error - Errors returned by AttachPrincipalPolicy
- Attach
Security Profile Error - Errors returned by AttachSecurityProfile
- Attach
Thing Principal Error - Errors returned by AttachThingPrincipal
- Cancel
Audit Mitigation Actions Task Error - Errors returned by CancelAuditMitigationActionsTask
- Cancel
Audit Task Error - Errors returned by CancelAuditTask
- Cancel
Certificate Transfer Error - Errors returned by CancelCertificateTransfer
- Cancel
JobError - Errors returned by CancelJob
- Cancel
JobExecution Error - Errors returned by CancelJobExecution
- Clear
Default Authorizer Error - Errors returned by ClearDefaultAuthorizer
- Confirm
Topic Rule Destination Error - Errors returned by ConfirmTopicRuleDestination
- Create
Authorizer Error - Errors returned by CreateAuthorizer
- Create
Billing Group Error - Errors returned by CreateBillingGroup
- Create
Certificate From CsrError - Errors returned by CreateCertificateFromCsr
- Create
Dimension Error - Errors returned by CreateDimension
- Create
Domain Configuration Error - Errors returned by CreateDomainConfiguration
- Create
Dynamic Thing Group Error - Errors returned by CreateDynamicThingGroup
- Create
JobError - Errors returned by CreateJob
- Create
Keys AndCertificate Error - Errors returned by CreateKeysAndCertificate
- Create
Mitigation Action Error - Errors returned by CreateMitigationAction
- CreateOTA
Update Error - Errors returned by CreateOTAUpdate
- Create
Policy Error - Errors returned by CreatePolicy
- Create
Policy Version Error - Errors returned by CreatePolicyVersion
- Create
Provisioning Claim Error - Errors returned by CreateProvisioningClaim
- Create
Provisioning Template Error - Errors returned by CreateProvisioningTemplate
- Create
Provisioning Template Version Error - Errors returned by CreateProvisioningTemplateVersion
- Create
Role Alias Error - Errors returned by CreateRoleAlias
- Create
Scheduled Audit Error - Errors returned by CreateScheduledAudit
- Create
Security Profile Error - Errors returned by CreateSecurityProfile
- Create
Stream Error - Errors returned by CreateStream
- Create
Thing Error - Errors returned by CreateThing
- Create
Thing Group Error - Errors returned by CreateThingGroup
- Create
Thing Type Error - Errors returned by CreateThingType
- Create
Topic Rule Destination Error - Errors returned by CreateTopicRuleDestination
- Create
Topic Rule Error - Errors returned by CreateTopicRule
- Delete
Account Audit Configuration Error - Errors returned by DeleteAccountAuditConfiguration
- Delete
Authorizer Error - Errors returned by DeleteAuthorizer
- Delete
Billing Group Error - Errors returned by DeleteBillingGroup
- DeleteCA
Certificate Error - Errors returned by DeleteCACertificate
- Delete
Certificate Error - Errors returned by DeleteCertificate
- Delete
Dimension Error - Errors returned by DeleteDimension
- Delete
Domain Configuration Error - Errors returned by DeleteDomainConfiguration
- Delete
Dynamic Thing Group Error - Errors returned by DeleteDynamicThingGroup
- Delete
JobError - Errors returned by DeleteJob
- Delete
JobExecution Error - Errors returned by DeleteJobExecution
- Delete
Mitigation Action Error - Errors returned by DeleteMitigationAction
- DeleteOTA
Update Error - Errors returned by DeleteOTAUpdate
- Delete
Policy Error - Errors returned by DeletePolicy
- Delete
Policy Version Error - Errors returned by DeletePolicyVersion
- Delete
Provisioning Template Error - Errors returned by DeleteProvisioningTemplate
- Delete
Provisioning Template Version Error - Errors returned by DeleteProvisioningTemplateVersion
- Delete
Registration Code Error - Errors returned by DeleteRegistrationCode
- Delete
Role Alias Error - Errors returned by DeleteRoleAlias
- Delete
Scheduled Audit Error - Errors returned by DeleteScheduledAudit
- Delete
Security Profile Error - Errors returned by DeleteSecurityProfile
- Delete
Stream Error - Errors returned by DeleteStream
- Delete
Thing Error - Errors returned by DeleteThing
- Delete
Thing Group Error - Errors returned by DeleteThingGroup
- Delete
Thing Type Error - Errors returned by DeleteThingType
- Delete
Topic Rule Destination Error - Errors returned by DeleteTopicRuleDestination
- Delete
Topic Rule Error - Errors returned by DeleteTopicRule
- Delete
V2Logging Level Error - Errors returned by DeleteV2LoggingLevel
- Deprecate
Thing Type Error - Errors returned by DeprecateThingType
- Describe
Account Audit Configuration Error - Errors returned by DescribeAccountAuditConfiguration
- Describe
Audit Finding Error - Errors returned by DescribeAuditFinding
- Describe
Audit Mitigation Actions Task Error - Errors returned by DescribeAuditMitigationActionsTask
- Describe
Audit Task Error - Errors returned by DescribeAuditTask
- Describe
Authorizer Error - Errors returned by DescribeAuthorizer
- Describe
Billing Group Error - Errors returned by DescribeBillingGroup
- DescribeCA
Certificate Error - Errors returned by DescribeCACertificate
- Describe
Certificate Error - Errors returned by DescribeCertificate
- Describe
Default Authorizer Error - Errors returned by DescribeDefaultAuthorizer
- Describe
Dimension Error - Errors returned by DescribeDimension
- Describe
Domain Configuration Error - Errors returned by DescribeDomainConfiguration
- Describe
Endpoint Error - Errors returned by DescribeEndpoint
- Describe
Event Configurations Error - Errors returned by DescribeEventConfigurations
- Describe
Index Error - Errors returned by DescribeIndex
- Describe
JobError - Errors returned by DescribeJob
- Describe
JobExecution Error - Errors returned by DescribeJobExecution
- Describe
Mitigation Action Error - Errors returned by DescribeMitigationAction
- Describe
Provisioning Template Error - Errors returned by DescribeProvisioningTemplate
- Describe
Provisioning Template Version Error - Errors returned by DescribeProvisioningTemplateVersion
- Describe
Role Alias Error - Errors returned by DescribeRoleAlias
- Describe
Scheduled Audit Error - Errors returned by DescribeScheduledAudit
- Describe
Security Profile Error - Errors returned by DescribeSecurityProfile
- Describe
Stream Error - Errors returned by DescribeStream
- Describe
Thing Error - Errors returned by DescribeThing
- Describe
Thing Group Error - Errors returned by DescribeThingGroup
- Describe
Thing Registration Task Error - Errors returned by DescribeThingRegistrationTask
- Describe
Thing Type Error - Errors returned by DescribeThingType
- Detach
Policy Error - Errors returned by DetachPolicy
- Detach
Principal Policy Error - Errors returned by DetachPrincipalPolicy
- Detach
Security Profile Error - Errors returned by DetachSecurityProfile
- Detach
Thing Principal Error - Errors returned by DetachThingPrincipal
- Disable
Topic Rule Error - Errors returned by DisableTopicRule
- Enable
Topic Rule Error - Errors returned by EnableTopicRule
- GetCardinality
Error - Errors returned by GetCardinality
- GetEffective
Policies Error - Errors returned by GetEffectivePolicies
- GetIndexing
Configuration Error - Errors returned by GetIndexingConfiguration
- GetJob
Document Error - Errors returned by GetJobDocument
- GetLogging
Options Error - Errors returned by GetLoggingOptions
- GetOTA
Update Error - Errors returned by GetOTAUpdate
- GetPercentiles
Error - Errors returned by GetPercentiles
- GetPolicy
Error - Errors returned by GetPolicy
- GetPolicy
Version Error - Errors returned by GetPolicyVersion
- GetRegistration
Code Error - Errors returned by GetRegistrationCode
- GetStatistics
Error - Errors returned by GetStatistics
- GetTopic
Rule Destination Error - Errors returned by GetTopicRuleDestination
- GetTopic
Rule Error - Errors returned by GetTopicRule
- GetV2
Logging Options Error - Errors returned by GetV2LoggingOptions
- List
Active Violations Error - Errors returned by ListActiveViolations
- List
Attached Policies Error - Errors returned by ListAttachedPolicies
- List
Audit Findings Error - Errors returned by ListAuditFindings
- List
Audit Mitigation Actions Executions Error - Errors returned by ListAuditMitigationActionsExecutions
- List
Audit Mitigation Actions Tasks Error - Errors returned by ListAuditMitigationActionsTasks
- List
Audit Tasks Error - Errors returned by ListAuditTasks
- List
Authorizers Error - Errors returned by ListAuthorizers
- List
Billing Groups Error - Errors returned by ListBillingGroups
- ListCA
Certificates Error - Errors returned by ListCACertificates
- List
Certificates ByCA Error - Errors returned by ListCertificatesByCA
- List
Certificates Error - Errors returned by ListCertificates
- List
Dimensions Error - Errors returned by ListDimensions
- List
Domain Configurations Error - Errors returned by ListDomainConfigurations
- List
Indices Error - Errors returned by ListIndices
- List
JobExecutions ForJob Error - Errors returned by ListJobExecutionsForJob
- List
JobExecutions ForThing Error - Errors returned by ListJobExecutionsForThing
- List
Jobs Error - Errors returned by ListJobs
- List
Mitigation Actions Error - Errors returned by ListMitigationActions
- ListOTA
Updates Error - Errors returned by ListOTAUpdates
- List
Outgoing Certificates Error - Errors returned by ListOutgoingCertificates
- List
Policies Error - Errors returned by ListPolicies
- List
Policy Principals Error - Errors returned by ListPolicyPrincipals
- List
Policy Versions Error - Errors returned by ListPolicyVersions
- List
Principal Policies Error - Errors returned by ListPrincipalPolicies
- List
Principal Things Error - Errors returned by ListPrincipalThings
- List
Provisioning Template Versions Error - Errors returned by ListProvisioningTemplateVersions
- List
Provisioning Templates Error - Errors returned by ListProvisioningTemplates
- List
Role Aliases Error - Errors returned by ListRoleAliases
- List
Scheduled Audits Error - Errors returned by ListScheduledAudits
- List
Security Profiles Error - Errors returned by ListSecurityProfiles
- List
Security Profiles ForTarget Error - Errors returned by ListSecurityProfilesForTarget
- List
Streams Error - Errors returned by ListStreams
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Targets ForPolicy Error - Errors returned by ListTargetsForPolicy
- List
Targets ForSecurity Profile Error - Errors returned by ListTargetsForSecurityProfile
- List
Thing Groups Error - Errors returned by ListThingGroups
- List
Thing Groups ForThing Error - Errors returned by ListThingGroupsForThing
- List
Thing Principals Error - Errors returned by ListThingPrincipals
- List
Thing Registration Task Reports Error - Errors returned by ListThingRegistrationTaskReports
- List
Thing Registration Tasks Error - Errors returned by ListThingRegistrationTasks
- List
Thing Types Error - Errors returned by ListThingTypes
- List
Things Error - Errors returned by ListThings
- List
Things InBilling Group Error - Errors returned by ListThingsInBillingGroup
- List
Things InThing Group Error - Errors returned by ListThingsInThingGroup
- List
Topic Rule Destinations Error - Errors returned by ListTopicRuleDestinations
- List
Topic Rules Error - Errors returned by ListTopicRules
- List
V2Logging Levels Error - Errors returned by ListV2LoggingLevels
- List
Violation Events Error - Errors returned by ListViolationEvents
- RegisterCA
Certificate Error - Errors returned by RegisterCACertificate
- Register
Certificate Error - Errors returned by RegisterCertificate
- Register
Certificate WithoutCA Error - Errors returned by RegisterCertificateWithoutCA
- Register
Thing Error - Errors returned by RegisterThing
- Reject
Certificate Transfer Error - Errors returned by RejectCertificateTransfer
- Remove
Thing From Billing Group Error - Errors returned by RemoveThingFromBillingGroup
- Remove
Thing From Thing Group Error - Errors returned by RemoveThingFromThingGroup
- Replace
Topic Rule Error - Errors returned by ReplaceTopicRule
- Search
Index Error - Errors returned by SearchIndex
- SetDefault
Authorizer Error - Errors returned by SetDefaultAuthorizer
- SetDefault
Policy Version Error - Errors returned by SetDefaultPolicyVersion
- SetLogging
Options Error - Errors returned by SetLoggingOptions
- SetV2
Logging Level Error - Errors returned by SetV2LoggingLevel
- SetV2
Logging Options Error - Errors returned by SetV2LoggingOptions
- Start
Audit Mitigation Actions Task Error - Errors returned by StartAuditMitigationActionsTask
- Start
OnDemand Audit Task Error - Errors returned by StartOnDemandAuditTask
- Start
Thing Registration Task Error - Errors returned by StartThingRegistrationTask
- Stop
Thing Registration Task Error - Errors returned by StopThingRegistrationTask
- TagResource
Error - Errors returned by TagResource
- Test
Authorization Error - Errors returned by TestAuthorization
- Test
Invoke Authorizer Error - Errors returned by TestInvokeAuthorizer
- Transfer
Certificate Error - Errors returned by TransferCertificate
- Untag
Resource Error - Errors returned by UntagResource
- Update
Account Audit Configuration Error - Errors returned by UpdateAccountAuditConfiguration
- Update
Authorizer Error - Errors returned by UpdateAuthorizer
- Update
Billing Group Error - Errors returned by UpdateBillingGroup
- UpdateCA
Certificate Error - Errors returned by UpdateCACertificate
- Update
Certificate Error - Errors returned by UpdateCertificate
- Update
Dimension Error - Errors returned by UpdateDimension
- Update
Domain Configuration Error - Errors returned by UpdateDomainConfiguration
- Update
Dynamic Thing Group Error - Errors returned by UpdateDynamicThingGroup
- Update
Event Configurations Error - Errors returned by UpdateEventConfigurations
- Update
Indexing Configuration Error - Errors returned by UpdateIndexingConfiguration
- Update
JobError - Errors returned by UpdateJob
- Update
Mitigation Action Error - Errors returned by UpdateMitigationAction
- Update
Provisioning Template Error - Errors returned by UpdateProvisioningTemplate
- Update
Role Alias Error - Errors returned by UpdateRoleAlias
- Update
Scheduled Audit Error - Errors returned by UpdateScheduledAudit
- Update
Security Profile Error - Errors returned by UpdateSecurityProfile
- Update
Stream Error - Errors returned by UpdateStream
- Update
Thing Error - Errors returned by UpdateThing
- Update
Thing Group Error - Errors returned by UpdateThingGroup
- Update
Thing Groups ForThing Error - Errors returned by UpdateThingGroupsForThing
- Update
Topic Rule Destination Error - Errors returned by UpdateTopicRuleDestination
- Validate
Security Profile Behaviors Error - Errors returned by ValidateSecurityProfileBehaviors
Traits§
- Iot
- Trait representing the capabilities of the AWS IoT API. AWS IoT clients implement this trait.