Crate rusoto_iot
source · [−]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
The criteria that determine when and how a job abort takes place.
The criteria that determine when and how a job abort takes place.
The input for the AcceptCertificateTransfer operation.
Describes the actions associated with a rule.
Information about an active Device Defender security profile behavior violation.
Parameters used when defining a mitigation action that move a set of things to a thing group.
A structure containing the alert target ARN and the role ARN.
Contains information that allowed the authorization.
An asset property timestamp entry containing the following information.
An asset property value entry containing the following information.
Contains an asset property value (of a single type).
The input for the AttachPrincipalPolicy operation.
The input for the AttachThingPrincipal operation.
The output from the AttachThingPrincipal operation.
The attribute payload.
Which audit checks are enabled and disabled for this account.
Information about the audit check.
The findings (results) of the audit.
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.
Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
Information about the targets to which audit notifications are sent.
Filters out specific findings of a Device Defender audit.
The audits that were performed.
A collection of authorization information.
The authorizer result.
An object that specifies the authorization service for a domain.
The authorizer description.
The authorizer summary.
The criteria that determine when and how a job abort takes place.
The criteria that determine when and how a job abort takes place.
Configuration for the rollout of OTA updates.
The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
The criteria to initiate the increase in rate of rollout for a job.
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 to TIMED_OUT.
A Device Defender security profile behavior.
The criteria by which the behavior is determined to be normal.
The summary of an ML Detect behavior model.
Additional information about the billing group.
The properties of a billing group.
A CA certificate.
Describes a CA certificate.
The input for the CancelCertificateTransfer operation.
Information about a certificate.
Describes a certificate.
When the certificate is valid.
Describes an action that updates a CloudWatch alarm.
Describes an action that sends data to CloudWatch Logs.
Describes an action that captures a CloudWatch metric.
Describes the method to use when code signing a file.
Describes the certificate chain being used when code signing a file.
Describes the signature for a file.
Configuration.
The input for the CreateCertificateFromCsr operation.
The output from the CreateCertificateFromCsr operation.
The input for the CreateKeysAndCertificate operation.
The output of the CreateKeysAndCertificate operation.
The input for the CreatePolicy operation.
The output from the CreatePolicy operation.
The input for the CreatePolicyVersion operation.
The output of the CreatePolicyVersion operation.
The input for the CreateThing operation.
The output of the CreateThing operation.
The input for the CreateThingType operation.
The output of the CreateThingType operation.
The input for the CreateTopicRule operation.
Describes a custom method used to code sign a file.
Input for the DeleteCACertificate operation.
The output for the DeleteCACertificate operation.
The input for the DeleteCertificate operation.
The input for the DeletePolicy operation.
The input for the DeletePolicyVersion operation.
The input for the DeleteRegistrationCode operation.
The output for the DeleteRegistrationCode operation.
The input for the DeleteThing operation.
The output of the DeleteThing operation.
The input for the DeleteThingType operation.
The output for the DeleteThingType operation.
The input for the DeleteTopicRule operation.
Contains information that denied the authorization.
The input for the DeprecateThingType operation.
The output for the DeprecateThingType operation.
The input for the DescribeCACertificate operation.
The output from the DescribeCACertificate operation.
The input for the DescribeCertificate operation.
The output of the DescribeCertificate operation.
The input for the DescribeEndpoint operation.
The output from the DescribeEndpoint operation.
The input for the DescribeThing operation.
The output from the DescribeThing operation.
The input for the DescribeThingType operation.
The output for the DescribeThingType operation.
Describes the location of the updated firmware.
The input for the DetachPrincipalPolicy operation.
The input for the DetachThingPrincipal operation.
The output from the DetachThingPrincipal operation.
Describes which mitigation actions should be executed.
The statistics of a mitigation action task.
The summary of the mitigation action tasks.
The target of a mitigation action task.
The input for the DisableTopicRuleRequest operation.
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
Describes an action to write to a DynamoDB table.
The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.
The hashKeyValue and rangeKeyvalue fields 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()}"
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.
The policy that has the effect on the authorization results.
Describes an action that writes data to an Amazon Elasticsearch Service domain.
Parameters used when defining a mitigation action that enable AWS IoT logging.
The input for the EnableTopicRuleRequest operation.
Error information.
Information that explicitly denies authorization.
Allows you to create an exponential rate of rollout for a job.
Describes the name and data type at a field.
The location of the OTA update.
Describes an action that writes data to an Amazon Kinesis Firehose stream.
The input for the GetLoggingOptions operation.
The output from the GetLoggingOptions operation.
The input for the GetPolicy operation.
The output from the GetPolicy operation.
The input for the GetPolicyVersion operation.
The output from the GetPolicyVersion operation.
The input to the GetRegistrationCode operation.
The output from the GetRegistrationCode operation.
The input for the GetTopicRule operation.
The output from the GetTopicRule operation.
The name and ARN of a group.
Send data to an HTTPS endpoint.
The HTTP action header.
The authorization method used to send messages.
Specifies the HTTP context to use for the test authorizer request.
HTTP URL destination configuration used by the topic rule's HTTP action.
HTTP URL destination properties.
Information about an HTTP URL destination.
Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
Sends message data to an AWS IoT Analytics channel.
A client for the AWS IoT API.
Sends an input to an AWS IoT Events detector.
Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
The Job object contains details about a job.
The job execution object represents the execution of a job on a particular device.
Details of the job execution status.
The job execution summary.
Contains a summary of information about job executions for a specific job.
The job execution summary for a thing.
Allows you to create a staged rollout of a job.
The job process details.
The job summary.
An object that contains information about the job template.
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Describes a key pair.
Describes an action to write data to an Amazon Kinesis stream.
Describes an action to invoke a Lambda function.
Input for the ListCACertificates operation.
The output from the ListCACertificates operation.
The input to the ListCertificatesByCA operation.
The output of the ListCertificatesByCA operation.
The input for the ListCertificates operation.
The output of the ListCertificates operation.
The input to the ListOutgoingCertificates operation.
The output from the ListOutgoingCertificates operation.
The input for the ListPolicies operation.
The output from the ListPolicies operation.
The input for the ListPolicyPrincipals operation.
The output from the ListPolicyPrincipals operation.
The input for the ListPolicyVersions operation.
The output from the ListPolicyVersions operation.
The input for the ListPrincipalPolicies operation.
The output from the ListPrincipalPolicies operation.
The input for the ListPrincipalThings operation.
The output from the ListPrincipalThings operation.
The input for the ListThingPrincipal operation.
The output from the ListThingPrincipals operation.
The input for the ListThingTypes operation.
The output for the ListThingTypes operation.
The input for the ListThings operation.
The output from the ListThings operation.
The input for the ListTopicRules operation.
The output from the ListTopicRules operation.
A log target.
The target configuration.
Describes the logging options payload.
The configuration of an ML Detect Security Profile.
The dimension of a metric.
The metric you want to retain. Dimensions are optional.
The value to be compared with the metric.
Describes which changes should be applied as part of a mitigation action.
Information that identifies a mitigation action. This information is returned by ListMitigationActions.
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).
Specifies the MQTT context to use for the test authorizer request
Information about the resource that was noncompliant with the audit check.
Describes a file to be associated with an OTA update.
Information about an OTA update.
An OTA update summary.
A certificate that has been transferred but not yet accepted.
Describes the percentile and percentile value.
Describes an AWS IoT policy.
Describes a policy version.
Information about the version of the policy associated with the resource.
Configuration for pre-signed S3 URLs.
Structure that contains payloadVersion and targetArn.
A summary of information about a fleet provisioning template.
A summary of information about a fleet provision template version.
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.
An asset property value entry containing the following information.
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
Allows you to define a criteria to initiate the increase in rate of rollout for a job.
The input to the RegisterCACertificate operation.
The output from the RegisterCACertificateResponse operation.
The input to the RegisterCertificate operation.
The output from the RegisterCertificate operation.
The registration configuration.
The input for the RejectCertificateTransfer operation.
Information about a related resource.
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
The input for the ReplaceTopicRule operation.
Describes an action to republish to another topic.
Information that identifies the noncompliant resource.
Role alias description.
Describes an action to write data to an Amazon S3 bucket.
Describes the location of updated firmware in S3.
The S3 location.
Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
Information about the scheduled audit.
Identifying information for a Device Defender security profile.
A target to which an alert is sent when a security profile behavior is violated.
Information about a security profile and the target associated with it.
An object that contains information about a server certificate.
The input for the SetDefaultPolicyVersion operation.
The input for the SetLoggingOptions operation.
For more information, see Signature Version 4 signing process.
Describes the code-signing profile.
Describes an action to publish to an Amazon SNS topic.
Describes an action to publish data to an Amazon SQS queue.
Information required to start a signing job.
A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
A map of key-value pairs for all supported statistics. Currently, only count is supported.
Starts execution of a Step Functions state machine.
Describes a group of files that can be streamed.
Represents a file to stream.
Information about a stream.
A summary of a stream.
A set of key/value pairs that are used to manage the resource.
Statistics for the checks performed during the audit.
Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.
The properties of the thing, including thing name, thing type name, and a list of thing attributes.
The connectivity status of the thing.
The thing search index document.
The thing group search index document.
Thing group indexing configuration.
Thing group metadata.
Thing group properties.
The thing indexing configuration. For more information, see Managing Thing Indexing.
The definition of the thing type, including thing type name and description.
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.
The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
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 to TIMED_OUT.
The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.
Metadata attributes of the time series that are written in each measure record.
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
Specifies the TLS context to use for the test authorizer request.
Describes a rule.
A topic rule destination.
Configuration of the topic rule destination.
Information about the topic rule destination.
Describes a rule.
Describes a rule.
The input for the TransferCertificate operation.
The output from the TransferCertificate operation.
Data used to transfer a certificate to an AWS account.
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
The input to the UpdateCACertificate operation.
The input for the UpdateCertificate operation.
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
The input for the UpdateThing operation.
The output from the UpdateThing operation.
Information about an error found in a behavior specification.
Information about a Device Defender security profile behavior violation.
The details of a violation event.
Specifies the time period of which violation events occurred between.
The configuration information for a virtual private cloud (VPC) destination.
The properties of a virtual private cloud (VPC) destination.
The summary of a virtual private cloud (VPC) destination.
Enums
Errors returned by AcceptCertificateTransfer
Errors returned by AddThingToBillingGroup
Errors returned by AddThingToThingGroup
Errors returned by AssociateTargetsWithJob
Errors returned by AttachPolicy
Errors returned by AttachPrincipalPolicy
Errors returned by AttachSecurityProfile
Errors returned by AttachThingPrincipal
Errors returned by CancelAuditMitigationActionsTask
Errors returned by CancelAuditTask
Errors returned by CancelCertificateTransfer
Errors returned by CancelDetectMitigationActionsTask
Errors returned by CancelJob
Errors returned by CancelJobExecution
Errors returned by ClearDefaultAuthorizer
Errors returned by ConfirmTopicRuleDestination
Errors returned by CreateAuditSuppression
Errors returned by CreateAuthorizer
Errors returned by CreateBillingGroup
Errors returned by CreateCertificateFromCsr
Errors returned by CreateCustomMetric
Errors returned by CreateDimension
Errors returned by CreateDomainConfiguration
Errors returned by CreateDynamicThingGroup
Errors returned by CreateJob
Errors returned by CreateJobTemplate
Errors returned by CreateKeysAndCertificate
Errors returned by CreateMitigationAction
Errors returned by CreateOTAUpdate
Errors returned by CreatePolicy
Errors returned by CreatePolicyVersion
Errors returned by CreateProvisioningClaim
Errors returned by CreateProvisioningTemplate
Errors returned by CreateProvisioningTemplateVersion
Errors returned by CreateRoleAlias
Errors returned by CreateScheduledAudit
Errors returned by CreateSecurityProfile
Errors returned by CreateStream
Errors returned by CreateThing
Errors returned by CreateThingGroup
Errors returned by CreateThingType
Errors returned by CreateTopicRuleDestination
Errors returned by CreateTopicRule
Errors returned by DeleteAccountAuditConfiguration
Errors returned by DeleteAuditSuppression
Errors returned by DeleteAuthorizer
Errors returned by DeleteBillingGroup
Errors returned by DeleteCACertificate
Errors returned by DeleteCertificate
Errors returned by DeleteCustomMetric
Errors returned by DeleteDimension
Errors returned by DeleteDomainConfiguration
Errors returned by DeleteDynamicThingGroup
Errors returned by DeleteJob
Errors returned by DeleteJobExecution
Errors returned by DeleteJobTemplate
Errors returned by DeleteMitigationAction
Errors returned by DeleteOTAUpdate
Errors returned by DeletePolicy
Errors returned by DeletePolicyVersion
Errors returned by DeleteProvisioningTemplate
Errors returned by DeleteProvisioningTemplateVersion
Errors returned by DeleteRegistrationCode
Errors returned by DeleteRoleAlias
Errors returned by DeleteScheduledAudit
Errors returned by DeleteSecurityProfile
Errors returned by DeleteStream
Errors returned by DeleteThing
Errors returned by DeleteThingGroup
Errors returned by DeleteThingType
Errors returned by DeleteTopicRuleDestination
Errors returned by DeleteTopicRule
Errors returned by DeleteV2LoggingLevel
Errors returned by DeprecateThingType
Errors returned by DescribeAccountAuditConfiguration
Errors returned by DescribeAuditFinding
Errors returned by DescribeAuditMitigationActionsTask
Errors returned by DescribeAuditSuppression
Errors returned by DescribeAuditTask
Errors returned by DescribeAuthorizer
Errors returned by DescribeBillingGroup
Errors returned by DescribeCACertificate
Errors returned by DescribeCertificate
Errors returned by DescribeCustomMetric
Errors returned by DescribeDefaultAuthorizer
Errors returned by DescribeDetectMitigationActionsTask
Errors returned by DescribeDimension
Errors returned by DescribeDomainConfiguration
Errors returned by DescribeEndpoint
Errors returned by DescribeEventConfigurations
Errors returned by DescribeIndex
Errors returned by DescribeJob
Errors returned by DescribeJobExecution
Errors returned by DescribeJobTemplate
Errors returned by DescribeMitigationAction
Errors returned by DescribeProvisioningTemplate
Errors returned by DescribeProvisioningTemplateVersion
Errors returned by DescribeRoleAlias
Errors returned by DescribeScheduledAudit
Errors returned by DescribeSecurityProfile
Errors returned by DescribeStream
Errors returned by DescribeThing
Errors returned by DescribeThingGroup
Errors returned by DescribeThingRegistrationTask
Errors returned by DescribeThingType
Errors returned by DetachPolicy
Errors returned by DetachPrincipalPolicy
Errors returned by DetachSecurityProfile
Errors returned by DetachThingPrincipal
Errors returned by DisableTopicRule
Errors returned by EnableTopicRule
Errors returned by GetBehaviorModelTrainingSummaries
Errors returned by GetCardinality
Errors returned by GetEffectivePolicies
Errors returned by GetIndexingConfiguration
Errors returned by GetJobDocument
Errors returned by GetLoggingOptions
Errors returned by GetOTAUpdate
Errors returned by GetPercentiles
Errors returned by GetPolicy
Errors returned by GetPolicyVersion
Errors returned by GetRegistrationCode
Errors returned by GetStatistics
Errors returned by GetTopicRuleDestination
Errors returned by GetTopicRule
Errors returned by GetV2LoggingOptions
Errors returned by ListActiveViolations
Errors returned by ListAttachedPolicies
Errors returned by ListAuditFindings
Errors returned by ListAuditMitigationActionsExecutions
Errors returned by ListAuditMitigationActionsTasks
Errors returned by ListAuditSuppressions
Errors returned by ListAuditTasks
Errors returned by ListAuthorizers
Errors returned by ListBillingGroups
Errors returned by ListCACertificates
Errors returned by ListCertificatesByCA
Errors returned by ListCertificates
Errors returned by ListCustomMetrics
Errors returned by ListDetectMitigationActionsExecutions
Errors returned by ListDetectMitigationActionsTasks
Errors returned by ListDimensions
Errors returned by ListDomainConfigurations
Errors returned by ListIndices
Errors returned by ListJobExecutionsForJob
Errors returned by ListJobExecutionsForThing
Errors returned by ListJobTemplates
Errors returned by ListJobs
Errors returned by ListMitigationActions
Errors returned by ListOTAUpdates
Errors returned by ListOutgoingCertificates
Errors returned by ListPolicies
Errors returned by ListPolicyPrincipals
Errors returned by ListPolicyVersions
Errors returned by ListPrincipalPolicies
Errors returned by ListPrincipalThings
Errors returned by ListProvisioningTemplateVersions
Errors returned by ListProvisioningTemplates
Errors returned by ListRoleAliases
Errors returned by ListScheduledAudits
Errors returned by ListSecurityProfiles
Errors returned by ListSecurityProfilesForTarget
Errors returned by ListStreams
Errors returned by ListTagsForResource
Errors returned by ListTargetsForPolicy
Errors returned by ListTargetsForSecurityProfile
Errors returned by ListThingGroups
Errors returned by ListThingGroupsForThing
Errors returned by ListThingPrincipals
Errors returned by ListThingRegistrationTaskReports
Errors returned by ListThingRegistrationTasks
Errors returned by ListThingTypes
Errors returned by ListThings
Errors returned by ListThingsInBillingGroup
Errors returned by ListThingsInThingGroup
Errors returned by ListTopicRuleDestinations
Errors returned by ListTopicRules
Errors returned by ListV2LoggingLevels
Errors returned by ListViolationEvents
Errors returned by RegisterCACertificate
Errors returned by RegisterCertificate
Errors returned by RegisterCertificateWithoutCA
Errors returned by RegisterThing
Errors returned by RejectCertificateTransfer
Errors returned by RemoveThingFromBillingGroup
Errors returned by RemoveThingFromThingGroup
Errors returned by ReplaceTopicRule
Errors returned by SearchIndex
Errors returned by SetDefaultAuthorizer
Errors returned by SetDefaultPolicyVersion
Errors returned by SetLoggingOptions
Errors returned by SetV2LoggingLevel
Errors returned by SetV2LoggingOptions
Errors returned by StartAuditMitigationActionsTask
Errors returned by StartDetectMitigationActionsTask
Errors returned by StartOnDemandAuditTask
Errors returned by StartThingRegistrationTask
Errors returned by StopThingRegistrationTask
Errors returned by TagResource
Errors returned by TestAuthorization
Errors returned by TestInvokeAuthorizer
Errors returned by TransferCertificate
Errors returned by UntagResource
Errors returned by UpdateAccountAuditConfiguration
Errors returned by UpdateAuditSuppression
Errors returned by UpdateAuthorizer
Errors returned by UpdateBillingGroup
Errors returned by UpdateCACertificate
Errors returned by UpdateCertificate
Errors returned by UpdateCustomMetric
Errors returned by UpdateDimension
Errors returned by UpdateDomainConfiguration
Errors returned by UpdateDynamicThingGroup
Errors returned by UpdateEventConfigurations
Errors returned by UpdateIndexingConfiguration
Errors returned by UpdateJob
Errors returned by UpdateMitigationAction
Errors returned by UpdateProvisioningTemplate
Errors returned by UpdateRoleAlias
Errors returned by UpdateScheduledAudit
Errors returned by UpdateSecurityProfile
Errors returned by UpdateStream
Errors returned by UpdateThing
Errors returned by UpdateThingGroup
Errors returned by UpdateThingGroupsForThing
Errors returned by UpdateTopicRuleDestination
Errors returned by ValidateSecurityProfileBehaviors
Traits
Trait representing the capabilities of the AWS IoT API. AWS IoT clients implement this trait.