Module Awso_iot.Values_0Source

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule AssetPropertyBooleanValue : sig ... end
Sourcemodule AssetPropertyDoubleValue : sig ... end
Sourcemodule AssetPropertyIntegerValue : sig ... end
Sourcemodule AssetPropertyStringValue : sig ... end
Sourcemodule AssetPropertyQuality : sig ... end
Sourcemodule AssetPropertyTimestamp : sig ... end

An asset property timestamp entry containing the following information.

Sourcemodule AssetPropertyVariant : sig ... end

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

Sourcemodule AssetPropertyValue : sig ... end

An asset property value entry containing the following information.

Sourcemodule UserPropertyKey : sig ... end
Sourcemodule UserPropertyValue : sig ... end
Sourcemodule ThingGroupName : sig ... end
Sourcemodule Prefix : sig ... end
Sourcemodule S3Bucket : sig ... end
Sourcemodule PolicyArn : sig ... end
Sourcemodule PolicyName : sig ... end
Sourcemodule HeaderKey : sig ... end
Sourcemodule HeaderValue : sig ... end
Sourcemodule AwsArn : sig ... end
Sourcemodule ServiceName : sig ... end
Sourcemodule SigningRegion : sig ... end
Sourcemodule AssetId : sig ... end
Sourcemodule AssetPropertyAlias : sig ... end
Sourcemodule AssetPropertyEntryId : sig ... end
Sourcemodule AssetPropertyId : sig ... end
Sourcemodule AssetPropertyValueList : sig ... end
Sourcemodule KafkaHeaderKey : sig ... end
Sourcemodule KafkaHeaderValue : sig ... end
Sourcemodule UserProperty : sig ... end

A key-value pair that you define in the header. Both the key and the value are either literal strings or valid substitution templates.

Sourcemodule TimestreamDimensionName : sig ... end
Sourcemodule TimestreamDimensionValue : sig ... end
Sourcemodule Cidr : sig ... end
Sourcemodule Number : sig ... end
Sourcemodule Port : sig ... end
Sourcemodule StringValue : sig ... end
Sourcemodule AttributeName : sig ... end
Sourcemodule ConnectionAttributeName : sig ... end
Sourcemodule UserPropertyKeyName : sig ... end
Sourcemodule NullableBoolean : sig ... end
Sourcemodule ThingGroupNames : sig ... end
Sourcemodule LogLevel : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule SnsTopicArn : sig ... end
Sourcemodule PolicyTemplateName : sig ... end
Sourcemodule CACertificateUpdateAction : sig ... end
Sourcemodule IssuerCertificateSubject : sig ... end
Sourcemodule IssuerId : sig ... end
Sourcemodule PolicyVersionId : sig ... end
Sourcemodule CertificateName : sig ... end
Sourcemodule InlineDocument : sig ... end
Sourcemodule Signature : sig ... end
Sourcemodule S3Destination : sig ... end

Describes the location of updated firmware in S3.

Sourcemodule CertificateArn : sig ... end
Sourcemodule CertificatePathOnDevice : sig ... end
Sourcemodule Platform : sig ... end
Sourcemodule StringParameterValue : sig ... end
Sourcemodule Policy : sig ... end

Describes an IoT policy.

Sourcemodule TableName : sig ... end
Sourcemodule BatchAcrossTopics : sig ... end
Sourcemodule MaxBatchOpenMs : sig ... end
Sourcemodule MaxBatchSize : sig ... end
Sourcemodule MaxBatchSizeBytes : sig ... end
Sourcemodule HttpActionHeader : sig ... end

The HTTP action header.

Sourcemodule SigV4Authorization : sig ... end

For more information, see Signature Version 4 signing process.

An asset property value entry containing the following information.

Sourcemodule String_ : sig ... end
Sourcemodule KafkaActionHeader : sig ... end

Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. You can use these headers to route data from IoT clients to downstream Kafka clusters without modifying your message payload. For more information about Rule's Kafka action, see Apache Kafka.

Sourcemodule ContentType : sig ... end
Sourcemodule CorrelationData : sig ... end
Sourcemodule MessageExpiry : sig ... end
Sourcemodule PayloadFormatIndicator : sig ... end
Sourcemodule ResponseTopic : sig ... end
Sourcemodule UserProperties : sig ... end
Sourcemodule TimestreamDimension : sig ... end

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

Sourcemodule TimestreamTimestampUnit : sig ... end
Sourcemodule TimestreamTimestampValue : sig ... end
Sourcemodule ConfidenceLevel : sig ... end
Sourcemodule Cidrs : sig ... end
Sourcemodule NumberList : sig ... end
Sourcemodule Ports : sig ... end
Sourcemodule StringList : sig ... end
Sourcemodule UnsignedLong : sig ... end
Sourcemodule EvaluationStatistic : sig ... end
Sourcemodule PropagatingAttribute : sig ... end

An object that represents the connection attribute, thing attribute, and the user property key.

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

Sourcemodule EnableIoTLoggingParams : sig ... end

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

Sourcemodule PublishFindingToSnsParams : sig ... end

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.

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

Sourcemodule UpdateCACertificateParams : sig ... end

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

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

Sourcemodule AwsAccountId : sig ... end
Sourcemodule CertificateId : sig ... end
Sourcemodule ClientId : sig ... end
Sourcemodule CognitoIdentityPoolId : sig ... end

The certificate issuer indentifier.

Sourcemodule PolicyVersionIdentifier : sig ... end

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

Sourcemodule RoleAliasArn : sig ... end

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

Sourcemodule CodeSigningSignature : sig ... end

Describes the signature for a file.

Sourcemodule HashAlgorithm : sig ... end
Sourcemodule SignatureAlgorithm : sig ... end
Sourcemodule Destination : sig ... end

Describes the location of the updated firmware.

Sourcemodule SigningProfileName : sig ... end
Sourcemodule SigningProfileParameter : sig ... end

Describes the code-signing profile.

Sourcemodule S3Key : sig ... end
Sourcemodule S3Version : sig ... end
Sourcemodule FileId : sig ... end
Sourcemodule StreamId : sig ... end

The numerical range value type to compare a command parameter value against.

Sourcemodule TargetFieldName : sig ... end
Sourcemodule TargetFieldOrder : sig ... end
Sourcemodule Resource : sig ... end
Sourcemodule Policies : sig ... end
Sourcemodule AlarmName : sig ... end
Sourcemodule StateReason : sig ... end
Sourcemodule StateValue : sig ... end
Sourcemodule BatchMode : sig ... end
Sourcemodule LogGroupName : sig ... end
Sourcemodule DynamoKeyType : sig ... end
Sourcemodule DynamoOperation : sig ... end
Sourcemodule HashKeyField : sig ... end
Sourcemodule HashKeyValue : sig ... end
Sourcemodule PayloadField : sig ... end
Sourcemodule RangeKeyField : sig ... end
Sourcemodule RangeKeyValue : sig ... end
Sourcemodule PutItemInput : sig ... end

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

Sourcemodule ElasticsearchEndpoint : sig ... end
Sourcemodule ElasticsearchId : sig ... end
Sourcemodule ElasticsearchIndex : sig ... end
Sourcemodule ElasticsearchType : sig ... end
Sourcemodule DeliveryStreamName : sig ... end
Sourcemodule FirehoseSeparator : sig ... end
Sourcemodule BatchConfig : sig ... end

Configuration settings for batching.

Sourcemodule EnableBatching : sig ... end
Sourcemodule HeaderList : sig ... end
Sourcemodule HttpAuthorization : sig ... end

The authorization method used to send messages.

Sourcemodule Url : sig ... end
Sourcemodule ChannelName : sig ... end
Sourcemodule InputName : sig ... end
Sourcemodule MessageId : sig ... end
Sourcemodule ClientProperties : sig ... end
Sourcemodule KafkaHeaders : sig ... end
Sourcemodule PartitionKey : sig ... end
Sourcemodule StreamName : sig ... end
Sourcemodule FunctionArn : sig ... end
Sourcemodule LocationTimestamp : sig ... end

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

Sourcemodule MqttHeaders : sig ... end

Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide.

Sourcemodule Qos : sig ... end
Sourcemodule TopicPattern : sig ... end
Sourcemodule BucketName : sig ... end
Sourcemodule CannedAccessControlList : sig ... end
Sourcemodule Key : sig ... end
Sourcemodule SalesforceEndpoint : sig ... end
Sourcemodule SalesforceToken : sig ... end
Sourcemodule MessageFormat : sig ... end
Sourcemodule QueueUrl : sig ... end
Sourcemodule UseBase64 : sig ... end
Sourcemodule ExecutionNamePrefix : sig ... end
Sourcemodule StateMachineName : sig ... end
Sourcemodule TimestreamDatabaseName : sig ... end
Sourcemodule TimestreamDimensionList : sig ... end
Sourcemodule TimestreamTableName : sig ... end
Sourcemodule TimestreamTimestamp : sig ... end

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

Sourcemodule ComparisonOperator : sig ... end
Sourcemodule DurationSeconds : sig ... end

The configuration of an ML Detect Security Profile.

Sourcemodule MetricValue : sig ... end

The value to be compared with the metric.

Sourcemodule StatisticalThreshold : sig ... end

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.

Sourcemodule DimensionName : sig ... end
Sourcemodule DimensionValueOperator : sig ... end
Sourcemodule SecurityGroupId : sig ... end
Sourcemodule SubnetId : sig ... end
Sourcemodule PropagatingAttributeList : sig ... end
Sourcemodule ViolationId : sig ... end
Sourcemodule MitigationActionId : sig ... end
Sourcemodule MitigationActionName : sig ... end
Sourcemodule MitigationActionParams : sig ... end

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

Sourcemodule ResourceIdentifier : sig ... end

Information that identifies the noncompliant resource.

Sourcemodule ResourceType : sig ... end
Sourcemodule StringMap : sig ... end
Sourcemodule AttributeKey : sig ... end
Sourcemodule Value : sig ... end
Sourcemodule CustomCodeSigning : sig ... end

Describes a custom method used to code sign a file.

Sourcemodule SigningJobId : sig ... end
Sourcemodule StartSigningJobParameter : sig ... end

Information required to start a signing job.

Sourcemodule S3Location : sig ... end

The S3 location.

Sourcemodule Stream : sig ... end

Describes a group of files that can be streamed.

The comparison operand used to compare the defined value against the value supplied in request.

Sourcemodule AbortAction : sig ... end
Sourcemodule AbortThresholdPercentage : sig ... end
Sourcemodule JobExecutionFailureType : sig ... end
Sourcemodule NumberOfRetries : sig ... end
Sourcemodule RetryableFailureType : sig ... end
Sourcemodule NumberOfThings : sig ... end
Sourcemodule CronExpression : sig ... end
Sourcemodule DurationInMinutes : sig ... end
Sourcemodule AttributeValue : sig ... end
Sourcemodule FieldName : sig ... end
Sourcemodule FieldType : sig ... end
Sourcemodule GeoLocationTarget : sig ... end

A geolocation target that you select to index. Each geolocation target contains a name and order key-value pair that specifies the geolocation target fields.

Sourcemodule ShadowName : sig ... end
Sourcemodule ConfigName : sig ... end
Sourcemodule ConfigValue : sig ... end
Sourcemodule ActionType : sig ... end
Sourcemodule Resources : sig ... end
Sourcemodule ExplicitDeny : sig ... end

Information that explicitly denies authorization.

Sourcemodule ImplicitDeny : sig ... end

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

Sourcemodule MissingContextValue : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule ConnectivityTimestamp : sig ... end
Sourcemodule DisconnectReason : sig ... end
Sourcemodule CloudwatchAlarmAction : sig ... end

Describes an action that updates a CloudWatch alarm.

Sourcemodule CloudwatchLogsAction : sig ... end

Describes an action that sends data to CloudWatch Logs.

Sourcemodule CloudwatchMetricAction : sig ... end

Describes an action that captures a CloudWatch metric.

Sourcemodule DynamoDBAction : sig ... end

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()}"

Sourcemodule DynamoDBv2Action : sig ... end

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.

Sourcemodule ElasticsearchAction : sig ... end

Describes an action that writes data to an Amazon OpenSearch Service domain. The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

Sourcemodule FirehoseAction : sig ... end

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

Sourcemodule HttpAction : sig ... end

Send data to an HTTPS endpoint.

Sourcemodule IotAnalyticsAction : sig ... end

Sends message data to an IoT Analytics channel.

Sourcemodule IotEventsAction : sig ... end

Sends an input to an IoT Events detector.

Sourcemodule IotSiteWiseAction : sig ... end

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

Sourcemodule KafkaAction : sig ... end

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

Sourcemodule KinesisAction : sig ... end

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

Sourcemodule LambdaAction : sig ... end

Describes an action to invoke a Lambda function.

Sourcemodule LocationAction : sig ... end

The Amazon Location rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

Sourcemodule OpenSearchAction : sig ... end

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

Sourcemodule RepublishAction : sig ... end

Describes an action to republish to another topic.

Sourcemodule S3Action : sig ... end

Describes an action to write data to an Amazon S3 bucket.

Sourcemodule SalesforceAction : sig ... end

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

Sourcemodule SnsAction : sig ... end

Describes an action to publish to an Amazon SNS topic.

Sourcemodule SqsAction : sig ... end

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

Sourcemodule StepFunctionsAction : sig ... end

Starts execution of a Step Functions state machine.

Sourcemodule TimestreamAction : sig ... end

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.

Sourcemodule BehaviorCriteria : sig ... end

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

Sourcemodule BehaviorMetric : sig ... end
Sourcemodule BehaviorName : sig ... end
Sourcemodule ExportMetric : sig ... end
Sourcemodule MetricDimension : sig ... end

The dimension of a metric.

Sourcemodule SuppressAlerts : sig ... end
Sourcemodule LogTargetName : sig ... end
Sourcemodule LogTargetType : sig ... end
Sourcemodule SecurityGroupList : sig ... end
Sourcemodule SubnetIdList : sig ... end
Sourcemodule VpcId : sig ... end
Sourcemodule CreationDate : sig ... end
Sourcemodule DeprecationDate : sig ... end
Sourcemodule Mqtt5Configuration : sig ... end

The configuration to add user-defined properties to enrich MQTT 5 messages.

Sourcemodule SearchableAttributes : sig ... end
Sourcemodule ThingTypeDescription : sig ... end
Sourcemodule SecurityProfileArn : sig ... end
Sourcemodule SecurityProfileName : sig ... end
Sourcemodule SecurityProfileTargetArn : sig ... end
Sourcemodule Environment : sig ... end
Sourcemodule DateType : sig ... end
Sourcemodule ExecutionNumber : sig ... end
Sourcemodule JobExecutionStatus : sig ... end
Sourcemodule RetryAttempt : sig ... end
Sourcemodule GenericLongValue : sig ... end
Sourcemodule MitigationAction : sig ... end

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

Sourcemodule Timestamp : sig ... end
Sourcemodule RelatedResource : sig ... end

Information about a related resource.

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

Sourcemodule AttributesMap : sig ... end
Sourcemodule CodeSigning : sig ... end

Describes the method to use when code signing a file.

Sourcemodule FileLocation : sig ... end

The location of the OTA update.

Sourcemodule FileName : sig ... end
Sourcemodule FileType : sig ... end
Sourcemodule OTAUpdateFileVersion : sig ... end
Sourcemodule BinaryParameterValue : sig ... end
Sourcemodule BooleanParameterValue : sig ... end
Sourcemodule DoubleParameterValue : sig ... end
Sourcemodule IntegerParameterValue : sig ... end
Sourcemodule LongParameterValue : sig ... end

A condition for the command parameter that must be evaluated to true for successful creation of a command execution.

Sourcemodule ThingGroupArn : sig ... end
Sourcemodule AbortCriteria : sig ... end

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

Sourcemodule RetryCriteria : sig ... end

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

Sourcemodule IncrementFactor : sig ... end
Sourcemodule RateIncreaseCriteria : sig ... end

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

Sourcemodule RolloutRatePerMinute : sig ... end
Sourcemodule ProcessingTargetName : sig ... end
Sourcemodule StringDateTime : sig ... end
Sourcemodule MaintenanceWindow : sig ... end

An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.

Sourcemodule DetailsKey : sig ... end
Sourcemodule DetailsValue : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule Attributes : sig ... end
Sourcemodule Flag : sig ... end
Sourcemodule AlertTargetArn : sig ... end
Sourcemodule Field : sig ... end

Describes the name and data type at a field.

Sourcemodule GeoLocationsFilter : sig ... end
Sourcemodule NamedShadowNamesFilter : sig ... end
Sourcemodule AggregationTypeValue : sig ... end
Sourcemodule Enabled : sig ... end
Sourcemodule CheckCustomConfiguration : sig ... end
Sourcemodule TargetArn : sig ... end
Sourcemodule HttpHeaderName : sig ... end
Sourcemodule HttpHeaderValue : sig ... end
Sourcemodule Allowed : sig ... end

Contains information that allowed the authorization.

Sourcemodule AuthDecision : sig ... end
Sourcemodule AuthInfo : sig ... end

A collection of authorization information.

Sourcemodule Denied : sig ... end

Contains information that denied the authorization.

Sourcemodule MissingContextValues : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule AuditCheckName : sig ... end

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Sourcemodule FindingId : sig ... end
Sourcemodule LogDestination : sig ... end
Sourcemodule LogEventType : sig ... end
Sourcemodule JsonDocument : sig ... end
Sourcemodule ThingConnectivity : sig ... end

The connectivity status of the thing.

Sourcemodule ThingGroupNameList : sig ... end
Sourcemodule ThingId : sig ... end
Sourcemodule ThingName : sig ... end
Sourcemodule ThingTypeName : sig ... end
Sourcemodule ThingGroupDescription : sig ... end
Sourcemodule ThingGroupId : sig ... end
Sourcemodule Action : sig ... end

Describes the actions associated with a rule.

Sourcemodule Behavior : sig ... end

A Device Defender security profile behavior.

Sourcemodule DeviceDefenderThingName : sig ... end
Sourcemodule VerificationState : sig ... end

The details of a violation event.

Sourcemodule ViolationEventType : sig ... end
Sourcemodule LogTarget : sig ... end

A log target.

Sourcemodule CreatedAtDate : sig ... end
Sourcemodule IsDisabled : sig ... end
Sourcemodule RuleArn : sig ... end
Sourcemodule RuleName : sig ... end
Sourcemodule HttpUrlDestinationSummary : sig ... end

Information about an HTTP URL destination.

Sourcemodule LastUpdatedAtDate : sig ... end
Sourcemodule VpcDestinationSummary : sig ... end

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

Sourcemodule ThingArn : sig ... end
Sourcemodule Version : sig ... end
Sourcemodule ThingTypeArn : sig ... end
Sourcemodule ThingTypeMetadata : sig ... end

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.

Sourcemodule ThingTypeProperties : sig ... end

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

Sourcemodule Principal : sig ... end
Sourcemodule ThingPrincipalType : sig ... end
Sourcemodule StreamArn : sig ... end
Sourcemodule StreamDescription : sig ... end
Sourcemodule StreamVersion : sig ... end
Sourcemodule SecurityProfileIdentifier : sig ... end

Identifying information for a Device Defender security profile.

Sourcemodule SecurityProfileTarget : sig ... end

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

Sourcemodule AuditFrequency : sig ... end
Sourcemodule DayOfMonth : sig ... end
Sourcemodule DayOfWeek : sig ... end
Sourcemodule ScheduledAuditArn : sig ... end
Sourcemodule ScheduledAuditName : sig ... end
Sourcemodule SbomValidationErrorCode : sig ... end
Sourcemodule SbomValidationResult : sig ... end
Sourcemodule TemplateArn : sig ... end
Sourcemodule TemplateDescription : sig ... end
Sourcemodule TemplateName : sig ... end
Sourcemodule TemplateType : sig ... end
Sourcemodule IsDefaultVersion : sig ... end
Sourcemodule TemplateVersionId : sig ... end
Sourcemodule LastModifiedDate : sig ... end
Sourcemodule PackageName : sig ... end
Sourcemodule VersionName : sig ... end
Sourcemodule PackageVersionStatus : sig ... end
Sourcemodule Message : sig ... end
Sourcemodule OTAUpdateArn : sig ... end
Sourcemodule OTAUpdateId : sig ... end
Sourcemodule MitigationActionArn : sig ... end
Sourcemodule Environments : sig ... end
Sourcemodule JobDescription : sig ... end
Sourcemodule JobTemplateArn : sig ... end
Sourcemodule ManagedJobTemplateName : sig ... end
Sourcemodule ManagedTemplateVersion : sig ... end
Sourcemodule BooleanWrapperObject : sig ... end
Sourcemodule JobArn : sig ... end
Sourcemodule JobId : sig ... end
Sourcemodule JobStatus : sig ... end
Sourcemodule TargetSelection : sig ... end
Sourcemodule JobTemplateId : sig ... end
Sourcemodule JobExecutionSummary : sig ... end

The job execution summary.

Sourcemodule FleetMetricArn : sig ... end
Sourcemodule FleetMetricName : sig ... end
Sourcemodule DomainConfigurationArn : sig ... end
Sourcemodule ServiceType : sig ... end

The statistics of a mitigation action task.

The target of a mitigation action task.

Sourcemodule MitigationActionList : sig ... end
Sourcemodule MitigationActionsTaskId : sig ... end
Sourcemodule PrimitiveBoolean : sig ... end

Specifies the time period of which violation events occurred between.

Sourcemodule CommandArn : sig ... end
Sourcemodule CommandId : sig ... end
Sourcemodule DeprecationFlag : sig ... end
Sourcemodule DisplayName : sig ... end
Sourcemodule CommandExecutionId : sig ... end
Sourcemodule CommandExecutionStatus : sig ... end
Sourcemodule CertificateMode : sig ... end
Sourcemodule CertificateStatus : sig ... end
Sourcemodule CertificateProviderArn : sig ... end
Sourcemodule CertificateProviderName : sig ... end
Sourcemodule CACertificateStatus : sig ... end
Sourcemodule AuthorizerArn : sig ... end
Sourcemodule AuthorizerName : sig ... end
Sourcemodule AuditTaskId : sig ... end
Sourcemodule AuditTaskStatus : sig ... end
Sourcemodule AuditTaskType : sig ... end
Sourcemodule AuditDescription : sig ... end
Sourcemodule SuppressIndefinitely : sig ... end
Sourcemodule ErrorCode : sig ... end
Sourcemodule AuditFindingSeverity : sig ... end
Sourcemodule IsSuppressed : sig ... end
Sourcemodule NonCompliantResource : sig ... end

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

Sourcemodule ReasonForNonCompliance : sig ... end
Sourcemodule RelatedResources : sig ... end
Sourcemodule Percent : sig ... end
Sourcemodule PercentValue : sig ... end

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

Sourcemodule MaximumPerMinute : sig ... end
Sourcemodule ExpiresInSeconds : sig ... end
Sourcemodule Code : sig ... end
Sourcemodule OTAUpdateErrorMessage : sig ... end
Sourcemodule OTAUpdateFile : sig ... end

Describes a file to be associated with an OTA update.

Sourcemodule Protocol : sig ... end
Sourcemodule Target : sig ... end
Sourcemodule PolicyDocument : sig ... end
Sourcemodule CommandParameterName : sig ... end
Sourcemodule CommandParameterType : sig ... end
Sourcemodule CommandParameterValue : sig ... end

The value of a command parameter used to create a command execution. The commandParameterValue can only have one of the below fields listed.

Sourcemodule OutputFormat : sig ... end
Sourcemodule BucketKeyValue : sig ... end
Sourcemodule Count : sig ... end
Sourcemodule MaxBuckets : sig ... end
Sourcemodule DataCollectionPercentage : sig ... end
Sourcemodule ModelStatus : sig ... end
Sourcemodule GroupNameAndArn : sig ... end

The name and ARN of a group.

Sourcemodule StreamFile : sig ... end

Represents a file to stream.

Sourcemodule Example : sig ... end
Sourcemodule Optional : sig ... end
Sourcemodule ParameterKey : sig ... end
Sourcemodule Regex : sig ... end
Sourcemodule AbortCriteriaList : sig ... end
Sourcemodule PackageVersionArn : sig ... end
Sourcemodule RetryCriteriaList : sig ... end
Sourcemodule ExponentialRolloutRate : sig ... end

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

Sourcemodule MaxJobExecutionsPerMin : sig ... end
Sourcemodule CanceledThings : sig ... end
Sourcemodule FailedThings : sig ... end
Sourcemodule InProgressThings : sig ... end
Sourcemodule ProcessingTargetNameList : sig ... end
Sourcemodule QueuedThings : sig ... end
Sourcemodule RejectedThings : sig ... end
Sourcemodule RemovedThings : sig ... end
Sourcemodule SucceededThings : sig ... end
Sourcemodule TimedOutThings : sig ... end
Sourcemodule ParameterValue : sig ... end
Sourcemodule ExpiresInSec : sig ... end
Sourcemodule ScheduledJobRollout : sig ... end

Displays the next seven maintenance window occurrences and their start times.

Sourcemodule JobEndBehavior : sig ... end
Sourcemodule MaintenanceWindows : sig ... end
Sourcemodule DetailsMap : sig ... end
Sourcemodule AcmCertificateArn : sig ... end
Sourcemodule ServerCertificateStatus : sig ... end
Sourcemodule KeyName : sig ... end
Sourcemodule KeyValue : sig ... end
Sourcemodule AuditCheckRunStatus : sig ... end
Sourcemodule CheckCompliant : sig ... end
Sourcemodule TotalResourcesCount : sig ... end
Sourcemodule CanceledFindingsCount : sig ... end
Sourcemodule FailedFindingsCount : sig ... end
Sourcemodule SkippedFindingsCount : sig ... end
Sourcemodule SucceededFindingsCount : sig ... end
Sourcemodule TotalFindingsCount : sig ... end
Sourcemodule AwsJobAbortCriteria : sig ... end

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

Sourcemodule ValidationError : sig ... end

Information about an error found in a behavior specification.

Sourcemodule AttributePayload : sig ... end

The attribute payload.

Sourcemodule MetricToRetain : sig ... end

The metric you want to retain. Dimensions are optional.

Sourcemodule AlertTarget : sig ... end

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

Sourcemodule AlertTargetType : sig ... end
Sourcemodule MqttTopic : sig ... end
Sourcemodule PayloadVersion : sig ... end
Sourcemodule ResourceId : sig ... end
Sourcemodule ResourceAttributeKey : sig ... end
Sourcemodule ResourceAttributeValue : sig ... end
Sourcemodule EnabledBoolean : sig ... end
Sourcemodule Fields : sig ... end
Sourcemodule ThingGroupIndexingMode : sig ... end
Sourcemodule IndexingFilter : sig ... end

Provides additional selections for named shadows and geolocation data. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter. To add geolocation data to your fleet indexing configuration: If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter. If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.

Sourcemodule NamedShadowIndexingMode : sig ... end
Sourcemodule ThingIndexingMode : sig ... end
Sourcemodule AggregationTypeName : sig ... end
Sourcemodule AggregationTypeValues : sig ... end
Sourcemodule Configuration : sig ... end

Configuration.

Sourcemodule EventType : sig ... end
Sourcemodule AllowAuthorizerOverride : sig ... end
Sourcemodule EnableOCSPCheck : sig ... end
Sourcemodule OCSPLambdaArn : sig ... end
Sourcemodule SecurityPolicy : sig ... end
Sourcemodule DimensionStringValue : sig ... end
Sourcemodule TemplateBody : sig ... end
Sourcemodule BillingGroupDescription : sig ... end
Sourcemodule AuditCheckConfiguration : sig ... end

Which audit checks are enabled and disabled for this account.

Sourcemodule AuditNotificationTarget : sig ... end

Information about the targets to which audit notifications are sent.

Sourcemodule AuditNotificationType : sig ... end
Sourcemodule HttpHeaders : sig ... end
Sourcemodule HttpQueryString : sig ... end
Sourcemodule MqttClientId : sig ... end
Sourcemodule MqttPassword : sig ... end
Sourcemodule MqttUsername : sig ... end
Sourcemodule ServerName : sig ... end
Sourcemodule AuthResult : sig ... end

The authorizer result.

Sourcemodule Tag : sig ... end

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

Sourcemodule MitigationActionNameList : sig ... end
Sourcemodule FindingIds : sig ... end
Sourcemodule LogEventConfiguration : sig ... end

Configuration for event-based logging that specifies which event types to log and their logging settings. Used for account-level logging overrides.

Sourcemodule ThingDocument : sig ... end

The thing search index document.

Sourcemodule ThingGroupDocument : sig ... end

The thing group search index document.

Sourcemodule ActionList : sig ... end
Sourcemodule AwsIotSqlVersion : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule SQL : sig ... end
Sourcemodule ResourceArn : sig ... end
Sourcemodule ResourceLogicalId : sig ... end
Sourcemodule Parameter : sig ... end
Sourcemodule ViolationEvent : sig ... end

Information about a Device Defender security profile behavior violation.

Sourcemodule LogTargetConfiguration : sig ... end

The target configuration.

Sourcemodule TopicRuleListItem : sig ... end

Describes a rule.

Information about the topic rule destination.

Sourcemodule ThingAttribute : sig ... end

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

Sourcemodule ThingTypeDefinition : sig ... end

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

Sourcemodule TaskId : sig ... end
Sourcemodule S3FileUrl : sig ... end
Sourcemodule ThingPrincipalObject : sig ... end

An object that represents the principal and the type of relation it has with the thing.

Sourcemodule PrincipalArn : sig ... end
Sourcemodule PolicyTarget : sig ... end
Sourcemodule StreamSummary : sig ... end

A summary of a stream.

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

Sourcemodule ScheduledAuditMetadata : sig ... end

Information about the scheduled audit.

A summary of the validation results for a specific software bill of materials (SBOM) attached to a software package version.

Sourcemodule RoleAlias : sig ... end

A summary of information about a provisioning template.

A summary of information about a fleet provision template version.

Sourcemodule PrincipalThingObject : sig ... end

An object that represents the thing and the type of relation it has with the principal.

Sourcemodule PolicyVersion : sig ... end

Describes a policy version.

Sourcemodule PackageSummary : sig ... end

A summary of information about a software package.

Sourcemodule PackageVersionSummary : sig ... end

A summary of information about a package version.

Sourcemodule OutgoingCertificate : sig ... end

A certificate that has been transferred but not yet accepted.

Sourcemodule OTAUpdateSummary : sig ... end

An OTA update summary.

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

Sourcemodule MetricDatum : sig ... end

A metric.

Sourcemodule ManagedJobTemplateSummary : sig ... end

An object that contains information about the managed template.

Sourcemodule JobSummary : sig ... end

The job summary.

Sourcemodule JobTemplateSummary : sig ... end

An object that contains information about the job template.

The job execution summary for a thing.

Sourcemodule JobExecutionSummaryForJob : sig ... end

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

Sourcemodule IndexName : sig ... end
Sourcemodule FleetMetricNameAndArn : sig ... end

The name and ARN of a fleet metric.

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. Data Jobs CredentialProvider

The summary of the mitigation action tasks.

Describes which mitigation actions should be executed.

Sourcemodule MetricName : sig ... end
Sourcemodule CommandSummary : sig ... end

Summary information about a particular command resource.

Sourcemodule CommandExecutionSummary : sig ... end

Summary information about a particular command execution.

Sourcemodule Certificate : sig ... end

Information about a certificate.

The certificate provider summary.

Sourcemodule CACertificate : sig ... end

A CA certificate.

Sourcemodule AuthorizerSummary : sig ... end

The authorizer summary.

Sourcemodule AuditTaskMetadata : sig ... end

The audits that were performed.

Sourcemodule AuditSuppression : sig ... end

Filters out specific findings of a Device Defender audit.

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

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

Sourcemodule AuditFinding : sig ... end

The findings (results) of the audit.

Sourcemodule ActiveViolation : sig ... end

Information about an active Device Defender security profile behavior violation.

HTTP URL destination properties.

Sourcemodule VpcDestinationProperties : sig ... end

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

Sourcemodule Average : sig ... end
Sourcemodule Maximum : sig ... end
Sourcemodule Minimum : sig ... end
Sourcemodule StdDeviation : sig ... end
Sourcemodule Sum : sig ... end
Sourcemodule SumOfSquares : sig ... end
Sourcemodule Variance : sig ... end
Sourcemodule PercentPair : sig ... end

Describes the percentile and percentile value.

Sourcemodule AdditionalParameterMap : sig ... end
Sourcemodule AwsIotJobArn : sig ... end
Sourcemodule AwsIotJobId : sig ... end

Configuration for the rollout of OTA updates.

Sourcemodule AwsJobPresignedUrlConfig : sig ... end

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

Sourcemodule ErrorInfo : sig ... end

Error information.

Sourcemodule OTAUpdateDescription : sig ... end
Sourcemodule OTAUpdateFiles : sig ... end
Sourcemodule OTAUpdateStatus : sig ... end
Sourcemodule Protocols : sig ... end
Sourcemodule Targets : sig ... end
Sourcemodule EffectivePolicy : sig ... end

The policy that has the effect on the authorization results.

Sourcemodule CommandParameter : sig ... end

A map of key-value pairs that describe the command.

Sourcemodule CommandPayloadBlob : sig ... end
Sourcemodule MimeType : sig ... end

Configures the command to treat the payloadTemplate as a JSON document for preprocessing. This preprocessor substitutes placeholders with parameter values to generate the command execution request payload.

Sourcemodule CommandExecutionResult : sig ... end

The result value of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call. This field is not applicable if you use the AWS-IoT-FleetWise namespace.

Sourcemodule StatusReasonCode : sig ... end
Sourcemodule StatusReasonDescription : sig ... end
Sourcemodule Bucket : sig ... end

A count of documents that meets a specific aggregation criteria.

Sourcemodule TermsAggregation : sig ... end

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.

The summary of an ML Detect behavior model.

Sourcemodule ThingGroupNameAndArnList : sig ... end
Sourcemodule StreamFiles : sig ... end
Sourcemodule CredentialDurationSeconds : sig ... end
Sourcemodule DocumentParameter : sig ... end

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. documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Sourcemodule AbortConfig : sig ... end

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

Sourcemodule Comment : sig ... end
Sourcemodule Forced : sig ... end
Sourcemodule JobExecutionsRetryConfig : sig ... end

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

Allows you to create a staged rollout of a job.

Sourcemodule JobProcessDetails : sig ... end

The job process details.

Sourcemodule JobTargets : sig ... end
Sourcemodule NamespaceId : sig ... end
Sourcemodule ParameterMap : sig ... end
Sourcemodule PresignedUrlConfig : sig ... end

Configuration for pre-signed S3 URLs.

Sourcemodule ReasonCode : sig ... end
Sourcemodule ScheduledJobRolloutList : sig ... end
Sourcemodule SchedulingConfig : sig ... end

Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end behavior for each job execution when it reaches the scheduled end time.

Sourcemodule TimeoutConfig : sig ... end

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.

Sourcemodule JobExecutionStatusDetails : sig ... end

Details of the job execution status.

Sourcemodule VersionNumber : sig ... end
Sourcemodule ConfigurationStatus : sig ... end
Sourcemodule ServerCertificateSummary : sig ... end

An object that contains information about a server certificate.

Sourcemodule AuthorizerFunctionArn : sig ... end
Sourcemodule AuthorizerStatus : sig ... end
Sourcemodule BooleanKey : sig ... end
Sourcemodule EnableCachingForHttp : sig ... end
Sourcemodule PublicKeyMap : sig ... end
Sourcemodule TokenKeyName : sig ... end
Sourcemodule CertificatePem : sig ... end

The PEM of a certificate.

Sourcemodule CertificateValidity : sig ... end

When the certificate is valid.

Sourcemodule CustomerVersion : sig ... end
Sourcemodule GenerationId : sig ... end
Sourcemodule TransferData : sig ... end

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

Sourcemodule AutoRegistrationStatus : sig ... end
Sourcemodule AuditCheckDetails : sig ... end

Information about the audit check.

Sourcemodule CanceledChecksCount : sig ... end
Sourcemodule CompliantChecksCount : sig ... end
Sourcemodule FailedChecksCount : sig ... end
Sourcemodule InProgressChecksCount : sig ... end
Sourcemodule NonCompliantChecksCount : sig ... end
Sourcemodule TotalChecksCount : sig ... end

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

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

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

Sourcemodule PrivateKey : sig ... end
Sourcemodule PublicKey : sig ... end
Sourcemodule AwsJobAbortCriteriaList : sig ... end
Sourcemodule InternalFailureException : sig ... end

An unexpected error has occurred.

Sourcemodule InvalidRequestException : sig ... end

The request is not valid.

Sourcemodule ThrottlingException : sig ... end

The rate exceeds the limit.

Sourcemodule Valid : sig ... end
Sourcemodule ValidationErrors : sig ... end
Sourcemodule Behaviors : sig ... end

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

Sourcemodule InternalException : sig ... end

An unexpected error has occurred.

The service is temporarily unavailable.

Sourcemodule UnauthorizedException : sig ... end

You are not authorized to perform this operation.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource does not exist.

Sourcemodule VersionConflictException : sig ... end

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

Sourcemodule OptionalVersion : sig ... end
Sourcemodule RemoveThingType : sig ... end
Sourcemodule OverrideDynamicGroups : sig ... end
Sourcemodule ThingGroupList : sig ... end
Sourcemodule ThingGroupProperties : sig ... end

Thing group properties.

Sourcemodule LimitExceededException : sig ... end

A limit has been exceeded.

Sourcemodule AlertTargets : sig ... end
Sourcemodule MetricsExportConfig : sig ... end

Set configurations for metrics export.

Sourcemodule DeleteAlertTargets : sig ... end
Sourcemodule DeleteBehaviors : sig ... end
Sourcemodule DeleteMetricsExportConfig : sig ... end
Sourcemodule TargetAuditCheckNames : sig ... end
Sourcemodule ProvisioningHook : sig ... end

Structure that contains payloadVersion and targetArn.

Sourcemodule RemoveHook : sig ... end
Sourcemodule ConflictException : sig ... end

The request conflicts with the current state of the resource.

Sourcemodule InternalServerException : sig ... end

Internal error from the service that indicates an unexpected error or that the service is unavailable.

Sourcemodule ValidationException : sig ... end

The request is not valid.

Sourcemodule ClientToken : sig ... end
Sourcemodule PackageVersionAction : sig ... end
Sourcemodule PackageVersionArtifact : sig ... end

A specific package version artifact associated with a software package version.

Sourcemodule PackageVersionRecipe : sig ... end
Sourcemodule ResourceAttributes : sig ... end
Sourcemodule ResourceDescription : sig ... end
Sourcemodule UnsetDefaultVersion : sig ... end
Sourcemodule VersionUpdateByJobsConfig : sig ... end

Configuration to manage IoT Job's package version reporting. If configured, Jobs updates the thing's reserved named shadow with the package version information up on successful job completion. Note: For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.

Thing group indexing configuration.

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

Sourcemodule AggregationField : sig ... end
Sourcemodule AggregationType : sig ... end

The type of aggregation queries.

Sourcemodule FleetMetricDescription : sig ... end
Sourcemodule FleetMetricPeriod : sig ... end
Sourcemodule FleetMetricUnit : sig ... end
Sourcemodule QueryString : sig ... end
Sourcemodule QueryVersion : sig ... end
Sourcemodule EventConfigurations : sig ... end
Sourcemodule EncryptionType : sig ... end
Sourcemodule KmsAccessRoleArn : sig ... end
Sourcemodule KmsKeyArn : sig ... end
Sourcemodule InvalidQueryException : sig ... end

The query is invalid.

The certificate is invalid.

Sourcemodule ApplicationProtocol : sig ... end
Sourcemodule AuthenticationType : sig ... end
Sourcemodule AuthorizerConfig : sig ... end

An object that specifies the authorization service for a domain.

Sourcemodule ClientCertificateConfig : sig ... end

An object that specifies the client certificate configuration for a domain.

Sourcemodule DomainConfigurationStatus : sig ... end
Sourcemodule RemoveAuthorizerConfig : sig ... end
Sourcemodule ServerCertificateConfig : sig ... end

The server certificate configuration.

Sourcemodule TlsConfig : sig ... end

An object that specifies the TLS configuration for a domain.

Sourcemodule DimensionArn : sig ... end
Sourcemodule DimensionStringValues : sig ... end
Sourcemodule DimensionType : sig ... end
Sourcemodule CustomMetricArn : sig ... end
Sourcemodule CustomMetricDisplayName : sig ... end
Sourcemodule CustomMetricType : sig ... end
Sourcemodule CommandDescription : sig ... end
Sourcemodule RegistrationConfig : sig ... end

The registration configuration.

Sourcemodule RemoveAutoRegistration : sig ... end
Sourcemodule BillingGroupName : sig ... end
Sourcemodule BillingGroupProperties : sig ... end

The properties of a billing group.

Sourcemodule AuditCheckConfigurations : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule CertificateStateException : sig ... end

The certificate operation is not allowed.

Sourcemodule TransferConflictException : sig ... end

You can't transfer the certificate because authorization policies are still attached.

Sourcemodule InvalidResponseException : sig ... end

The response is invalid.

Sourcemodule IsAuthenticated : sig ... end
Sourcemodule PolicyDocuments : sig ... end
Sourcemodule PrincipalId : sig ... end
Sourcemodule Seconds : sig ... end
Sourcemodule HttpContext : sig ... end

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

Sourcemodule MqttContext : sig ... end

Specifies the MQTT context to use for the test authorizer request

Sourcemodule TlsContext : sig ... end

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

Sourcemodule Token : sig ... end
Sourcemodule TokenSignature : sig ... end
Sourcemodule AuthResults : sig ... end
Sourcemodule AuthInfos : sig ... end
Sourcemodule PolicyNames : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule RegistryS3BucketName : sig ... end
Sourcemodule RegistryS3KeyName : sig ... end

This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

Sourcemodule ClientRequestToken : sig ... end

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

Sourcemodule DisableAllLogs : sig ... end
Sourcemodule LogEventConfigurations : sig ... end
Sourcemodule LoggingOptionsPayload : sig ... end

Describes the logging options payload.

The resource already exists.

Sourcemodule IndexNotReadyException : sig ... end

The index is not ready.

Sourcemodule NextToken : sig ... end
Sourcemodule ThingDocumentList : sig ... end
Sourcemodule ThingGroupDocumentList : sig ... end
Sourcemodule SearchQueryMaxResults : sig ... end
Sourcemodule TopicRulePayload : sig ... end

Describes a rule.

Sourcemodule BillingGroupArn : sig ... end
Sourcemodule ResourceArns : sig ... end

The resource registration failed.

Sourcemodule Parameters : sig ... end

Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

Sourcemodule SetAsActiveFlag : sig ... end

The registration code is invalid.

Sourcemodule AllowAutoRegistration : sig ... end
Sourcemodule SetAsActive : sig ... end
Sourcemodule ViolationEvents : sig ... end
Sourcemodule BehaviorCriteriaType : sig ... end
Sourcemodule ListSuppressedAlerts : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule LogTargetConfigurations : sig ... end
Sourcemodule NotConfiguredException : sig ... end

The resource is not configured.

Sourcemodule SkyfallMaxResults : sig ... end
Sourcemodule TopicRuleList : sig ... end
Sourcemodule Topic : sig ... end
Sourcemodule TopicRuleMaxResults : sig ... end
Sourcemodule ThingAttributeList : sig ... end
Sourcemodule RegistryMaxResults : sig ... end
Sourcemodule UsePrefixAttributeValue : sig ... end
Sourcemodule ThingNameList : sig ... end
Sourcemodule Recursive : sig ... end
Sourcemodule ThingTypeList : sig ... end
Sourcemodule TaskIdList : sig ... end
Sourcemodule Status : sig ... end
Sourcemodule ReportType : sig ... end
Sourcemodule S3FileUrlList : sig ... end
Sourcemodule ThingPrincipalObjects : sig ... end
Sourcemodule Principals : sig ... end
Sourcemodule RecursiveWithoutDefault : sig ... end
Sourcemodule SecurityProfileTargets : sig ... end
Sourcemodule Marker : sig ... end
Sourcemodule PolicyTargets : sig ... end
Sourcemodule PageSize : sig ... end
Sourcemodule StreamsSummary : sig ... end
Sourcemodule AscendingOrder : sig ... end
Sourcemodule PackageCatalogMaxResults : sig ... end
Sourcemodule RoleAliases : sig ... end
Sourcemodule PrincipalThingObjects : sig ... end
Sourcemodule PolicyVersions : sig ... end
Sourcemodule PackageSummaryList : sig ... end
Sourcemodule PackageVersionSummaryList : sig ... end
Sourcemodule OutgoingCertificates : sig ... end
Sourcemodule OTAUpdatesSummary : sig ... end
Sourcemodule MitigationActionType : sig ... end
Sourcemodule MetricDatumList : sig ... end
Sourcemodule LaserMaxResults : sig ... end
Sourcemodule JobSummaryList : sig ... end
Sourcemodule JobTemplateSummaryList : sig ... end
Sourcemodule IndexNamesList : sig ... end
Sourcemodule QueryMaxResults : sig ... end
Sourcemodule FleetMetricNameAndArnList : sig ... end
Sourcemodule DomainConfigurations : sig ... end
Sourcemodule DimensionNames : sig ... end
Sourcemodule MetricNames : sig ... end
Sourcemodule CommandSummaryList : sig ... end
Sourcemodule CommandMaxResults : sig ... end
Sourcemodule CommandNamespace : sig ... end
Sourcemodule SortOrder : sig ... end
Sourcemodule TimeFilter : sig ... end

A filter that can be used to list command executions for a device that started or completed before or after a particular date and time.

Sourcemodule Certificates : sig ... end
Sourcemodule CertificateProviders : sig ... end
Sourcemodule CACertificates : sig ... end
Sourcemodule Authorizers : sig ... end
Sourcemodule AuditTaskMetadataList : sig ... end
Sourcemodule AuditSuppressionList : sig ... end
Sourcemodule AuditFindings : sig ... end
Sourcemodule ListSuppressedFindings : sig ... end
Sourcemodule ActiveViolations : sig ... end
Sourcemodule VerboseFlag : sig ... end
Sourcemodule TopicRule : sig ... end

Describes a rule.

Sourcemodule TopicRuleDestination : sig ... end

A topic rule destination.

Sourcemodule ConnectivityApiThingName : sig ... end
Sourcemodule DisconnectReasonValue : sig ... end

The aggregation is invalid.

Sourcemodule Statistics : sig ... end

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.

Sourcemodule RegistrationCode : sig ... end
Sourcemodule Percentiles : sig ... end
Sourcemodule PercentList : sig ... end
Sourcemodule PackageVersionErrorReason : sig ... end
Sourcemodule Sbom : sig ... end

A specific software bill of matrerials associated with a software package version.

Sourcemodule SbomValidationStatus : sig ... end
Sourcemodule PackageArn : sig ... end
Sourcemodule OTAUpdateInfo : sig ... end

Information about an OTA update.

Sourcemodule JobDocument : sig ... end
Sourcemodule BeforeSubstitutionFlag : sig ... end
Sourcemodule EffectivePolicies : sig ... end
Sourcemodule CommandParameterList : sig ... end
Sourcemodule CommandPayload : sig ... end

The command payload object that contains the instructions for the device to process.

Sourcemodule CommandPreprocessor : sig ... end

Configuration that determines how the payloadTemplate is processed by the service to generate the final payload sent to devices at StartCommandExecution API invocation.

Sourcemodule CommandExecutionResultMap : sig ... end
Sourcemodule StatusReason : sig ... end

Provide additional context about the status of a command execution using a reason code and description.

Sourcemodule Buckets : sig ... end
Sourcemodule BucketsAggregationType : sig ... end

The type of bucketed aggregation performed.

Sourcemodule TinyMaxResults : sig ... end
Sourcemodule ThingTypeId : sig ... end
Sourcemodule Percentage : sig ... end
Sourcemodule DynamicGroupStatus : sig ... end
Sourcemodule ThingGroupMetadata : sig ... end

Thing group metadata.

Sourcemodule StreamInfo : sig ... end

Information about a stream.

Sourcemodule RoleAliasDescription : sig ... end

Role alias description.

Sourcemodule DocumentParameters : sig ... end
Sourcemodule JobDocumentSource : sig ... end
Sourcemodule Job : sig ... end

The Job object contains details about a job.

Sourcemodule JobExecution : sig ... end

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

Sourcemodule IndexSchema : sig ... end
Sourcemodule IndexStatus : sig ... end
Sourcemodule EndpointAddress : sig ... end
Sourcemodule EndpointType : sig ... end
Sourcemodule ConfigurationDetails : sig ... end

The encryption configuration details that include the status information of the Key Management Service (KMS) key and the KMS access role.

Sourcemodule DomainName : sig ... end
Sourcemodule DomainType : sig ... end
Sourcemodule ServerCertificates : sig ... end
Sourcemodule AuthorizerDescription : sig ... end

The authorizer description.

Sourcemodule CertificateDescription : sig ... end

Describes a certificate.

Sourcemodule CACertificateDescription : sig ... end

Describes a CA certificate.

Sourcemodule BillingGroupId : sig ... end
Sourcemodule BillingGroupMetadata : sig ... end

Additional information about the billing group.

Sourcemodule AuditDetails : sig ... end
Sourcemodule TaskStatistics : sig ... end

Statistics for the checks performed during the audit.

Sourcemodule UndoDeprecate : sig ... end
Sourcemodule DeleteConflictException : sig ... end

You can't delete the resource because it is attached to one or more resources.

Sourcemodule DeleteStream : sig ... end
Sourcemodule ForceDeleteAWSJob : sig ... end
Sourcemodule ForceFlag : sig ... end
Sourcemodule DomainConfigurationName : sig ... end
Sourcemodule StatusCode : sig ... end
Sourcemodule ForceDelete : sig ... end
Sourcemodule DeleteScheduledAudits : sig ... end

Configuration of the topic rule destination.

The number of policy versions exceeds the limit.

Sourcemodule SetAsDefault : sig ... end
Sourcemodule KeyPair : sig ... end

Describes a key pair.

Sourcemodule MalformedPolicyException : sig ... end

The policy documentation is not valid.

Service quota has been exceeded.

Sourcemodule TagMap : sig ... end
Sourcemodule AwsJobAbortConfig : sig ... end

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

Sourcemodule AwsJobTimeoutConfig : sig ... end

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.

Sourcemodule ServerCertificateArns : sig ... end
Sourcemodule CertificateSigningRequest : sig ... end
Sourcemodule ConfirmationToken : sig ... end
Sourcemodule ExpectedVersion : sig ... end

Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.

Validates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.

Sourcemodule UpdateThingTypeResponse : sig ... end

Updates a thing type.

Sourcemodule UpdateThingTypeRequest : sig ... end

Updates a thing type.

Sourcemodule UpdateThingResponse : sig ... end

The output from the UpdateThing operation.

Sourcemodule UpdateThingRequest : sig ... end

The input for the UpdateThing operation.

Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.

Updates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.

Sourcemodule UpdateThingGroupResponse : sig ... end

Update a thing group. Requires permission to access the UpdateThingGroup action.

Sourcemodule UpdateThingGroupRequest : sig ... end

Update a thing group. Requires permission to access the UpdateThingGroup action.

Sourcemodule UpdateStreamResponse : sig ... end

Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.

Sourcemodule UpdateStreamRequest : sig ... end

Updates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.

Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.

Updates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.

Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.

Updates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.

Sourcemodule UpdateRoleAliasResponse : sig ... end

Updates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

Sourcemodule UpdateRoleAliasRequest : sig ... end

Updates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

Updates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.

Updates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.

Updates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

Updates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

Sourcemodule UpdatePackageResponse : sig ... end

Updates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

Sourcemodule UpdatePackageRequest : sig ... end

Updates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

Updates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

Updates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.

Updates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.

Sourcemodule UpdateJobRequest : sig ... end

Updates supported fields of the specified job. Requires permission to access the UpdateJob action.

Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.

Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.

Sourcemodule UpdateFleetMetricRequest : sig ... end

Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.

Updates the event configurations. Requires permission to access the UpdateEventConfigurations action.

Updates the event configurations. Requires permission to access the UpdateEventConfigurations action.

Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account. Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.

Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account. Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.

Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.

Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.

Sourcemodule UpdateDimensionResponse : sig ... end

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action.

Sourcemodule UpdateDimensionRequest : sig ... end

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it). Requires permission to access the UpdateDimension action.

Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.

Sourcemodule UpdateCustomMetricRequest : sig ... end

Updates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.

Sourcemodule UpdateCommandResponse : sig ... end

Update information about a command or mark a command for deprecation.

Sourcemodule UpdateCommandRequest : sig ... end

Update information about a command or mark a command for deprecation.

Sourcemodule UpdateCertificateRequest : sig ... end

The input for the UpdateCertificate operation.

Updates a certificate provider. Requires permission to access the UpdateCertificateProvider action.

Updates a certificate provider. Requires permission to access the UpdateCertificateProvider action.

The input to the UpdateCACertificate operation.

Updates information about the billing group. Requires permission to access the UpdateBillingGroup action.

Sourcemodule UpdateBillingGroupRequest : sig ... end

Updates information about the billing group. Requires permission to access the UpdateBillingGroup action.

Sourcemodule UpdateAuthorizerResponse : sig ... end

Updates an authorizer. Requires permission to access the UpdateAuthorizer action.

Sourcemodule UpdateAuthorizerRequest : sig ... end

Updates an authorizer. Requires permission to access the UpdateAuthorizer action.

Updates a Device Defender audit suppression.

Updates a Device Defender audit suppression.

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action.

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled. Requires permission to access the UpdateAccountAuditConfiguration action.

Sourcemodule UntagResourceResponse : sig ... end

Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action.

Sourcemodule UntagResourceRequest : sig ... end

Removes the given tags (metadata) from the resource. Requires permission to access the UntagResource action.

The output from the TransferCertificate operation.

The input for the TransferCertificate operation.

You can't revert the certificate transfer because the transfer is already complete.

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestInvokeAuthorizer action.

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestInvokeAuthorizer action.

Sourcemodule TestAuthorizationResponse : sig ... end

Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action.

Sourcemodule TestAuthorizationRequest : sig ... end

Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the TestAuthorization action.

Sourcemodule TagResourceResponse : sig ... end

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource action.

Sourcemodule TagResourceRequest : sig ... end

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. Requires permission to access the TagResource action.

Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.

Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.

Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.

Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.

Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.

Starts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.

Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.

Starts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.

Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.

Starts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.

Sourcemodule SqlParseException : sig ... end

The Rule-SQL expression can't be parsed correctly.

Sets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.

Sourcemodule SetV2LoggingLevelRequest : sig ... end

Sets the logging level. Requires permission to access the SetV2LoggingLevel action.

Sourcemodule SetLoggingOptionsRequest : sig ... end

The input for the SetLoggingOptions operation.

The input for the SetDefaultPolicyVersion operation.

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.

Sourcemodule SearchIndexResponse : sig ... end

The query search index. Requires permission to access the SearchIndex action.

Sourcemodule SearchIndexRequest : sig ... end

The query search index. Requires permission to access the SearchIndex action.

Sourcemodule ReplaceTopicRuleRequest : sig ... end

The input for the ReplaceTopicRule operation.

Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group. Requires permission to access the RemoveThingFromThingGroup action.

Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group. Requires permission to access the RemoveThingFromThingGroup action.

Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action. This call is asynchronous. It might take several seconds for the detachment to propagate.

Removes the given thing from the billing group. Requires permission to access the RemoveThingFromBillingGroup action. This call is asynchronous. It might take several seconds for the detachment to propagate.

The input for the RejectCertificateTransfer operation.

Sourcemodule RegisterThingResponse : sig ... end

Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permission to access the RegisterThing action.

Sourcemodule RegisterThingRequest : sig ... end

Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary. Requires permission to access the RegisterThing action.