Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";

§Classes

Iot

§Interfaces

AbortConfig

The criteria that determine when and how a job abort takes place.

AbortCriteria

The criteria that determine when and how a job abort takes place.

AcceptCertificateTransferRequest

The input for the AcceptCertificateTransfer operation.

Action

Describes the actions associated with a rule.

ActiveViolation

Information about an active Device Defender security profile behavior violation.

AddThingsToThingGroupParams

Parameters used when defining a mitigation action that move a set of things to a thing group.

AddThingToBillingGroupRequest
AddThingToThingGroupRequest
AggregationType

The type of aggregation queries.

AlertTarget

A structure containing the alert target ARN and the role ARN.

Allowed

Contains information that allowed the authorization.

AssetPropertyTimestamp

An asset property timestamp entry containing the following information.

AssetPropertyValue

An asset property value entry containing the following information.

AssetPropertyVariant

Contains an asset property value (of a single type).

AssociateTargetsWithJobRequest
AssociateTargetsWithJobResponse
AttachPolicyRequest
AttachPrincipalPolicyRequest

The input for the AttachPrincipalPolicy operation.

AttachSecurityProfileRequest
AttachThingPrincipalRequest

The input for the AttachThingPrincipal operation.

AttributePayload

The attribute payload.

AuditCheckConfiguration

Which audit checks are enabled and disabled for this account.

AuditCheckDetails

Information about the audit check.

AuditFinding

The findings (results) of the audit.

AuditMitigationActionExecutionMetadata

Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

AuditMitigationActionsTaskMetadata

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.

AuditMitigationActionsTaskTarget

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

AuditNotificationTarget

Information about the targets to which audit notifications are sent.

AuditSuppression

Filters out specific findings of a Device Defender audit.

AuditTaskMetadata

The audits that were performed.

AuthInfo

A collection of authorization information.

AuthorizerConfig

An object that specifies the authorization service for a domain.

AuthorizerDescription

The authorizer description.

AuthorizerSummary

The authorizer summary.

AuthResult

The authorizer result.

AwsJobAbortConfig

The criteria that determine when and how a job abort takes place.

AwsJobAbortCriteria

The criteria that determine when and how a job abort takes place.

AwsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

AwsJobExponentialRolloutRate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

AwsJobPresignedUrlConfig

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

AwsJobRateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

AwsJobTimeoutConfig

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.

Behavior

A Device Defender security profile behavior.

BehaviorCriteria

The criteria by which the behavior is determined to be normal.

BehaviorModelTrainingSummary

The summary of an ML Detect behavior model.

BillingGroupMetadata

Additional information about the billing group.

BillingGroupProperties

The properties of a billing group.

Bucket

A count of documents that meets a specific aggregation criteria.

BucketsAggregationType

The type of bucketed aggregation performed.

CACertificate

A CA certificate.

CACertificateDescription

Describes a CA certificate.

CancelAuditMitigationActionsTaskRequest
CancelAuditTaskRequest
CancelCertificateTransferRequest

The input for the CancelCertificateTransfer operation.

CancelDetectMitigationActionsTaskRequest
CancelJobExecutionRequest
CancelJobRequest
CancelJobResponse
Certificate

Information about a certificate.

CertificateDescription

Describes a certificate.

CertificateValidity

When the certificate is valid.

CloudwatchAlarmAction

Describes an action that updates a CloudWatch alarm.

CloudwatchLogsAction

Describes an action that sends data to CloudWatch Logs.

CloudwatchMetricAction

Describes an action that captures a CloudWatch metric.

CodeSigning

Describes the method to use when code signing a file.

CodeSigningCertificateChain

Describes the certificate chain being used when code signing a file.

CodeSigningSignature

Describes the signature for a file.

Configuration

Configuration.

ConfirmTopicRuleDestinationRequest
CreateAuditSuppressionRequest
CreateAuthorizerRequest
CreateAuthorizerResponse
CreateBillingGroupRequest
CreateBillingGroupResponse
CreateCertificateFromCsrRequest

The input for the CreateCertificateFromCsr operation.

CreateCertificateFromCsrResponse

The output from the CreateCertificateFromCsr operation.

CreateCustomMetricRequest
CreateCustomMetricResponse
CreateDimensionRequest
CreateDimensionResponse
CreateDomainConfigurationRequest
CreateDomainConfigurationResponse
CreateDynamicThingGroupRequest
CreateDynamicThingGroupResponse
CreateFleetMetricRequest
CreateFleetMetricResponse
CreateJobRequest
CreateJobResponse
CreateJobTemplateRequest
CreateJobTemplateResponse
CreateKeysAndCertificateRequest

The input for the CreateKeysAndCertificate operation.

CreateKeysAndCertificateResponse

The output of the CreateKeysAndCertificate operation.

CreateMitigationActionRequest
CreateMitigationActionResponse
CreateOTAUpdateRequest
CreateOTAUpdateResponse
CreatePolicyRequest

The input for the CreatePolicy operation.

CreatePolicyResponse

The output from the CreatePolicy operation.

CreatePolicyVersionRequest

The input for the CreatePolicyVersion operation.

CreatePolicyVersionResponse

The output of the CreatePolicyVersion operation.

CreateProvisioningClaimRequest
CreateProvisioningClaimResponse
CreateProvisioningTemplateRequest
CreateProvisioningTemplateResponse
CreateProvisioningTemplateVersionRequest
CreateProvisioningTemplateVersionResponse
CreateRoleAliasRequest
CreateRoleAliasResponse
CreateScheduledAuditRequest
CreateScheduledAuditResponse
CreateSecurityProfileRequest
CreateSecurityProfileResponse
CreateStreamRequest
CreateStreamResponse
CreateThingGroupRequest
CreateThingGroupResponse
CreateThingRequest

The input for the CreateThing operation.

CreateThingResponse

The output of the CreateThing operation.

CreateThingTypeRequest

The input for the CreateThingType operation.

CreateThingTypeResponse

The output of the CreateThingType operation.

CreateTopicRuleDestinationRequest
CreateTopicRuleDestinationResponse
CreateTopicRuleRequest

The input for the CreateTopicRule operation.

CustomCodeSigning

Describes a custom method used to code sign a file.

DeleteAccountAuditConfigurationRequest
DeleteAuditSuppressionRequest
DeleteAuthorizerRequest
DeleteBillingGroupRequest
DeleteCACertificateRequest

Input for the DeleteCACertificate operation.

DeleteCertificateRequest

The input for the DeleteCertificate operation.

DeleteCustomMetricRequest
DeleteDimensionRequest
DeleteDomainConfigurationRequest
DeleteDynamicThingGroupRequest
DeleteFleetMetricRequest
DeleteJobExecutionRequest
DeleteJobRequest
DeleteJobTemplateRequest
DeleteMitigationActionRequest
DeleteOTAUpdateRequest
DeletePolicyRequest

The input for the DeletePolicy operation.

DeletePolicyVersionRequest

The input for the DeletePolicyVersion operation.

DeleteProvisioningTemplateRequest
DeleteProvisioningTemplateVersionRequest
DeleteRoleAliasRequest
DeleteScheduledAuditRequest
DeleteSecurityProfileRequest
DeleteStreamRequest
DeleteThingGroupRequest
DeleteThingRequest

The input for the DeleteThing operation.

DeleteThingTypeRequest

The input for the DeleteThingType operation.

DeleteTopicRuleDestinationRequest
DeleteTopicRuleRequest

The input for the DeleteTopicRule operation.

DeleteV2LoggingLevelRequest
Denied

Contains information that denied the authorization.

DeprecateThingTypeRequest

The input for the DeprecateThingType operation.

DescribeAccountAuditConfigurationResponse
DescribeAuditFindingRequest
DescribeAuditFindingResponse
DescribeAuditMitigationActionsTaskRequest
DescribeAuditMitigationActionsTaskResponse
DescribeAuditSuppressionRequest
DescribeAuditSuppressionResponse
DescribeAuditTaskRequest
DescribeAuditTaskResponse
DescribeAuthorizerRequest
DescribeAuthorizerResponse
DescribeBillingGroupRequest
DescribeBillingGroupResponse
DescribeCACertificateRequest

The input for the DescribeCACertificate operation.

DescribeCACertificateResponse

The output from the DescribeCACertificate operation.

DescribeCertificateRequest

The input for the DescribeCertificate operation.

DescribeCertificateResponse

The output of the DescribeCertificate operation.

DescribeCustomMetricRequest
DescribeCustomMetricResponse
DescribeDefaultAuthorizerResponse
DescribeDetectMitigationActionsTaskRequest
DescribeDetectMitigationActionsTaskResponse
DescribeDimensionRequest
DescribeDimensionResponse
DescribeDomainConfigurationRequest
DescribeDomainConfigurationResponse
DescribeEndpointRequest

The input for the DescribeEndpoint operation.

DescribeEndpointResponse

The output from the DescribeEndpoint operation.

DescribeEventConfigurationsResponse
DescribeFleetMetricRequest
DescribeFleetMetricResponse
DescribeIndexRequest
DescribeIndexResponse
DescribeJobExecutionRequest
DescribeJobExecutionResponse
DescribeJobRequest
DescribeJobResponse
DescribeJobTemplateRequest
DescribeJobTemplateResponse
DescribeManagedJobTemplateRequest
DescribeManagedJobTemplateResponse
DescribeMitigationActionRequest
DescribeMitigationActionResponse
DescribeProvisioningTemplateRequest
DescribeProvisioningTemplateResponse
DescribeProvisioningTemplateVersionRequest
DescribeProvisioningTemplateVersionResponse
DescribeRoleAliasRequest
DescribeRoleAliasResponse
DescribeScheduledAuditRequest
DescribeScheduledAuditResponse
DescribeSecurityProfileRequest
DescribeSecurityProfileResponse
DescribeStreamRequest
DescribeStreamResponse
DescribeThingGroupRequest
DescribeThingGroupResponse
DescribeThingRegistrationTaskRequest
DescribeThingRegistrationTaskResponse
DescribeThingRequest

The input for the DescribeThing operation.

DescribeThingResponse

The output from the DescribeThing operation.

DescribeThingTypeRequest

The input for the DescribeThingType operation.

DescribeThingTypeResponse

The output for the DescribeThingType operation.

Destination

Describes the location of the updated firmware.

DetachPolicyRequest
DetachPrincipalPolicyRequest

The input for the DetachPrincipalPolicy operation.

DetachSecurityProfileRequest
DetachThingPrincipalRequest

The input for the DetachThingPrincipal operation.

DetectMitigationActionExecution

Describes which mitigation actions should be executed.

DetectMitigationActionsTaskStatistics

The statistics of a mitigation action task.

DetectMitigationActionsTaskSummary

The summary of the mitigation action tasks.

DetectMitigationActionsTaskTarget

The target of a mitigation action task.

DisableTopicRuleRequest

The input for the DisableTopicRuleRequest operation.

DocumentParameter

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

DomainConfigurationSummary

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 Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

DynamoDBAction

Describes an action to write to a DynamoDB table.

DynamoDBv2Action

Describes an action to write to a DynamoDB table.

EffectivePolicy

The policy that has the effect on the authorization results.

ElasticsearchAction

Describes an action that writes data to an Amazon OpenSearch Service domain.

EnableIoTLoggingParams

Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.

EnableTopicRuleRequest

The input for the EnableTopicRuleRequest operation.

ErrorInfo

Error information.

ExplicitDeny

Information that explicitly denies authorization.

ExponentialRolloutRate

Allows you to create an exponential rate of rollout for a job.

Field

Describes the name and data type at a field.

FileLocation

The location of the OTA update.

FirehoseAction

Describes an action that writes data to an Amazon Kinesis Firehose stream.

FleetMetricNameAndArn

The name and ARN of a fleet metric.

GetBehaviorModelTrainingSummariesRequest
GetBehaviorModelTrainingSummariesResponse
GetBucketsAggregationRequest
GetBucketsAggregationResponse
GetCardinalityRequest
GetCardinalityResponse
GetEffectivePoliciesRequest
GetEffectivePoliciesResponse
GetIndexingConfigurationResponse
GetJobDocumentRequest
GetJobDocumentResponse
GetLoggingOptionsResponse

The output from the GetLoggingOptions operation.

GetOTAUpdateRequest
GetOTAUpdateResponse
GetPercentilesRequest
GetPercentilesResponse
GetPolicyRequest

The input for the GetPolicy operation.

GetPolicyResponse

The output from the GetPolicy operation.

GetPolicyVersionRequest

The input for the GetPolicyVersion operation.

GetPolicyVersionResponse

The output from the GetPolicyVersion operation.

GetRegistrationCodeResponse

The output from the GetRegistrationCode operation.

GetStatisticsRequest
GetStatisticsResponse
GetTopicRuleDestinationRequest
GetTopicRuleDestinationResponse
GetTopicRuleRequest

The input for the GetTopicRule operation.

GetTopicRuleResponse

The output from the GetTopicRule operation.

GetV2LoggingOptionsResponse
GroupNameAndArn

The name and ARN of a group.

HttpAction

Send data to an HTTPS endpoint.

HttpActionHeader

The HTTP action header.

HttpAuthorization

The authorization method used to send messages.

HttpContext

Specifies the HTTP context to use for the test authorizer request.

HttpUrlDestinationConfiguration

HTTP URL destination configuration used by the topic rule's HTTP action.

HttpUrlDestinationProperties

HTTP URL destination properties.

HttpUrlDestinationSummary

Information about an HTTP URL destination.

ImplicitDeny

Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

IotAnalyticsAction

Sends message data to an IoT Analytics channel.

IotEventsAction

Sends an input to an IoT Events detector.

IotSiteWiseAction

Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.

Job

The Job object contains details about a job.

JobExecution

The job execution object represents the execution of a job on a particular device.

JobExecutionsRetryConfig

The configuration that determines how many retries are allowed for each failure type for a job.

JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

JobExecutionStatusDetails

Details of the job execution status.

JobExecutionSummary

The job execution summary.

JobExecutionSummaryForJob

Contains a summary of information about job executions for a specific job.

JobExecutionSummaryForThing

The job execution summary for a thing.

JobProcessDetails

The job process details.

JobSummary

The job summary.

JobTemplateSummary

An object that contains information about the job template.

KafkaAction

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

KeyPair

Describes a key pair.

KinesisAction

Describes an action to write data to an Amazon Kinesis stream.

LambdaAction

Describes an action to invoke a Lambda function.

ListActiveViolationsRequest
ListActiveViolationsResponse
ListAttachedPoliciesRequest
ListAttachedPoliciesResponse
ListAuditFindingsRequest
ListAuditFindingsResponse
ListAuditMitigationActionsExecutionsRequest
ListAuditMitigationActionsExecutionsResponse
ListAuditMitigationActionsTasksRequest
ListAuditMitigationActionsTasksResponse
ListAuditSuppressionsRequest
ListAuditSuppressionsResponse
ListAuditTasksRequest
ListAuditTasksResponse
ListAuthorizersRequest
ListAuthorizersResponse
ListBillingGroupsRequest
ListBillingGroupsResponse
ListCACertificatesRequest

Input for the ListCACertificates operation.

ListCACertificatesResponse

The output from the ListCACertificates operation.

ListCertificatesByCARequest

The input to the ListCertificatesByCA operation.

ListCertificatesByCAResponse

The output of the ListCertificatesByCA operation.

ListCertificatesRequest

The input for the ListCertificates operation.

ListCertificatesResponse

The output of the ListCertificates operation.

ListCustomMetricsRequest
ListCustomMetricsResponse
ListDetectMitigationActionsExecutionsRequest
ListDetectMitigationActionsExecutionsResponse
ListDetectMitigationActionsTasksRequest
ListDetectMitigationActionsTasksResponse
ListDimensionsRequest
ListDimensionsResponse
ListDomainConfigurationsRequest
ListDomainConfigurationsResponse
ListFleetMetricsRequest
ListFleetMetricsResponse
ListIndicesRequest
ListIndicesResponse
ListJobExecutionsForJobRequest
ListJobExecutionsForJobResponse
ListJobExecutionsForThingRequest
ListJobExecutionsForThingResponse
ListJobsRequest
ListJobsResponse
ListJobTemplatesRequest
ListJobTemplatesResponse
ListManagedJobTemplatesRequest
ListManagedJobTemplatesResponse
ListMitigationActionsRequest
ListMitigationActionsResponse
ListOTAUpdatesRequest
ListOTAUpdatesResponse
ListOutgoingCertificatesRequest

The input to the ListOutgoingCertificates operation.

ListOutgoingCertificatesResponse

The output from the ListOutgoingCertificates operation.

ListPoliciesRequest

The input for the ListPolicies operation.

ListPoliciesResponse

The output from the ListPolicies operation.

ListPolicyPrincipalsRequest

The input for the ListPolicyPrincipals operation.

ListPolicyPrincipalsResponse

The output from the ListPolicyPrincipals operation.

ListPolicyVersionsRequest

The input for the ListPolicyVersions operation.

ListPolicyVersionsResponse

The output from the ListPolicyVersions operation.

ListPrincipalPoliciesRequest

The input for the ListPrincipalPolicies operation.

ListPrincipalPoliciesResponse

The output from the ListPrincipalPolicies operation.

ListPrincipalThingsRequest

The input for the ListPrincipalThings operation.

ListPrincipalThingsResponse

The output from the ListPrincipalThings operation.

ListProvisioningTemplatesRequest
ListProvisioningTemplatesResponse
ListProvisioningTemplateVersionsRequest
ListProvisioningTemplateVersionsResponse
ListRoleAliasesRequest
ListRoleAliasesResponse
ListScheduledAuditsRequest
ListScheduledAuditsResponse
ListSecurityProfilesForTargetRequest
ListSecurityProfilesForTargetResponse
ListSecurityProfilesRequest
ListSecurityProfilesResponse
ListStreamsRequest
ListStreamsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTargetsForPolicyRequest
ListTargetsForPolicyResponse
ListTargetsForSecurityProfileRequest
ListTargetsForSecurityProfileResponse
ListThingGroupsForThingRequest
ListThingGroupsForThingResponse
ListThingGroupsRequest
ListThingGroupsResponse
ListThingPrincipalsRequest

The input for the ListThingPrincipal operation.

ListThingPrincipalsResponse

The output from the ListThingPrincipals operation.

ListThingRegistrationTaskReportsRequest
ListThingRegistrationTaskReportsResponse
ListThingRegistrationTasksRequest
ListThingRegistrationTasksResponse
ListThingsInBillingGroupRequest
ListThingsInBillingGroupResponse
ListThingsInThingGroupRequest
ListThingsInThingGroupResponse
ListThingsRequest

The input for the ListThings operation.

ListThingsResponse

The output from the ListThings operation.

ListThingTypesRequest

The input for the ListThingTypes operation.

ListThingTypesResponse

The output for the ListThingTypes operation.

ListTopicRuleDestinationsRequest
ListTopicRuleDestinationsResponse
ListTopicRulesRequest

The input for the ListTopicRules operation.

ListTopicRulesResponse

The output from the ListTopicRules operation.

ListV2LoggingLevelsRequest
ListV2LoggingLevelsResponse
ListViolationEventsRequest
ListViolationEventsResponse
LoggingOptionsPayload

Describes the logging options payload.

LogTarget

A log target.

LogTargetConfiguration

The target configuration.

MachineLearningDetectionConfig

The configuration of an ML Detect Security Profile.

ManagedJobTemplateSummary

An object that contains information about the managed template.

MetricDimension

The dimension of a metric.

MetricToRetain

The metric you want to retain. Dimensions are optional.

MetricValue

The value to be compared with the metric.

MitigationAction

Describes which changes should be applied as part of a mitigation action.

MitigationActionIdentifier

Information that identifies a mitigation action. This information is returned by ListMitigationActions.

MitigationActionParams

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).

MqttContext

Specifies the MQTT context to use for the test authorizer request

NonCompliantResource

Information about the resource that was noncompliant with the audit check.

OpenSearchAction

Describes an action that writes data to an Amazon OpenSearch Service domain.

OTAUpdateFile

Describes a file to be associated with an OTA update.

OTAUpdateInfo

Information about an OTA update.

OTAUpdateSummary

An OTA update summary.

OutgoingCertificate

A certificate that has been transferred but not yet accepted.

PercentPair

Describes the percentile and percentile value.

Policy

Describes an IoT policy.

PolicyVersion

Describes a policy version.

PolicyVersionIdentifier

Information about the version of the policy associated with the resource.

PresignedUrlConfig

Configuration for pre-signed S3 URLs.

ProvisioningHook

Structure that contains payloadVersion and targetArn.

ProvisioningTemplateSummary

A summary of information about a fleet provisioning template.

ProvisioningTemplateVersionSummary

A summary of information about a fleet provision template version.

PublishFindingToSnsParams

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.

PutAssetPropertyValueEntry

An asset property value entry containing the following information.

PutItemInput

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

PutVerificationStateOnViolationRequest
RateIncreaseCriteria

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

RegisterCACertificateRequest

The input to the RegisterCACertificate operation.

RegisterCACertificateResponse

The output from the RegisterCACertificateResponse operation.

RegisterCertificateRequest

The input to the RegisterCertificate operation.

RegisterCertificateResponse

The output from the RegisterCertificate operation.

RegisterCertificateWithoutCARequest
RegisterCertificateWithoutCAResponse
RegisterThingRequest
RegisterThingResponse
RegistrationConfig

The registration configuration.

RejectCertificateTransferRequest

The input for the RejectCertificateTransfer operation.

RelatedResource

Information about a related resource.

RemoveThingFromBillingGroupRequest
RemoveThingFromThingGroupRequest
ReplaceDefaultPolicyVersionParams

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

ReplaceTopicRuleRequest

The input for the ReplaceTopicRule operation.

RepublishAction

Describes an action to republish to another topic.

ResourceIdentifier

Information that identifies the noncompliant resource.

RetryCriteria

The criteria that determines how many retries are allowed for each failure type for a job.

RoleAliasDescription

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.

SalesforceAction

Describes an action to write a message to a Salesforce IoT Cloud Input Stream.

ScheduledAuditMetadata

Information about the scheduled audit.

SearchIndexRequest
SearchIndexResponse
SecurityProfileIdentifier

Identifying information for a Device Defender security profile.

SecurityProfileTarget

A target to which an alert is sent when a security profile behavior is violated.

SecurityProfileTargetMapping

Information about a security profile and the target associated with it.

ServerCertificateSummary

An object that contains information about a server certificate.

SetDefaultAuthorizerRequest
SetDefaultAuthorizerResponse
SetDefaultPolicyVersionRequest

The input for the SetDefaultPolicyVersion operation.

SetLoggingOptionsRequest

The input for the SetLoggingOptions operation.

SetV2LoggingLevelRequest
SetV2LoggingOptionsRequest
SigningProfileParameter

Describes the code-signing profile.

SigV4Authorization

For more information, see Signature Version 4 signing process.

SnsAction

Describes an action to publish to an Amazon SNS topic.

SqsAction

Describes an action to publish data to an Amazon SQS queue.

StartAuditMitigationActionsTaskRequest
StartAuditMitigationActionsTaskResponse
StartDetectMitigationActionsTaskRequest
StartDetectMitigationActionsTaskResponse
StartOnDemandAuditTaskRequest
StartOnDemandAuditTaskResponse
StartSigningJobParameter

Information required to start a signing job.

StartThingRegistrationTaskRequest
StartThingRegistrationTaskResponse
StatisticalThreshold

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.

Statistics

A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, consult Fleet indexing troubleshooting guide.

StepFunctionsAction

Starts execution of a Step Functions state machine.

StopThingRegistrationTaskRequest
Stream

Describes a group of files that can be streamed.

StreamFile

Represents a file to stream.

StreamInfo

Information about a stream.

StreamSummary

A summary of a stream.

Tag

A set of key/value pairs that are used to manage the resource.

TagResourceRequest
TaskStatistics

Statistics for the checks performed during the audit.

TaskStatisticsForAuditCheck

Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

TermsAggregation

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

TestAuthorizationRequest
TestAuthorizationResponse
TestInvokeAuthorizerRequest
TestInvokeAuthorizerResponse
ThingAttribute

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

ThingConnectivity

The connectivity status of the thing.

ThingDocument

The thing search index document.

ThingGroupDocument

The thing group search index document.

ThingGroupIndexingConfiguration

Thing group indexing configuration.

ThingGroupMetadata

Thing group metadata.

ThingGroupProperties

Thing group properties.

ThingIndexingConfiguration

The thing indexing configuration. For more information, see Managing Thing Indexing.

ThingTypeDefinition

The definition of the thing type, including thing type name and description.

ThingTypeMetadata

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.

ThingTypeProperties

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

TimeoutConfig

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.

TimestreamAction

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.

TimestreamDimension

Metadata attributes of the time series that are written in each measure record.

TimestreamTimestamp

Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.

TlsContext

Specifies the TLS context to use for the test authorizer request.

TopicRule

Describes a rule.

TopicRuleDestination

A topic rule destination.

TopicRuleDestinationConfiguration

Configuration of the topic rule destination.

TopicRuleDestinationSummary

Information about the topic rule destination.

TopicRuleListItem

Describes a rule.

TopicRulePayload

Describes a rule.

TransferCertificateRequest

The input for the TransferCertificate operation.

TransferCertificateResponse

The output from the TransferCertificate operation.

TransferData

Data used to transfer a certificate to an Amazon Web Services account.

UntagResourceRequest
UpdateAccountAuditConfigurationRequest
UpdateAuditSuppressionRequest
UpdateAuthorizerRequest
UpdateAuthorizerResponse
UpdateBillingGroupRequest
UpdateBillingGroupResponse
UpdateCACertificateParams

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

UpdateCACertificateRequest

The input to the UpdateCACertificate operation.

UpdateCertificateRequest

The input for the UpdateCertificate operation.

UpdateCustomMetricRequest
UpdateCustomMetricResponse
UpdateDeviceCertificateParams

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

UpdateDimensionRequest
UpdateDimensionResponse
UpdateDomainConfigurationRequest
UpdateDomainConfigurationResponse
UpdateDynamicThingGroupRequest
UpdateDynamicThingGroupResponse
UpdateEventConfigurationsRequest
UpdateFleetMetricRequest
UpdateIndexingConfigurationRequest
UpdateJobRequest
UpdateMitigationActionRequest
UpdateMitigationActionResponse
UpdateProvisioningTemplateRequest
UpdateRoleAliasRequest
UpdateRoleAliasResponse
UpdateScheduledAuditRequest
UpdateScheduledAuditResponse
UpdateSecurityProfileRequest
UpdateSecurityProfileResponse
UpdateStreamRequest
UpdateStreamResponse
UpdateThingGroupRequest
UpdateThingGroupResponse
UpdateThingGroupsForThingRequest
UpdateThingRequest

The input for the UpdateThing operation.

UpdateTopicRuleDestinationRequest
ValidateSecurityProfileBehaviorsRequest
ValidateSecurityProfileBehaviorsResponse
ValidationError

Information about an error found in a behavior specification.

ViolationEvent

Information about a Device Defender security profile behavior violation.

ViolationEventAdditionalInfo

The details of a violation event.

ViolationEventOccurrenceRange

Specifies the time period of which violation events occurred between.

VpcDestinationConfiguration

The configuration information for a virtual private cloud (VPC) destination.

VpcDestinationProperties

The properties of a virtual private cloud (VPC) destination.

VpcDestinationSummary

The summary of a virtual private cloud (VPC) destination.

§Type Aliases

AbortAction
ActionType
AggregationTypeName
AlertTargetType

The type of alert target: one of "SNS".

AuditCheckRunStatus
AuditFindingSeverity
AuditFrequency
AuditMitigationActionsExecutionStatus
AuditMitigationActionsTaskStatus
AuditNotificationType
AuditTaskStatus
AuditTaskType
AuthDecision
AuthorizerStatus
AutoRegistrationStatus
AwsJobAbortCriteriaAbortAction
AwsJobAbortCriteriaFailureType
BehaviorCriteriaType
CACertificateStatus
CACertificateUpdateAction
CannedAccessControlList
CertificateMode
CertificateStatus
ComparisonOperator
ConfidenceLevel
CustomMetricType
DayOfWeek
DetectMitigationActionExecutionStatus
DetectMitigationActionsTaskStatus
DeviceCertificateUpdateAction
DeviceDefenderIndexingMode
DimensionType
DimensionValueOperator
DomainConfigurationStatus
DomainType
DynamicGroupStatus
DynamoKeyType
EventType
FieldType
FleetMetricUnit
IndexStatus
JobExecutionFailureType
JobExecutionStatus
JobStatus
LogLevel
LogTargetType
MessageFormat
MitigationActionType
ModelStatus
NamedShadowIndexingMode
OTAUpdateStatus
PolicyTemplateName
Protocol
ReportType
ResourceType
RetryableFailureType
ServerCertificateStatus
ServiceType
Status
TargetSelection
ThingConnectivityIndexingMode
ThingGroupIndexingMode
ThingIndexingMode
TopicRuleDestinationStatus
VerificationState
ViolationEventType