# Packages
Package iotiface provides an interface to enable mocking the AWS IoT service client for testing your code.
# Functions
New creates a new instance of the IoT client with a session.
# Constants
AbortActionCancel is a AbortAction enum value.
ActionTypeConnect is a ActionType enum value.
ActionTypePublish is a ActionType enum value.
ActionTypeReceive is a ActionType enum value.
ActionTypeSubscribe is a ActionType enum value.
AlertTargetTypeSns is a AlertTargetType enum value.
AuditCheckRunStatusCanceled is a AuditCheckRunStatus enum value.
AuditCheckRunStatusCompletedCompliant is a AuditCheckRunStatus enum value.
AuditCheckRunStatusCompletedNonCompliant is a AuditCheckRunStatus enum value.
AuditCheckRunStatusFailed is a AuditCheckRunStatus enum value.
AuditCheckRunStatusInProgress is a AuditCheckRunStatus enum value.
AuditCheckRunStatusWaitingForDataCollection is a AuditCheckRunStatus enum value.
AuditFindingSeverityCritical is a AuditFindingSeverity enum value.
AuditFindingSeverityHigh is a AuditFindingSeverity enum value.
AuditFindingSeverityLow is a AuditFindingSeverity enum value.
AuditFindingSeverityMedium is a AuditFindingSeverity enum value.
AuditFrequencyBiweekly is a AuditFrequency enum value.
AuditFrequencyDaily is a AuditFrequency enum value.
AuditFrequencyMonthly is a AuditFrequency enum value.
AuditFrequencyWeekly is a AuditFrequency enum value.
AuditNotificationTypeSns is a AuditNotificationType enum value.
AuditTaskStatusCanceled is a AuditTaskStatus enum value.
AuditTaskStatusCompleted is a AuditTaskStatus enum value.
AuditTaskStatusFailed is a AuditTaskStatus enum value.
AuditTaskStatusInProgress is a AuditTaskStatus enum value.
AuditTaskTypeOnDemandAuditTask is a AuditTaskType enum value.
AuditTaskTypeScheduledAuditTask is a AuditTaskType enum value.
AuthDecisionAllowed is a AuthDecision enum value.
AuthDecisionExplicitDeny is a AuthDecision enum value.
AuthDecisionImplicitDeny is a AuthDecision enum value.
AuthorizerStatusActive is a AuthorizerStatus enum value.
AuthorizerStatusInactive is a AuthorizerStatus enum value.
AutoRegistrationStatusDisable is a AutoRegistrationStatus enum value.
AutoRegistrationStatusEnable is a AutoRegistrationStatus enum value.
CACertificateStatusActive is a CACertificateStatus enum value.
CACertificateStatusInactive is a CACertificateStatus enum value.
CannedAccessControlListAuthenticatedRead is a CannedAccessControlList enum value.
CannedAccessControlListAwsExecRead is a CannedAccessControlList enum value.
CannedAccessControlListBucketOwnerFullControl is a CannedAccessControlList enum value.
CannedAccessControlListBucketOwnerRead is a CannedAccessControlList enum value.
CannedAccessControlListLogDeliveryWrite is a CannedAccessControlList enum value.
CannedAccessControlListPrivate is a CannedAccessControlList enum value.
CannedAccessControlListPublicRead is a CannedAccessControlList enum value.
CannedAccessControlListPublicReadWrite is a CannedAccessControlList enum value.
CertificateStatusActive is a CertificateStatus enum value.
CertificateStatusInactive is a CertificateStatus enum value.
CertificateStatusPendingActivation is a CertificateStatus enum value.
CertificateStatusPendingTransfer is a CertificateStatus enum value.
CertificateStatusRegisterInactive is a CertificateStatus enum value.
CertificateStatusRevoked is a CertificateStatus enum value.
ComparisonOperatorGreaterThan is a ComparisonOperator enum value.
ComparisonOperatorGreaterThanEquals is a ComparisonOperator enum value.
ComparisonOperatorInCidrSet is a ComparisonOperator enum value.
ComparisonOperatorInPortSet is a ComparisonOperator enum value.
ComparisonOperatorLessThan is a ComparisonOperator enum value.
ComparisonOperatorLessThanEquals is a ComparisonOperator enum value.
ComparisonOperatorNotInCidrSet is a ComparisonOperator enum value.
ComparisonOperatorNotInPortSet is a ComparisonOperator enum value.
DayOfWeekFri is a DayOfWeek enum value.
DayOfWeekMon is a DayOfWeek enum value.
DayOfWeekSat is a DayOfWeek enum value.
DayOfWeekSun is a DayOfWeek enum value.
DayOfWeekThu is a DayOfWeek enum value.
DayOfWeekTue is a DayOfWeek enum value.
DayOfWeekWed is a DayOfWeek enum value.
DynamicGroupStatusActive is a DynamicGroupStatus enum value.
DynamicGroupStatusBuilding is a DynamicGroupStatus enum value.
DynamicGroupStatusRebuilding is a DynamicGroupStatus enum value.
DynamoKeyTypeNumber is a DynamoKeyType enum value.
DynamoKeyTypeString is a DynamoKeyType enum value.
ID to lookup a service endpoint with.
ErrCodeCertificateConflictException for service response error code "CertificateConflictException".
ErrCodeCertificateStateException for service response error code "CertificateStateException".
ErrCodeCertificateValidationException for service response error code "CertificateValidationException".
ErrCodeConflictingResourceUpdateException for service response error code "ConflictingResourceUpdateException".
ErrCodeDeleteConflictException for service response error code "DeleteConflictException".
ErrCodeIndexNotReadyException for service response error code "IndexNotReadyException".
ErrCodeInternalException for service response error code "InternalException".
ErrCodeInternalFailureException for service response error code "InternalFailureException".
ErrCodeInvalidAggregationException for service response error code "InvalidAggregationException".
ErrCodeInvalidQueryException for service response error code "InvalidQueryException".
ErrCodeInvalidRequestException for service response error code "InvalidRequestException".
ErrCodeInvalidResponseException for service response error code "InvalidResponseException".
ErrCodeInvalidStateTransitionException for service response error code "InvalidStateTransitionException".
ErrCodeLimitExceededException for service response error code "LimitExceededException".
ErrCodeMalformedPolicyException for service response error code "MalformedPolicyException".
ErrCodeNotConfiguredException for service response error code "NotConfiguredException".
ErrCodeRegistrationCodeValidationException for service response error code "RegistrationCodeValidationException".
ErrCodeResourceAlreadyExistsException for service response error code "ResourceAlreadyExistsException".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeResourceRegistrationFailureException for service response error code "ResourceRegistrationFailureException".
ErrCodeServiceUnavailableException for service response error code "ServiceUnavailableException".
ErrCodeSqlParseException for service response error code "SqlParseException".
ErrCodeThrottlingException for service response error code "ThrottlingException".
ErrCodeTransferAlreadyCompletedException for service response error code "TransferAlreadyCompletedException".
ErrCodeTransferConflictException for service response error code "TransferConflictException".
ErrCodeUnauthorizedException for service response error code "UnauthorizedException".
ErrCodeVersionConflictException for service response error code "VersionConflictException".
ErrCodeVersionsLimitExceededException for service response error code "VersionsLimitExceededException".
EventTypeCaCertificate is a EventType enum value.
EventTypeCertificate is a EventType enum value.
EventTypeJob is a EventType enum value.
EventTypeJobExecution is a EventType enum value.
EventTypePolicy is a EventType enum value.
EventTypeThing is a EventType enum value.
EventTypeThingGroup is a EventType enum value.
EventTypeThingGroupHierarchy is a EventType enum value.
EventTypeThingGroupMembership is a EventType enum value.
EventTypeThingType is a EventType enum value.
EventTypeThingTypeAssociation is a EventType enum value.
IndexStatusActive is a IndexStatus enum value.
IndexStatusBuilding is a IndexStatus enum value.
IndexStatusRebuilding is a IndexStatus enum value.
JobExecutionFailureTypeAll is a JobExecutionFailureType enum value.
JobExecutionFailureTypeFailed is a JobExecutionFailureType enum value.
JobExecutionFailureTypeRejected is a JobExecutionFailureType enum value.
JobExecutionFailureTypeTimedOut is a JobExecutionFailureType enum value.
JobExecutionStatusCanceled is a JobExecutionStatus enum value.
JobExecutionStatusFailed is a JobExecutionStatus enum value.
JobExecutionStatusInProgress is a JobExecutionStatus enum value.
JobExecutionStatusQueued is a JobExecutionStatus enum value.
JobExecutionStatusRejected is a JobExecutionStatus enum value.
JobExecutionStatusRemoved is a JobExecutionStatus enum value.
JobExecutionStatusSucceeded is a JobExecutionStatus enum value.
JobExecutionStatusTimedOut is a JobExecutionStatus enum value.
JobStatusCanceled is a JobStatus enum value.
JobStatusCompleted is a JobStatus enum value.
JobStatusDeletionInProgress is a JobStatus enum value.
JobStatusInProgress is a JobStatus enum value.
LogLevelDebug is a LogLevel enum value.
LogLevelDisabled is a LogLevel enum value.
LogLevelError is a LogLevel enum value.
LogLevelInfo is a LogLevel enum value.
LogLevelWarn is a LogLevel enum value.
LogTargetTypeDefault is a LogTargetType enum value.
LogTargetTypeThingGroup is a LogTargetType enum value.
MessageFormatJson is a MessageFormat enum value.
MessageFormatRaw is a MessageFormat enum value.
OTAUpdateStatusCreateComplete is a OTAUpdateStatus enum value.
OTAUpdateStatusCreateFailed is a OTAUpdateStatus enum value.
OTAUpdateStatusCreateInProgress is a OTAUpdateStatus enum value.
OTAUpdateStatusCreatePending is a OTAUpdateStatus enum value.
ReportTypeErrors is a ReportType enum value.
ReportTypeResults is a ReportType enum value.
ResourceTypeAccountSettings is a ResourceType enum value.
ResourceTypeCaCertificate is a ResourceType enum value.
ResourceTypeClientId is a ResourceType enum value.
ResourceTypeCognitoIdentityPool is a ResourceType enum value.
ResourceTypeDeviceCertificate is a ResourceType enum value.
ResourceTypeIotPolicy is a ResourceType enum value.
ServiceID is a unique identifer of a specific service.
Name of service.
StatusCancelled is a Status enum value.
StatusCancelling is a Status enum value.
StatusCompleted is a Status enum value.
StatusFailed is a Status enum value.
StatusInProgress is a Status enum value.
TargetSelectionContinuous is a TargetSelection enum value.
TargetSelectionSnapshot is a TargetSelection enum value.
ThingConnectivityIndexingModeOff is a ThingConnectivityIndexingMode enum value.
ThingConnectivityIndexingModeStatus is a ThingConnectivityIndexingMode enum value.
ThingGroupIndexingModeOff is a ThingGroupIndexingMode enum value.
ThingGroupIndexingModeOn is a ThingGroupIndexingMode enum value.
ThingIndexingModeOff is a ThingIndexingMode enum value.
ThingIndexingModeRegistry is a ThingIndexingMode enum value.
ThingIndexingModeRegistryAndShadow is a ThingIndexingMode enum value.
ViolationEventTypeAlarmCleared is a ViolationEventType enum value.
ViolationEventTypeAlarmInvalidated is a ViolationEventType enum value.
ViolationEventTypeInAlarm is a ViolationEventType enum value.
# Structs
Details of abort criteria to abort the job.
Details of abort criteria to define rules to abort the job.
The input for the AcceptCertificateTransfer operation.
No description provided by the author
Describes the actions associated with a rule.
Information about an active Device Defender security profile behavior violation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A structure containing the alert target ARN and the role ARN.
Contains information that allowed the authorization.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the AttachPrincipalPolicy operation.
No description provided by the author
No description provided by the author
No description provided by the author
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.
Information about the targets to which audit notifications are sent.
The audits that were performed.
A collection of authorization information.
The authorizer description.
The authorizer summary.
The authorizer result.
Configuration for the rollout of OTA updates.
A Device Defender security profile behavior.
The criteria by which the behavior is determined to be normal.
Additional information about the billing group.
The properties of a billing group.
A CA certificate.
Describes a CA certificate.
No description provided by the author
No description provided by the author
The input for the CancelCertificateTransfer operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Information about a certificate.
Describes a certificate.
When the certificate is valid.
No description provided by the author
No description provided by the author
Describes an action that updates a CloudWatch alarm.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the CreateCertificateFromCsr operation.
The output from the CreateCertificateFromCsr operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the CreateKeysAndCertificate operation.
The output of the CreateKeysAndCertificate operation.
No description provided by the author
No description provided by the author
The input for the CreatePolicy operation.
The output from the CreatePolicy operation.
The input for the CreatePolicyVersion operation.
The output of the CreatePolicyVersion operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
Describes a custom method used to code sign a file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Input for the DeleteCACertificate operation.
The output for the DeleteCACertificate operation.
The input for the DeleteCertificate operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the DeletePolicy operation.
No description provided by the author
The input for the DeletePolicyVersion operation.
No description provided by the author
The input for the DeleteRegistrationCode operation.
The output for the DeleteRegistrationCode operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
Contains information that denied the authorization.
The input for the DeprecateThingType operation.
The output for the DeprecateThingType operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the DescribeCACertificate operation.
The output from the DescribeCACertificate operation.
The input for the DescribeCertificate operation.
The output of the DescribeCertificate operation.
No description provided by the author
No description provided by the author
The input for the DescribeEndpoint operation.
The output from the DescribeEndpoint operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the DescribeThing operation.
The output from the DescribeThing operation.
No description provided by the author
No description provided by the author
The input for the DescribeThingType operation.
The output for the DescribeThingType operation.
Describes the location of the updated firmware.
No description provided by the author
No description provided by the author
The input for the DetachPrincipalPolicy operation.
No description provided by the author
No description provided by the author
No description provided by the author
The input for the DetachThingPrincipal operation.
The output from the DetachThingPrincipal operation.
The input for the DisableTopicRuleRequest operation.
No description provided by the author
Describes an action to write to a DynamoDB table.
Describes an action to write to a DynamoDB table.
The policy that has the effect on the authorization results.
Describes an action that writes data to an Amazon Elasticsearch Service domain.
The input for the EnableTopicRuleRequest operation.
No description provided by the author
Error information.
Information that explicitly denies authorization.
Allows you to create an exponential rate of rollout for a job.
The location of the OTA update.
Describes an action that writes data to an Amazon Kinesis Firehose stream.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the GetLoggingOptions operation.
The output from the GetLoggingOptions operation.
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
The input for the GetTopicRule operation.
The output from the GetTopicRule operation.
No description provided by the author
No description provided by the author
The name and ARN of a group.
Information that implicitly denies authorization.
IoT provides the API operation methods for making requests to AWS IoT.
Sends messge data to an AWS IoT Analytics channel.
Sends an input to an AWS IoT Events detector.
The Job object contains details about a job.
The job execution object represents the execution of a job on a particular device.
Allows you to create a staged rollout of a job.
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.
The job process details.
The job summary.
Describes a key pair.
Describes an action to write data to an Amazon Kinesis stream.
Describes an action to invoke a Lambda function.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the ListThingPrincipal operation.
The output from the ListThingPrincipals operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the ListThings operation.
No description provided by the author
No description provided by the author
The output from the ListThings operation.
The input for the ListThingTypes operation.
The output for the ListThingTypes operation.
The input for the ListTopicRules operation.
The output from the ListTopicRules operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Describes the logging options payload.
A log target.
The target configuration.
The value to be compared with the metric.
Information about the resource that was non-compliant 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 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.
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.
No description provided by the author
No description provided by the author
The registration configuration.
The input for the RejectCertificateTransfer operation.
No description provided by the author
Information about a related resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the ReplaceTopicRule operation.
No description provided by the author
Describes an action to republish to another topic.
Information identifying the non-compliant 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.
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
The input for the SetDefaultPolicyVersion operation.
No description provided by the author
The input for the SetLoggingOptions operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
Information required to start a signing job.
No description provided by the author
No description provided by the author
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.
A map of key-value pairs for all supported statistics.
Starts execution of a Step Functions state machine.
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
Statistics for the checks performed during the audit.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
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.
Describes a rule.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input to the UpdateCACertificate operation.
No description provided by the author
The input for the UpdateCertificate operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for the UpdateThing operation.
The output from the UpdateThing operation.
No description provided by the author
No description provided by the author
Information about an error found in a behavior specification.
Information about a Device Defender security profile behavior violation.