Package-level declarations

Types

Link copied to clipboard
data class AbortConfigProperties(val criteriaList: List<JobTemplateAbortCriteria>)

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

The configuration for a specific audit check.

data class AccountAuditConfigurationAuditCheckConfigurations(val authenticatedCognitoRoleOverlyPermissiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val caCertificateExpiringCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val caCertificateKeyQualityCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val conflictingClientIdsCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val deviceCertificateExpiringCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val deviceCertificateKeyQualityCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val deviceCertificateSharedCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val intermediateCaRevokedForActiveDeviceCertificatesCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val ioTPolicyPotentialMisConfigurationCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val iotPolicyOverlyPermissiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val iotRoleAliasAllowsAccessToUnusedServicesCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val iotRoleAliasOverlyPermissiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val loggingDisabledCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val revokedCaCertificateStillActiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val revokedDeviceCertificateStillActiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null, val unauthenticatedCognitoRoleOverlyPermissiveCheck: AccountAuditConfigurationAuditCheckConfiguration? = null)

Specifies which audit checks are enabled and disabled for this account.

data class AccountAuditConfigurationAuditNotificationTarget(val enabled: Boolean? = null, val roleArn: String? = null, val targetArn: String? = null)

Information about the targets to which audit notifications are sent.

Link copied to clipboard
data class BillingGroupPropertiesProperties(val billingGroupDescription: String? = null)

The properties of the billing group.

Link copied to clipboard
data class CaCertificateRegistrationConfig(val roleArn: String? = null, val templateBody: String? = null, val templateName: String? = null)
Link copied to clipboard
data class DomainConfigurationAuthorizerConfig(val allowAuthorizerOverride: Boolean? = null, val defaultAuthorizerName: String? = null)
data class DomainConfigurationServerCertificateConfig(val enableOcspCheck: Boolean? = null)
data class DomainConfigurationServerCertificateSummary(val serverCertificateArn: String? = null, val serverCertificateStatus: DomainConfigurationServerCertificateSummaryServerCertificateStatus? = null, val serverCertificateStatusDetail: String? = null)
Link copied to clipboard
data class DomainConfigurationTlsConfig(val securityPolicy: String? = null)
Link copied to clipboard
data class FleetMetricAggregationType(val name: String, val values: List<String>)

Aggregation types supported by Fleet Indexing

Link copied to clipboard
data class GetAccountAuditConfigurationResult(val auditCheckConfigurations: AccountAuditConfigurationAuditCheckConfigurations? = null, val auditNotificationTargetConfigurations: AccountAuditConfigurationAuditNotificationTargetConfigurations? = null, val roleArn: String? = null)
Link copied to clipboard
data class GetAuthorizerResult(val arn: String? = null, val authorizerFunctionArn: String? = null, val enableCachingForHttp: Boolean? = null, val status: AuthorizerStatus? = null, val tags: List<Tag>? = null, val tokenKeyName: String? = null, val tokenSigningPublicKeys: Map<String, String>? = null)
Link copied to clipboard
data class GetBillingGroupResult(val arn: String? = null, val billingGroupProperties: BillingGroupPropertiesProperties? = null, val id: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetCaCertificateResult(val arn: String? = null, val autoRegistrationStatus: CaCertificateAutoRegistrationStatus? = null, val id: String? = null, val registrationConfig: CaCertificateRegistrationConfig? = null, val status: CaCertificateStatus? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetCertificateProviderResult(val accountDefaultForOperations: List<CertificateProviderOperation>? = null, val arn: String? = null, val lambdaFunctionArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetCertificateResult(val arn: String? = null, val id: String? = null, val status: CertificateStatus? = null)
Link copied to clipboard
data class GetCustomMetricResult(val displayName: String? = null, val metricArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDimensionResult(val arn: String? = null, val stringValues: List<String>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDomainConfigurationResult(val arn: String? = null, val authorizerConfig: DomainConfigurationAuthorizerConfig? = null, val domainConfigurationStatus: DomainConfigurationStatus? = null, val domainType: DomainConfigurationDomainType? = null, val serverCertificateConfig: DomainConfigurationServerCertificateConfig? = null, val serverCertificates: List<DomainConfigurationServerCertificateSummary>? = null, val tags: List<Tag>? = null, val tlsConfig: DomainConfigurationTlsConfig? = null)
Link copied to clipboard
data class GetFleetMetricResult(val aggregationField: String? = null, val aggregationType: FleetMetricAggregationType? = null, val creationDate: String? = null, val description: String? = null, val indexName: String? = null, val lastModifiedDate: String? = null, val metricArn: String? = null, val period: Int? = null, val queryString: String? = null, val queryVersion: String? = null, val tags: List<Tag>? = null, val unit: String? = null, val version: Double? = null)
Link copied to clipboard
data class GetJobTemplateResult(val arn: String? = null)
Link copied to clipboard
data class GetLoggingResult(val defaultLogLevel: LoggingDefaultLogLevel? = null, val roleArn: String? = null)
Link copied to clipboard
data class GetMitigationActionResult(val actionParams: MitigationActionActionParams? = null, val mitigationActionArn: String? = null, val mitigationActionId: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetPolicyResult(val arn: String? = null, val id: String? = null, val policyDocument: Any? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetProvisioningTemplateResult(val description: String? = null, val enabled: Boolean? = null, val preProvisioningHook: ProvisioningTemplateProvisioningHook? = null, val provisioningRoleArn: String? = null, val tags: List<Tag>? = null, val templateArn: String? = null, val templateBody: String? = null)
Link copied to clipboard
data class GetResourceSpecificLoggingResult(val logLevel: ResourceSpecificLoggingLogLevel? = null, val targetId: String? = null)
Link copied to clipboard
data class GetRoleAliasResult(val credentialDurationSeconds: Int? = null, val roleAliasArn: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetScheduledAuditResult(val dayOfMonth: String? = null, val dayOfWeek: ScheduledAuditDayOfWeek? = null, val frequency: ScheduledAuditFrequency? = null, val scheduledAuditArn: String? = null, val tags: List<Tag>? = null, val targetCheckNames: List<String>? = null)
Link copied to clipboard
data class GetSecurityProfileResult(val additionalMetricsToRetainV2: List<SecurityProfileMetricToRetain>? = null, val alertTargets: Map<String, SecurityProfileAlertTarget>? = null, val behaviors: List<SecurityProfileBehavior>? = null, val metricsExportConfig: MetricsExportConfigProperties? = null, val securityProfileArn: String? = null, val securityProfileDescription: String? = null, val tags: List<Tag>? = null, val targetArns: List<String>? = null)
Link copied to clipboard
data class GetSoftwarePackageResult(val description: String? = null, val packageArn: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetSoftwarePackageVersionResult(val attributes: Map<String, String>? = null, val description: String? = null, val errorReason: String? = null, val packageVersionArn: String? = null, val status: SoftwarePackageVersionPackageVersionStatus? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetThingGroupResult(val arn: String? = null, val id: String? = null, val queryString: String? = null, val tags: List<Tag>? = null, val thingGroupProperties: ThingGroupPropertiesProperties? = null)
Link copied to clipboard
data class GetThingResult(val arn: String? = null, val attributePayload: ThingAttributePayload? = null, val id: String? = null)
Link copied to clipboard
data class GetThingTypeResult(val arn: String? = null, val deprecateThingType: Boolean? = null, val id: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetTopicRuleDestinationResult(val arn: String? = null, val status: TopicRuleDestinationStatus? = null, val statusReason: String? = null)
Link copied to clipboard
data class GetTopicRuleResult(val arn: String? = null, val tags: List<Tag>? = null, val topicRulePayload: TopicRulePayload? = null)
Link copied to clipboard
data class JobExecutionsRetryConfigProperties(val retryCriteriaList: List<JobTemplateRetryCriteria>? = null)

Allows you to create the criteria to retry a job.

Link copied to clipboard
data class JobExecutionsRolloutConfigProperties(val exponentialRolloutRate: JobTemplateExponentialRolloutRate? = null, val maximumPerMinute: Int? = null)

Allows you to create a staged rollout of a job.

Link copied to clipboard
data class JobTemplateAbortCriteria(val action: JobTemplateAction, val failureType: JobTemplateFailureType, val minNumberOfExecutedThings: Int, val thresholdPercentage: Double)

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

Link copied to clipboard
data class JobTemplateExponentialRolloutRate(val baseRatePerMinute: Int, val incrementFactor: Double, val rateIncreaseCriteria: JobTemplateRateIncreaseCriteria)

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

Link copied to clipboard
data class JobTemplateMaintenanceWindow(val durationInMinutes: Int? = null, val startTime: String? = null)

Specifies a start time and duration for a scheduled Job.

Link copied to clipboard
data class JobTemplateRateIncreaseCriteria(val numberOfNotifiedThings: Int? = null, val numberOfSucceededThings: Int? = null)
Link copied to clipboard
data class JobTemplateRetryCriteria(val failureType: JobTemplateJobRetryFailureType? = null, val numberOfRetries: Int? = null)

Specifies how many times a failure type should be retried.

Link copied to clipboard
data class MetricsExportConfigProperties(val mqttTopic: String, val roleArn: String)

A structure containing the mqtt topic for metrics export.

Link copied to clipboard
data class MitigationActionActionParams(val addThingsToThingGroupParams: MitigationActionAddThingsToThingGroupParams? = null, val enableIoTLoggingParams: MitigationActionEnableIoTLoggingParams? = null, val publishFindingToSnsParams: MitigationActionPublishFindingToSnsParams? = null, val replaceDefaultPolicyVersionParams: MitigationActionReplaceDefaultPolicyVersionParams? = null, val updateCaCertificateParams: MitigationActionUpdateCaCertificateParams? = null, val updateDeviceCertificateParams: MitigationActionUpdateDeviceCertificateParams? = null)

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

data class MitigationActionAddThingsToThingGroupParams(val overrideDynamicGroups: Boolean? = null, val thingGroupNames: List<String>)

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

Link copied to clipboard

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

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.

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.

Link copied to clipboard
data class PresignedUrlConfigProperties(val expiresInSec: Int? = null, val roleArn: String)

Configuration for pre-signed S3 URLs.

Link copied to clipboard
data class ProvisioningTemplateProvisioningHook(val payloadVersion: String? = null, val targetArn: String? = null)
Link copied to clipboard
data class SecurityProfileAlertTarget(val alertTargetArn: String, val roleArn: String)

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

Link copied to clipboard
data class SecurityProfileBehavior(val criteria: SecurityProfileBehaviorCriteria? = null, val exportMetric: Boolean? = null, val metric: String? = null, val metricDimension: SecurityProfileMetricDimension? = null, val name: String, val suppressAlerts: Boolean? = null)

A security profile behavior.

Link copied to clipboard
data class SecurityProfileBehaviorCriteria(val comparisonOperator: SecurityProfileBehaviorCriteriaComparisonOperator? = null, val consecutiveDatapointsToAlarm: Int? = null, val consecutiveDatapointsToClear: Int? = null, val durationSeconds: Int? = null, val mlDetectionConfig: SecurityProfileMachineLearningDetectionConfig? = null, val statisticalThreshold: SecurityProfileStatisticalThreshold? = null, val value: SecurityProfileMetricValue? = null)

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

The configuration of an ML Detect Security Profile.

Link copied to clipboard
data class SecurityProfileMetricDimension(val dimensionName: String, val operator: SecurityProfileMetricDimensionOperator? = null)

The dimension of a metric.

Link copied to clipboard
data class SecurityProfileMetricToRetain(val exportMetric: Boolean? = null, val metric: String, val metricDimension: SecurityProfileMetricDimension? = null)

The metric you want to retain. Dimensions are optional.

Link copied to clipboard
data class SecurityProfileMetricValue(val cidrs: List<String>? = null, val count: String? = null, val number: Double? = null, val numbers: List<Double>? = null, val ports: List<Int>? = null, val strings: List<String>? = null)

The value to be compared with the metric.

Link copied to clipboard

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

Link copied to clipboard
data class ThingAttributePayload(val attributes: Map<String, String>? = null)
Link copied to clipboard
data class ThingGroupAttributePayload(val attributes: Map<String, String>? = null)
Link copied to clipboard
data class ThingGroupPropertiesProperties(val attributePayload: ThingGroupAttributePayload? = null, val thingGroupDescription: String? = null)

Thing group properties.

Link copied to clipboard
data class ThingTypePropertiesProperties(val searchableAttributes: List<String>? = null, val thingTypeDescription: String? = null)

The thing type properties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names. ThingTypeProperties can't be updated after the initial creation of the ThingType .

Link copied to clipboard
data class TimeoutConfigProperties(val inProgressTimeoutInMinutes: Int)

Specifies the amount of time each device has to finish its execution of the job.

Link copied to clipboard
data class TopicRuleAction(val cloudwatchAlarm: TopicRuleCloudwatchAlarmAction? = null, val cloudwatchLogs: TopicRuleCloudwatchLogsAction? = null, val cloudwatchMetric: TopicRuleCloudwatchMetricAction? = null, val dynamoDBv2: TopicRuleDynamoDBv2Action? = null, val dynamoDb: TopicRuleDynamoDbAction? = null, val elasticsearch: TopicRuleElasticsearchAction? = null, val firehose: TopicRuleFirehoseAction? = null, val http: TopicRuleHttpAction? = null, val iotAnalytics: TopicRuleIotAnalyticsAction? = null, val iotEvents: TopicRuleIotEventsAction? = null, val iotSiteWise: TopicRuleIotSiteWiseAction? = null, val kafka: TopicRuleKafkaAction? = null, val kinesis: TopicRuleKinesisAction? = null, val lambda: TopicRuleLambdaAction? = null, val location: TopicRuleLocationAction? = null, val openSearch: TopicRuleOpenSearchAction? = null, val republish: TopicRuleRepublishAction? = null, val s3: TopicRuleS3Action? = null, val sns: TopicRuleSnsAction? = null, val sqs: TopicRuleSqsAction? = null, val stepFunctions: TopicRuleStepFunctionsAction? = null, val timestream: TopicRuleTimestreamAction? = null)
Link copied to clipboard
data class TopicRuleAssetPropertyTimestamp(val offsetInNanos: String? = null, val timeInSeconds: String)
Link copied to clipboard
data class TopicRuleAssetPropertyValue(val quality: String? = null, val timestamp: TopicRuleAssetPropertyTimestamp, val value: TopicRuleAssetPropertyVariant)
Link copied to clipboard
data class TopicRuleAssetPropertyVariant(val booleanValue: String? = null, val doubleValue: String? = null, val integerValue: String? = null, val stringValue: String? = null)
Link copied to clipboard
data class TopicRuleCloudwatchAlarmAction(val alarmName: String, val roleArn: String, val stateReason: String, val stateValue: String)
Link copied to clipboard
data class TopicRuleCloudwatchLogsAction(val batchMode: Boolean? = null, val logGroupName: String, val roleArn: String)
Link copied to clipboard
data class TopicRuleCloudwatchMetricAction(val metricName: String, val metricNamespace: String, val metricTimestamp: String? = null, val metricUnit: String, val metricValue: String, val roleArn: String)
data class TopicRuleDestinationHttpUrlDestinationSummary(val confirmationUrl: String? = null)
data class TopicRuleDestinationVpcDestinationProperties(val roleArn: String? = null, val securityGroups: List<String>? = null, val subnetIds: List<String>? = null, val vpcId: String? = null)
Link copied to clipboard
data class TopicRuleDynamoDbAction(val hashKeyField: String, val hashKeyType: String? = null, val hashKeyValue: String, val payloadField: String? = null, val rangeKeyField: String? = null, val rangeKeyType: String? = null, val rangeKeyValue: String? = null, val roleArn: String, val tableName: String)
Link copied to clipboard
data class TopicRuleDynamoDBv2Action(val putItem: TopicRulePutItemInput? = null, val roleArn: String? = null)
Link copied to clipboard
data class TopicRuleElasticsearchAction(val endpoint: String, val id: String, val index: String, val roleArn: String, val type: String)
Link copied to clipboard
data class TopicRuleFirehoseAction(val batchMode: Boolean? = null, val deliveryStreamName: String, val roleArn: String, val separator: String? = null)
Link copied to clipboard
data class TopicRuleHttpAction(val auth: TopicRuleHttpAuthorization? = null, val confirmationUrl: String? = null, val headers: List<TopicRuleHttpActionHeader>? = null, val url: String)
Link copied to clipboard
data class TopicRuleHttpActionHeader(val key: String, val value: String)
Link copied to clipboard
Link copied to clipboard
data class TopicRuleIotAnalyticsAction(val batchMode: Boolean? = null, val channelName: String, val roleArn: String)
Link copied to clipboard
data class TopicRuleIotEventsAction(val batchMode: Boolean? = null, val inputName: String, val messageId: String? = null, val roleArn: String)
Link copied to clipboard
data class TopicRuleIotSiteWiseAction(val putAssetPropertyValueEntries: List<TopicRulePutAssetPropertyValueEntry>, val roleArn: String)
Link copied to clipboard
data class TopicRuleKafkaAction(val clientProperties: Map<String, String>, val destinationArn: String, val headers: List<TopicRuleKafkaActionHeader>? = null, val key: String? = null, val partition: String? = null, val topic: String)
Link copied to clipboard
data class TopicRuleKafkaActionHeader(val key: String, val value: String)
Link copied to clipboard
data class TopicRuleKinesisAction(val partitionKey: String? = null, val roleArn: String, val streamName: String)
Link copied to clipboard
data class TopicRuleLambdaAction(val functionArn: String? = null)
Link copied to clipboard
data class TopicRuleLocationAction(val deviceId: String, val latitude: String, val longitude: String, val roleArn: String, val timestamp: TopicRuleTimestamp? = null, val trackerName: String)
Link copied to clipboard
data class TopicRuleOpenSearchAction(val endpoint: String, val id: String, val index: String, val roleArn: String, val type: String)
Link copied to clipboard
data class TopicRulePayload(val actions: List<TopicRuleAction>, val awsIotSqlVersion: String? = null, val description: String? = null, val errorAction: TopicRuleAction? = null, val ruleDisabled: Boolean? = null, val sql: String)
Link copied to clipboard
data class TopicRulePutAssetPropertyValueEntry(val assetId: String? = null, val entryId: String? = null, val propertyAlias: String? = null, val propertyId: String? = null, val propertyValues: List<TopicRuleAssetPropertyValue>)
Link copied to clipboard
data class TopicRulePutItemInput(val tableName: String)
Link copied to clipboard
data class TopicRuleRepublishAction(val headers: TopicRuleRepublishActionHeaders? = null, val qos: Int? = null, val roleArn: String, val topic: String)
Link copied to clipboard
data class TopicRuleRepublishActionHeaders(val contentType: String? = null, val correlationData: String? = null, val messageExpiry: String? = null, val payloadFormatIndicator: String? = null, val responseTopic: String? = null, val userProperties: List<TopicRuleUserProperty>? = null)
Link copied to clipboard
data class TopicRuleS3Action(val bucketName: String, val cannedAcl: TopicRuleCannedAccessControlList? = null, val key: String, val roleArn: String)
Link copied to clipboard
data class TopicRuleSigV4Authorization(val roleArn: String, val serviceName: String, val signingRegion: String)
Link copied to clipboard
data class TopicRuleSnsAction(val messageFormat: String? = null, val roleArn: String, val targetArn: String)
Link copied to clipboard
data class TopicRuleSqsAction(val queueUrl: String, val roleArn: String, val useBase64: Boolean? = null)
Link copied to clipboard
data class TopicRuleStepFunctionsAction(val executionNamePrefix: String? = null, val roleArn: String, val stateMachineName: String)
Link copied to clipboard
data class TopicRuleTimestamp(val unit: String? = null, val value: String)
Link copied to clipboard
data class TopicRuleTimestreamAction(val databaseName: String, val dimensions: List<TopicRuleTimestreamDimension>, val roleArn: String, val tableName: String, val timestamp: TopicRuleTimestreamTimestamp? = null)
Link copied to clipboard
data class TopicRuleTimestreamDimension(val name: String, val value: String)
Link copied to clipboard
data class TopicRuleTimestreamTimestamp(val unit: String, val value: String)
Link copied to clipboard
data class TopicRuleUserProperty(val key: String, val value: String)