types

package
v1.61.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 4 Imported by: 10

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortAction 

type AbortAction string
const (
	AbortActionCancel AbortAction = "CANCEL"
)

Enum values for AbortAction

func (AbortAction) Values added in v0.29.0 

func (AbortAction) Values() []AbortAction

Values returns all known values for AbortAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AbortConfig 

type AbortConfig struct {

	// The list of criteria that determine when and how to abort the job.
	//
	// This member is required.
	CriteriaList []AbortCriteria
	// contains filtered or unexported fields
}

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

type AbortCriteria 

type AbortCriteria struct {

	// The type of job action to take to initiate the job abort.
	//
	// This member is required.
	Action AbortAction

	// The type of job execution failures that can initiate a job abort.
	//
	// This member is required.
	FailureType JobExecutionFailureType

	// The minimum number of things which must receive job execution notifications
	// before the job can be aborted.
	//
	// This member is required.
	MinNumberOfExecutedThings *int32

	// The minimum percentage of job execution failures that must occur to initiate
	// the job abort.
	//
	// Amazon Web Services IoT Core supports up to two digits after the decimal (for
	// example, 10.9 and 10.99, but not 10.999).
	//
	// This member is required.
	ThresholdPercentage *float64
	// contains filtered or unexported fields
}

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

type Action 

type Action struct {

	// Change the state of a CloudWatch alarm.
	CloudwatchAlarm *CloudwatchAlarmAction

	// Send data to CloudWatch Logs.
	CloudwatchLogs *CloudwatchLogsAction

	// Capture a CloudWatch metric.
	CloudwatchMetric *CloudwatchMetricAction

	// Write to a DynamoDB table.
	DynamoDB *DynamoDBAction

	// Write to a DynamoDB table. This is a new version of the DynamoDB action. It
	// allows you to write each attribute in an MQTT message payload into a separate
	// DynamoDB column.
	DynamoDBv2 *DynamoDBv2Action

	// Write 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].
	//
	// [OpenSearchAction]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html
	Elasticsearch *ElasticsearchAction

	// Write to an Amazon Kinesis Firehose stream.
	Firehose *FirehoseAction

	// Send data to an HTTPS endpoint.
	Http *HttpAction

	// Sends message data to an IoT Analytics channel.
	IotAnalytics *IotAnalyticsAction

	// Sends an input to an IoT Events detector.
	IotEvents *IotEventsAction

	// Sends data from the MQTT message that triggered the rule to IoT SiteWise asset
	// properties.
	IotSiteWise *IotSiteWiseAction

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

	// Write data to an Amazon Kinesis stream.
	Kinesis *KinesisAction

	// Invoke a Lambda function.
	Lambda *LambdaAction

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

	// Write data to an Amazon OpenSearch Service domain.
	OpenSearch *OpenSearchAction

	// Publish to another MQTT topic.
	Republish *RepublishAction

	// Write to an Amazon S3 bucket.
	S3 *S3Action

	// Send a message to a Salesforce IoT Cloud Input Stream.
	Salesforce *SalesforceAction

	// Publish to an Amazon SNS topic.
	Sns *SnsAction

	// Publish to an Amazon SQS queue.
	Sqs *SqsAction

	// Starts execution of a Step Functions state machine.
	StepFunctions *StepFunctionsAction

	// 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.
	//
	// [Timestream]: https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html
	Timestream *TimestreamAction
	// contains filtered or unexported fields
}

Describes the actions associated with a rule.

type ActionType 

type ActionType string
const (
	ActionTypePublish   ActionType = "PUBLISH"
	ActionTypeSubscribe ActionType = "SUBSCRIBE"
	ActionTypeReceive   ActionType = "RECEIVE"
	ActionTypeConnect   ActionType = "CONNECT"
)

Enum values for ActionType

func (ActionType) Values added in v0.29.0 

func (ActionType) Values() []ActionType

Values returns all known values for ActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ActiveViolation 

type ActiveViolation struct {

	// The behavior that is being violated.
	Behavior *Behavior

	// The time the most recent violation occurred.
	LastViolationTime *time.Time

	// The value of the metric (the measurement) that caused the most recent violation.
	LastViolationValue *MetricValue

	// The security profile with the behavior is in violation.
	SecurityProfileName *string

	// The name of the thing responsible for the active violation.
	ThingName *string

	// The verification state of the violation (detect alarm).
	VerificationState VerificationState

	// The description of the verification state of the violation.
	VerificationStateDescription *string

	//  The details of a violation event.
	ViolationEventAdditionalInfo *ViolationEventAdditionalInfo

	// The ID of the active violation.
	ViolationId *string

	// The time the violation started.
	ViolationStartTime *time.Time
	// contains filtered or unexported fields
}

Information about an active Device Defender security profile behavior violation.

type AddThingsToThingGroupParams 

type AddThingsToThingGroupParams struct {

	// The list of groups to which you want to add the things that triggered the
	// mitigation action. You can add a thing to a maximum of 10 groups, but you can't
	// add a thing to more than one group in the same hierarchy.
	//
	// This member is required.
	ThingGroupNames []string

	// Specifies if this mitigation action can move the things that triggered the
	// mitigation action even if they are part of one or more dynamic thing groups.
	OverrideDynamicGroups *bool
	// contains filtered or unexported fields
}

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

type AggregationType added in v1.11.0 

type AggregationType struct {

	// The name of the aggregation type.
	//
	// This member is required.
	Name AggregationTypeName

	// A list of the values of aggregation types.
	Values []string
	// contains filtered or unexported fields
}

The type of aggregation queries.

type AggregationTypeName added in v1.11.0 

type AggregationTypeName string
const (
	AggregationTypeNameStatistics  AggregationTypeName = "Statistics"
	AggregationTypeNamePercentiles AggregationTypeName = "Percentiles"
	AggregationTypeNameCardinality AggregationTypeName = "Cardinality"
)

Enum values for AggregationTypeName

func (AggregationTypeName) Values added in v1.11.0 

func (AggregationTypeName) Values() []AggregationTypeName

Values returns all known values for AggregationTypeName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AlertTarget 

type AlertTarget struct {

	// The Amazon Resource Name (ARN) of the notification target to which alerts are
	// sent.
	//
	// This member is required.
	AlertTargetArn *string

	// The ARN of the role that grants permission to send alerts to the notification
	// target.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

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

type AlertTargetType 

type AlertTargetType string
const (
	AlertTargetTypeSns AlertTargetType = "SNS"
)

Enum values for AlertTargetType

func (AlertTargetType) Values added in v0.29.0 

func (AlertTargetType) Values() []AlertTargetType

Values returns all known values for AlertTargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Allowed 

type Allowed struct {

	// A list of policies that allowed the authentication.
	Policies []Policy
	// contains filtered or unexported fields
}

Contains information that allowed the authorization.

type ApplicationProtocol added in v1.58.0 

type ApplicationProtocol string
const (
	ApplicationProtocolSecureMqtt ApplicationProtocol = "SECURE_MQTT"
	ApplicationProtocolMqttWss    ApplicationProtocol = "MQTT_WSS"
	ApplicationProtocolHttps      ApplicationProtocol = "HTTPS"
	ApplicationProtocolDefault    ApplicationProtocol = "DEFAULT"
)

Enum values for ApplicationProtocol

func (ApplicationProtocol) Values added in v1.58.0 

func (ApplicationProtocol) Values() []ApplicationProtocol

Values returns all known values for ApplicationProtocol. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssetPropertyTimestamp 

type AssetPropertyTimestamp struct {

	// A string that contains the time in seconds since epoch. Accepts substitution
	// templates.
	//
	// This member is required.
	TimeInSeconds *string

	// Optional. A string that contains the nanosecond time offset. Accepts
	// substitution templates.
	OffsetInNanos *string
	// contains filtered or unexported fields
}

An asset property timestamp entry containing the following information.

type AssetPropertyValue 

type AssetPropertyValue struct {

	// The asset property value timestamp.
	//
	// This member is required.
	Timestamp *AssetPropertyTimestamp

	// The value of the asset property.
	//
	// This member is required.
	Value AssetPropertyVariant

	// Optional. A string that describes the quality of the value. Accepts
	// substitution templates. Must be GOOD , BAD , or UNCERTAIN .
	Quality *string
	// contains filtered or unexported fields
}

An asset property value entry containing the following information.

type AssetPropertyVariant 

type AssetPropertyVariant interface {
	// contains filtered or unexported methods
}

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

The following types satisfy this interface: 

AssetPropertyVariantMemberBooleanValue
AssetPropertyVariantMemberDoubleValue
AssetPropertyVariantMemberIntegerValue
AssetPropertyVariantMemberStringValue
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iot/types"
)

func main() {
	var union types.AssetPropertyVariant
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AssetPropertyVariantMemberBooleanValue:
		_ = v.Value // Value is string

	case *types.AssetPropertyVariantMemberDoubleValue:
		_ = v.Value // Value is string

	case *types.AssetPropertyVariantMemberIntegerValue:
		_ = v.Value // Value is string

	case *types.AssetPropertyVariantMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *string
var _ *string
var _ *string
var _ *string

Output:

type AssetPropertyVariantMemberBooleanValue added in v0.31.0 

type AssetPropertyVariantMemberBooleanValue struct {
	Value string
	// contains filtered or unexported fields
}

Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.

type AssetPropertyVariantMemberDoubleValue added in v0.31.0 

type AssetPropertyVariantMemberDoubleValue struct {
	Value string
	// contains filtered or unexported fields
}

Optional. A string that contains the double value of the value entry. Accepts substitution templates.

type AssetPropertyVariantMemberIntegerValue added in v0.31.0 

type AssetPropertyVariantMemberIntegerValue struct {
	Value string
	// contains filtered or unexported fields
}

Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

type AssetPropertyVariantMemberStringValue added in v0.31.0 

type AssetPropertyVariantMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

Optional. The string value of the value entry. Accepts substitution templates.

type AttributePayload 

type AttributePayload struct {

	// A JSON string containing up to three key-value pair in JSON format. For example:
	//
	//     {\"attributes\":{\"string1\":\"string2\"}}
	Attributes map[string]string

	// Specifies whether the list of attributes provided in the AttributePayload is
	// merged with the attributes stored in the registry, instead of overwriting them.
	//
	// To remove an attribute, call UpdateThing with an empty attribute value.
	//
	// The merge attribute is only valid when calling UpdateThing or UpdateThingGroup .
	Merge bool
	// contains filtered or unexported fields
}

The attribute payload.

type AuditCheckConfiguration 

type AuditCheckConfiguration struct {

	// True if this audit check is enabled for this account.
	Enabled bool
	// contains filtered or unexported fields
}

Which audit checks are enabled and disabled for this account.

type AuditCheckDetails 

type AuditCheckDetails struct {

	// True if the check is complete and found all resources compliant.
	CheckCompliant *bool

	// The completion status of this check. One of "IN_PROGRESS",
	// "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT",
	// "COMPLETED_NON_COMPLIANT", or "FAILED".
	CheckRunStatus AuditCheckRunStatus

	// The code of any error encountered when this check is performed during this
	// audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
	ErrorCode *string

	// The message associated with any error encountered when this check is performed
	// during this audit.
	Message *string

	// The number of resources that were found noncompliant during the check.
	NonCompliantResourcesCount *int64

	//  Describes how many of the non-compliant resources created during the
	// evaluation of an audit check were marked as suppressed.
	SuppressedNonCompliantResourcesCount *int64

	// The number of resources on which the check was performed.
	TotalResourcesCount *int64
	// contains filtered or unexported fields
}

Information about the audit check.

type AuditCheckRunStatus 

type AuditCheckRunStatus string
const (
	AuditCheckRunStatusInProgress               AuditCheckRunStatus = "IN_PROGRESS"
	AuditCheckRunStatusWaitingForDataCollection AuditCheckRunStatus = "WAITING_FOR_DATA_COLLECTION"
	AuditCheckRunStatusCanceled                 AuditCheckRunStatus = "CANCELED"
	AuditCheckRunStatusCompletedCompliant       AuditCheckRunStatus = "COMPLETED_COMPLIANT"
	AuditCheckRunStatusCompletedNonCompliant    AuditCheckRunStatus = "COMPLETED_NON_COMPLIANT"
	AuditCheckRunStatusFailed                   AuditCheckRunStatus = "FAILED"
)

Enum values for AuditCheckRunStatus

func (AuditCheckRunStatus) Values added in v0.29.0 

func (AuditCheckRunStatus) Values() []AuditCheckRunStatus

Values returns all known values for AuditCheckRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditFinding 

type AuditFinding struct {

	// The audit check that generated this result.
	CheckName *string

	// A unique identifier for this set of audit findings. This identifier is used to
	// apply mitigation tasks to one or more sets of findings.
	FindingId *string

	// The time the result (finding) was discovered.
	FindingTime *time.Time

	//  Indicates whether the audit finding was suppressed or not during reporting.
	IsSuppressed *bool

	// The resource that was found to be noncompliant with the audit check.
	NonCompliantResource *NonCompliantResource

	// The reason the resource was noncompliant.
	ReasonForNonCompliance *string

	// A code that indicates the reason that the resource was noncompliant.
	ReasonForNonComplianceCode *string

	// The list of related resources.
	RelatedResources []RelatedResource

	// The severity of the result (finding).
	Severity AuditFindingSeverity

	// The ID of the audit that generated this result (finding).
	TaskId *string

	// The time the audit started.
	TaskStartTime *time.Time
	// contains filtered or unexported fields
}

The findings (results) of the audit.

type AuditFindingSeverity 

type AuditFindingSeverity string
const (
	AuditFindingSeverityCritical AuditFindingSeverity = "CRITICAL"
	AuditFindingSeverityHigh     AuditFindingSeverity = "HIGH"
	AuditFindingSeverityMedium   AuditFindingSeverity = "MEDIUM"
	AuditFindingSeverityLow      AuditFindingSeverity = "LOW"
)

Enum values for AuditFindingSeverity

func (AuditFindingSeverity) Values added in v0.29.0 

func (AuditFindingSeverity) Values() []AuditFindingSeverity

Values returns all known values for AuditFindingSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditFrequency 

type AuditFrequency string
const (
	AuditFrequencyDaily    AuditFrequency = "DAILY"
	AuditFrequencyWeekly   AuditFrequency = "WEEKLY"
	AuditFrequencyBiweekly AuditFrequency = "BIWEEKLY"
	AuditFrequencyMonthly  AuditFrequency = "MONTHLY"
)

Enum values for AuditFrequency

func (AuditFrequency) Values added in v0.29.0 

func (AuditFrequency) Values() []AuditFrequency

Values returns all known values for AuditFrequency. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditMitigationActionExecutionMetadata 

type AuditMitigationActionExecutionMetadata struct {

	// The unique identifier for the mitigation action being applied by the task.
	ActionId *string

	// The friendly name of the mitigation action being applied by the task.
	ActionName *string

	// The date and time when the task was completed or canceled. Blank if the task is
	// still running.
	EndTime *time.Time

	// If an error occurred, the code that indicates which type of error occurred.
	ErrorCode *string

	// The unique identifier for the findings to which the task and associated
	// mitigation action are applied.
	FindingId *string

	// If an error occurred, a message that describes the error.
	Message *string

	// The date and time when the task was started.
	StartTime *time.Time

	// The current status of the task being executed.
	Status AuditMitigationActionsExecutionStatus

	// The unique identifier for the task that applies the mitigation action.
	TaskId *string
	// contains filtered or unexported fields
}

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

type AuditMitigationActionsExecutionStatus 

type AuditMitigationActionsExecutionStatus string
const (
	AuditMitigationActionsExecutionStatusInProgress AuditMitigationActionsExecutionStatus = "IN_PROGRESS"
	AuditMitigationActionsExecutionStatusCompleted  AuditMitigationActionsExecutionStatus = "COMPLETED"
	AuditMitigationActionsExecutionStatusFailed     AuditMitigationActionsExecutionStatus = "FAILED"
	AuditMitigationActionsExecutionStatusCanceled   AuditMitigationActionsExecutionStatus = "CANCELED"
	AuditMitigationActionsExecutionStatusSkipped    AuditMitigationActionsExecutionStatus = "SKIPPED"
	AuditMitigationActionsExecutionStatusPending    AuditMitigationActionsExecutionStatus = "PENDING"
)

Enum values for AuditMitigationActionsExecutionStatus

func (AuditMitigationActionsExecutionStatus) Values added in v0.29.0 

func (AuditMitigationActionsExecutionStatus) Values() []AuditMitigationActionsExecutionStatus

Values returns all known values for AuditMitigationActionsExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditMitigationActionsTaskMetadata 

type AuditMitigationActionsTaskMetadata struct {

	// The time at which the audit mitigation actions task was started.
	StartTime *time.Time

	// The unique identifier for the task.
	TaskId *string

	// The current state of the audit mitigation actions task.
	TaskStatus AuditMitigationActionsTaskStatus
	// contains filtered or unexported fields
}

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

type AuditMitigationActionsTaskStatus 

type AuditMitigationActionsTaskStatus string
const (
	AuditMitigationActionsTaskStatusInProgress AuditMitigationActionsTaskStatus = "IN_PROGRESS"
	AuditMitigationActionsTaskStatusCompleted  AuditMitigationActionsTaskStatus = "COMPLETED"
	AuditMitigationActionsTaskStatusFailed     AuditMitigationActionsTaskStatus = "FAILED"
	AuditMitigationActionsTaskStatusCanceled   AuditMitigationActionsTaskStatus = "CANCELED"
)

Enum values for AuditMitigationActionsTaskStatus

func (AuditMitigationActionsTaskStatus) Values added in v0.29.0 

func (AuditMitigationActionsTaskStatus) Values() []AuditMitigationActionsTaskStatus

Values returns all known values for AuditMitigationActionsTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditMitigationActionsTaskTarget 

type AuditMitigationActionsTaskTarget struct {

	// Specifies a filter in the form of an audit check and set of reason codes that
	// identify the findings from the audit to which the audit mitigation actions task
	// apply.
	AuditCheckToReasonCodeFilter map[string][]string

	// If the task will apply a mitigation action to findings from a specific audit,
	// this value uniquely identifies the audit.
	AuditTaskId *string

	// If the task will apply a mitigation action to one or more listed findings, this
	// value uniquely identifies those findings.
	FindingIds []string
	// contains filtered or unexported fields
}

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

type AuditNotificationTarget 

type AuditNotificationTarget struct {

	// True if notifications to the target are enabled.
	Enabled bool

	// The ARN of the role that grants permission to send notifications to the target.
	RoleArn *string

	// The ARN of the target (SNS topic) to which audit notifications are sent.
	TargetArn *string
	// contains filtered or unexported fields
}

Information about the targets to which audit notifications are sent.

type AuditNotificationType 

type AuditNotificationType string
const (
	AuditNotificationTypeSns AuditNotificationType = "SNS"
)

Enum values for AuditNotificationType

func (AuditNotificationType) Values added in v0.29.0 

func (AuditNotificationType) Values() []AuditNotificationType

Values returns all known values for AuditNotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditSuppression added in v0.29.0 

type AuditSuppression struct {

	// 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.)
	//
	// This member is required.
	CheckName *string

	// Information that identifies the noncompliant resource.
	//
	// This member is required.
	ResourceIdentifier *ResourceIdentifier

	//  The description of the audit suppression.
	Description *string

	//  The expiration date (epoch timestamp in seconds) that you want the suppression
	// to adhere to.
	ExpirationDate *time.Time

	//  Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool
	// contains filtered or unexported fields
}

Filters out specific findings of a Device Defender audit.

type AuditTaskMetadata 

type AuditTaskMetadata struct {

	// The ID of this audit.
	TaskId *string

	// The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or
	// "CANCELED".
	TaskStatus AuditTaskStatus

	// The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
	TaskType AuditTaskType
	// contains filtered or unexported fields
}

The audits that were performed.

type AuditTaskStatus 

type AuditTaskStatus string
const (
	AuditTaskStatusInProgress AuditTaskStatus = "IN_PROGRESS"
	AuditTaskStatusCompleted  AuditTaskStatus = "COMPLETED"
	AuditTaskStatusFailed     AuditTaskStatus = "FAILED"
	AuditTaskStatusCanceled   AuditTaskStatus = "CANCELED"
)

Enum values for AuditTaskStatus

func (AuditTaskStatus) Values added in v0.29.0 

func (AuditTaskStatus) Values() []AuditTaskStatus

Values returns all known values for AuditTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuditTaskType 

type AuditTaskType string
const (
	AuditTaskTypeOnDemandAuditTask  AuditTaskType = "ON_DEMAND_AUDIT_TASK"
	AuditTaskTypeScheduledAuditTask AuditTaskType = "SCHEDULED_AUDIT_TASK"
)

Enum values for AuditTaskType

func (AuditTaskType) Values added in v0.29.0 

func (AuditTaskType) Values() []AuditTaskType

Values returns all known values for AuditTaskType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthDecision 

type AuthDecision string
const (
	AuthDecisionAllowed      AuthDecision = "ALLOWED"
	AuthDecisionExplicitDeny AuthDecision = "EXPLICIT_DENY"
	AuthDecisionImplicitDeny AuthDecision = "IMPLICIT_DENY"
)

Enum values for AuthDecision

func (AuthDecision) Values added in v0.29.0 

func (AuthDecision) Values() []AuthDecision

Values returns all known values for AuthDecision. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthInfo 

type AuthInfo struct {

	// The resources for which the principal is being authorized to perform the
	// specified action.
	//
	// This member is required.
	Resources []string

	// The type of action for which the principal is being authorized.
	ActionType ActionType
	// contains filtered or unexported fields
}

A collection of authorization information.

type AuthResult 

type AuthResult struct {

	// The policies and statements that allowed the specified action.
	Allowed *Allowed

	// The final authorization decision of this scenario. Multiple statements are
	// taken into account when determining the authorization decision. An explicit deny
	// statement can override multiple allow statements.
	AuthDecision AuthDecision

	// Authorization information.
	AuthInfo *AuthInfo

	// The policies and statements that denied the specified action.
	Denied *Denied

	// Contains any missing context values found while evaluating policy.
	MissingContextValues []string
	// contains filtered or unexported fields
}

The authorizer result.

type AuthenticationType added in v1.58.0 

type AuthenticationType string
const (
	AuthenticationTypeCustomAuthX509 AuthenticationType = "CUSTOM_AUTH_X509"
	AuthenticationTypeCustomAuth     AuthenticationType = "CUSTOM_AUTH"
	AuthenticationTypeAwsX509        AuthenticationType = "AWS_X509"
	AuthenticationTypeAwsSigv4       AuthenticationType = "AWS_SIGV4"
	AuthenticationTypeDefault        AuthenticationType = "DEFAULT"
)

Enum values for AuthenticationType

func (AuthenticationType) Values added in v1.58.0 

func (AuthenticationType) Values() []AuthenticationType

Values returns all known values for AuthenticationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthorizerConfig 

type AuthorizerConfig struct {

	// A Boolean that specifies whether the domain configuration's authorization
	// service can be overridden.
	AllowAuthorizerOverride *bool

	// The name of the authorization service for a domain configuration.
	DefaultAuthorizerName *string
	// contains filtered or unexported fields
}

An object that specifies the authorization service for a domain.

type AuthorizerDescription 

type AuthorizerDescription struct {

	// The authorizer ARN.
	AuthorizerArn *string

	// The authorizer's Lambda function ARN.
	AuthorizerFunctionArn *string

	// The authorizer name.
	AuthorizerName *string

	// The UNIX timestamp of when the authorizer was created.
	CreationDate *time.Time

	// When true , the result from the authorizer’s Lambda function is cached for the
	// time specified in refreshAfterInSeconds . The cached result is used while the
	// device reuses the same HTTP connection.
	EnableCachingForHttp *bool

	// The UNIX timestamp of when the authorizer was last updated.
	LastModifiedDate *time.Time

	// Specifies whether IoT validates the token signature in an authorization request.
	SigningDisabled *bool

	// The status of the authorizer.
	Status AuthorizerStatus

	// The key used to extract the token from the HTTP headers.
	TokenKeyName *string

	// The public keys used to validate the token signature returned by your custom
	// authentication service.
	TokenSigningPublicKeys map[string]string
	// contains filtered or unexported fields
}

The authorizer description.

type AuthorizerStatus 

type AuthorizerStatus string
const (
	AuthorizerStatusActive   AuthorizerStatus = "ACTIVE"
	AuthorizerStatusInactive AuthorizerStatus = "INACTIVE"
)

Enum values for AuthorizerStatus

func (AuthorizerStatus) Values added in v0.29.0 

func (AuthorizerStatus) Values() []AuthorizerStatus

Values returns all known values for AuthorizerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthorizerSummary 

type AuthorizerSummary struct {

	// The authorizer ARN.
	AuthorizerArn *string

	// The authorizer name.
	AuthorizerName *string
	// contains filtered or unexported fields
}

The authorizer summary.

type AutoRegistrationStatus 

type AutoRegistrationStatus string
const (
	AutoRegistrationStatusEnable  AutoRegistrationStatus = "ENABLE"
	AutoRegistrationStatusDisable AutoRegistrationStatus = "DISABLE"
)

Enum values for AutoRegistrationStatus

func (AutoRegistrationStatus) Values added in v0.29.0 

func (AutoRegistrationStatus) Values() []AutoRegistrationStatus

Values returns all known values for AutoRegistrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AwsJobAbortConfig 

type AwsJobAbortConfig struct {

	// The list of criteria that determine when and how to abort the job.
	//
	// This member is required.
	AbortCriteriaList []AwsJobAbortCriteria
	// contains filtered or unexported fields
}

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

type AwsJobAbortCriteria 

type AwsJobAbortCriteria struct {

	// The type of job action to take to initiate the job abort.
	//
	// This member is required.
	Action AwsJobAbortCriteriaAbortAction

	// The type of job execution failures that can initiate a job abort.
	//
	// This member is required.
	FailureType AwsJobAbortCriteriaFailureType

	// The minimum number of things which must receive job execution notifications
	// before the job can be aborted.
	//
	// This member is required.
	MinNumberOfExecutedThings *int32

	// The minimum percentage of job execution failures that must occur to initiate
	// the job abort.
	//
	// Amazon Web Services IoT Core supports up to two digits after the decimal (for
	// example, 10.9 and 10.99, but not 10.999).
	//
	// This member is required.
	ThresholdPercentage *float64
	// contains filtered or unexported fields
}

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

type AwsJobAbortCriteriaAbortAction 

type AwsJobAbortCriteriaAbortAction string
const (
	AwsJobAbortCriteriaAbortActionCancel AwsJobAbortCriteriaAbortAction = "CANCEL"
)

Enum values for AwsJobAbortCriteriaAbortAction

func (AwsJobAbortCriteriaAbortAction) Values added in v0.29.0 

func (AwsJobAbortCriteriaAbortAction) Values() []AwsJobAbortCriteriaAbortAction

Values returns all known values for AwsJobAbortCriteriaAbortAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AwsJobAbortCriteriaFailureType 

type AwsJobAbortCriteriaFailureType string
const (
	AwsJobAbortCriteriaFailureTypeFailed   AwsJobAbortCriteriaFailureType = "FAILED"
	AwsJobAbortCriteriaFailureTypeRejected AwsJobAbortCriteriaFailureType = "REJECTED"
	AwsJobAbortCriteriaFailureTypeTimedOut AwsJobAbortCriteriaFailureType = "TIMED_OUT"
	AwsJobAbortCriteriaFailureTypeAll      AwsJobAbortCriteriaFailureType = "ALL"
)

Enum values for AwsJobAbortCriteriaFailureType

func (AwsJobAbortCriteriaFailureType) Values added in v0.29.0 

func (AwsJobAbortCriteriaFailureType) Values() []AwsJobAbortCriteriaFailureType

Values returns all known values for AwsJobAbortCriteriaFailureType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AwsJobExecutionsRolloutConfig 

type AwsJobExecutionsRolloutConfig struct {

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

	// The maximum number of OTA update job executions started per minute.
	MaximumPerMinute *int32
	// contains filtered or unexported fields
}

Configuration for the rollout of OTA updates.

type AwsJobExponentialRolloutRate 

type AwsJobExponentialRolloutRate struct {

	// The minimum number of things that will be notified of a pending job, per
	// minute, at the start of the job rollout. This is the initial rate of the
	// rollout.
	//
	// This member is required.
	BaseRatePerMinute *int32

	// The rate of increase for a job rollout. The number of things notified is
	// multiplied by this factor.
	//
	// This member is required.
	IncrementFactor float64

	// The criteria to initiate the increase in rate of rollout for a job.
	//
	// Amazon Web Services IoT Core supports up to one digit after the decimal (for
	// example, 1.5, but not 1.55).
	//
	// This member is required.
	RateIncreaseCriteria *AwsJobRateIncreaseCriteria
	// contains filtered or unexported fields
}

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

type AwsJobPresignedUrlConfig 

type AwsJobPresignedUrlConfig struct {

	// How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600,
	// the default value is 1800 seconds. Pre-signed URLs are generated when a request
	// for the job document is received.
	ExpiresInSec *int64
	// contains filtered or unexported fields
}

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

type AwsJobRateIncreaseCriteria 

type AwsJobRateIncreaseCriteria struct {

	// When this number of things have been notified, it will initiate an increase in
	// the rollout rate.
	NumberOfNotifiedThings *int32

	// When this number of things have succeeded in their job execution, it will
	// initiate an increase in the rollout rate.
	NumberOfSucceededThings *int32
	// contains filtered or unexported fields
}

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

type AwsJobTimeoutConfig 

type AwsJobTimeoutConfig struct {

	// Specifies the amount of time, in minutes, this device has to finish execution
	// of this job. The timeout interval can be anywhere between 1 minute and 7 days (1
	// to 10080 minutes). The in progress timer can't be updated and will apply to all
	// job executions for the job. Whenever a job execution remains in the IN_PROGRESS
	// status for longer than this interval, the job execution will fail and switch to
	// the terminal TIMED_OUT status.
	InProgressTimeoutInMinutes *int64
	// contains filtered or unexported fields
}

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 .

type Behavior 

type Behavior struct {

	// The name you've given to the behavior.
	//
	// This member is required.
	Name *string

	// The criteria that determine if a device is behaving normally in regard to the
	// metric .
	//
	// In the IoT console, you can choose to be sent an alert through Amazon SNS when
	// IoT Device Defender detects that a device is behaving anomalously.
	Criteria *BehaviorCriteria

	// Value indicates exporting metrics related to the behavior when it is true.
	ExportMetric *bool

	// What is measured by the behavior.
	Metric *string

	// The dimension for a metric in your behavior. For example, using a TOPIC_FILTER
	// dimension, you can narrow down the scope of the metric to only MQTT topics where
	// the name matches the pattern specified in the dimension. This can't be used with
	// custom metrics.
	MetricDimension *MetricDimension

	//  Suppresses alerts.
	SuppressAlerts *bool
	// contains filtered or unexported fields
}

A Device Defender security profile behavior.

type BehaviorCriteria 

type BehaviorCriteria struct {

	// The operator that relates the thing measured ( metric ) to the criteria
	// (containing a value or statisticalThreshold ). Valid operators include:
	//
	//   - string-list : in-set and not-in-set
	//
	//   - number-list : in-set and not-in-set
	//
	//   - ip-address-list : in-cidr-set and not-in-cidr-set
	//
	//   - number : less-than , less-than-equals , greater-than , and
	//   greater-than-equals
	ComparisonOperator ComparisonOperator

	// If a device is in violation of the behavior for the specified number of
	// consecutive datapoints, an alarm occurs. If not specified, the default is 1.
	ConsecutiveDatapointsToAlarm *int32

	// If an alarm has occurred and the offending device is no longer in violation of
	// the behavior for the specified number of consecutive datapoints, the alarm is
	// cleared. If not specified, the default is 1.
	ConsecutiveDatapointsToClear *int32

	// Use this to specify the time duration over which the behavior is evaluated, for
	// those criteria that have a time dimension (for example, NUM_MESSAGES_SENT ). For
	// a statisticalThreshhold metric comparison, measurements from all devices are
	// accumulated over this time duration before being used to calculate percentiles,
	// and later, measurements from an individual device are also accumulated over this
	// time duration before being given a percentile rank. Cannot be used with
	// list-based metric datatypes.
	DurationSeconds *int32

	//  The configuration of an ML Detect
	MlDetectionConfig *MachineLearningDetectionConfig

	// 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.
	StatisticalThreshold *StatisticalThreshold

	// The value to be compared with the metric .
	Value *MetricValue
	// contains filtered or unexported fields
}

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

type BehaviorCriteriaType added in v1.2.0 

type BehaviorCriteriaType string
const (
	BehaviorCriteriaTypeStatic          BehaviorCriteriaType = "STATIC"
	BehaviorCriteriaTypeStatistical     BehaviorCriteriaType = "STATISTICAL"
	BehaviorCriteriaTypeMachineLearning BehaviorCriteriaType = "MACHINE_LEARNING"
)

Enum values for BehaviorCriteriaType

func (BehaviorCriteriaType) Values added in v1.2.0 

func (BehaviorCriteriaType) Values() []BehaviorCriteriaType

Values returns all known values for BehaviorCriteriaType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BehaviorModelTrainingSummary added in v1.2.0 

type BehaviorModelTrainingSummary struct {

	//  The name of the behavior.
	BehaviorName *string

	//  The percentage of datapoints collected.
	DatapointsCollectionPercentage *float64

	//  The date the model was last refreshed.
	LastModelRefreshDate *time.Time

	//  The status of the behavior model.
	ModelStatus ModelStatus

	//  The name of the security profile.
	SecurityProfileName *string

	//  The date a training model started collecting data.
	TrainingDataCollectionStartDate *time.Time
	// contains filtered or unexported fields
}

The summary of an ML Detect behavior model.

type BillingGroupMetadata 

type BillingGroupMetadata struct {

	// The date the billing group was created.
	CreationDate *time.Time
	// contains filtered or unexported fields
}

Additional information about the billing group.

type BillingGroupProperties 

type BillingGroupProperties struct {

	// The description of the billing group.
	BillingGroupDescription *string
	// contains filtered or unexported fields
}

The properties of a billing group.

type Bucket added in v1.11.0 

type Bucket struct {

	// The number of documents that have the value counted for the particular bucket.
	Count int32

	// The value counted for the particular bucket.
	KeyValue *string
	// contains filtered or unexported fields
}

A count of documents that meets a specific aggregation criteria.

type BucketsAggregationType added in v1.11.0 

type BucketsAggregationType struct {

	// 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.
	TermsAggregation *TermsAggregation
	// contains filtered or unexported fields
}

The type of bucketed aggregation performed.

type CACertificate 

type CACertificate struct {

	// The ARN of the CA certificate.
	CertificateArn *string

	// The ID of the CA certificate.
	CertificateId *string

	// The date the CA certificate was created.
	CreationDate *time.Time

	// The status of the CA certificate.
	//
	// The status value REGISTER_INACTIVE is deprecated and should not be used.
	Status CACertificateStatus
	// contains filtered or unexported fields
}

A CA certificate.

type CACertificateDescription 

type CACertificateDescription struct {

	// Whether the CA certificate configured for auto registration of device
	// certificates. Valid values are "ENABLE" and "DISABLE"
	AutoRegistrationStatus AutoRegistrationStatus

	// The CA certificate ARN.
	CertificateArn *string

	// The CA certificate ID.
	CertificateId *string

	// The mode of the CA.
	//
	// All the device certificates that are registered using this CA will be
	// registered in the same mode as the CA. For more information about certificate
	// mode for device certificates, see [certificate mode].
	//
	// [certificate mode]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
	CertificateMode CertificateMode

	// The CA certificate data, in PEM format.
	CertificatePem *string

	// The date the CA certificate was created.
	CreationDate *time.Time

	// The customer version of the CA certificate.
	CustomerVersion *int32

	// The generation ID of the CA certificate.
	GenerationId *string

	// The date the CA certificate was last modified.
	LastModifiedDate *time.Time

	// The owner of the CA certificate.
	OwnedBy *string

	// The status of a CA certificate.
	Status CACertificateStatus

	// When the CA certificate is valid.
	Validity *CertificateValidity
	// contains filtered or unexported fields
}

Describes a CA certificate.

type CACertificateStatus 

type CACertificateStatus string
const (
	CACertificateStatusActive   CACertificateStatus = "ACTIVE"
	CACertificateStatusInactive CACertificateStatus = "INACTIVE"
)

Enum values for CACertificateStatus

func (CACertificateStatus) Values added in v0.29.0 

func (CACertificateStatus) Values() []CACertificateStatus

Values returns all known values for CACertificateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CACertificateUpdateAction 

type CACertificateUpdateAction string
const (
	CACertificateUpdateActionDeactivate CACertificateUpdateAction = "DEACTIVATE"
)

Enum values for CACertificateUpdateAction

func (CACertificateUpdateAction) Values added in v0.29.0 

func (CACertificateUpdateAction) Values() []CACertificateUpdateAction

Values returns all known values for CACertificateUpdateAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CannedAccessControlList 

type CannedAccessControlList string
const (
	CannedAccessControlListPrivate                CannedAccessControlList = "private"
	CannedAccessControlListPublicRead             CannedAccessControlList = "public-read"
	CannedAccessControlListPublicReadWrite        CannedAccessControlList = "public-read-write"
	CannedAccessControlListAwsExecRead            CannedAccessControlList = "aws-exec-read"
	CannedAccessControlListAuthenticatedRead      CannedAccessControlList = "authenticated-read"
	CannedAccessControlListBucketOwnerRead        CannedAccessControlList = "bucket-owner-read"
	CannedAccessControlListBucketOwnerFullControl CannedAccessControlList = "bucket-owner-full-control"
	CannedAccessControlListLogDeliveryWrite       CannedAccessControlList = "log-delivery-write"
)

Enum values for CannedAccessControlList

func (CannedAccessControlList) Values added in v0.29.0 

func (CannedAccessControlList) Values() []CannedAccessControlList

Values returns all known values for CannedAccessControlList. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Certificate 

type Certificate struct {

	// The ARN of the certificate.
	CertificateArn *string

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string

	// The mode of the certificate.
	//
	// DEFAULT : A certificate in DEFAULT mode is either generated by Amazon Web
	// Services IoT Core or registered with an issuer certificate authority (CA) in
	// DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send
	// the Server Name Indication (SNI) extension when connecting to Amazon Web
	// Services IoT Core. However, to use features such as custom domains and VPC
	// endpoints, we recommend that you use the SNI extension when connecting to Amazon
	// Web Services IoT Core.
	//
	// SNI_ONLY : A certificate in SNI_ONLY mode is registered without an issuer CA.
	// Devices with certificates in SNI_ONLY mode must send the SNI extension when
	// connecting to Amazon Web Services IoT Core.
	CertificateMode CertificateMode

	// The date and time the certificate was created.
	CreationDate *time.Time

	// The status of the certificate.
	//
	// The status value REGISTER_INACTIVE is deprecated and should not be used.
	Status CertificateStatus
	// contains filtered or unexported fields
}

Information about a certificate.

type CertificateConflictException 

type CertificateConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*CertificateConflictException) Error 

func (e *CertificateConflictException) Error() string

func (*CertificateConflictException) ErrorCode 

func (e *CertificateConflictException) ErrorCode() string

func (*CertificateConflictException) ErrorFault 

func (e *CertificateConflictException) ErrorFault() smithy.ErrorFault

func (*CertificateConflictException) ErrorMessage 

func (e *CertificateConflictException) ErrorMessage() string

type CertificateDescription 

type CertificateDescription struct {

	// The certificate ID of the CA certificate used to sign this certificate.
	CaCertificateId *string

	// The ARN of the certificate.
	CertificateArn *string

	// The ID of the certificate.
	CertificateId *string

	// The mode of the certificate.
	//
	// DEFAULT : A certificate in DEFAULT mode is either generated by Amazon Web
	// Services IoT Core or registered with an issuer certificate authority (CA) in
	// DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send
	// the Server Name Indication (SNI) extension when connecting to Amazon Web
	// Services IoT Core. However, to use features such as custom domains and VPC
	// endpoints, we recommend that you use the SNI extension when connecting to Amazon
	// Web Services IoT Core.
	//
	// SNI_ONLY : A certificate in SNI_ONLY mode is registered without an issuer CA.
	// Devices with certificates in SNI_ONLY mode must send the SNI extension when
	// connecting to Amazon Web Services IoT Core.
	//
	// For more information about the value for SNI extension, see [Transport security in IoT].
	//
	// [Transport security in IoT]: https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html
	CertificateMode CertificateMode

	// The certificate data, in PEM format.
	CertificatePem *string

	// The date and time the certificate was created.
	CreationDate *time.Time

	// The customer version of the certificate.
	CustomerVersion *int32

	// The generation ID of the certificate.
	GenerationId *string

	// The date and time the certificate was last modified.
	LastModifiedDate *time.Time

	// The ID of the Amazon Web Services account that owns the certificate.
	OwnedBy *string

	// The ID of the Amazon Web Services account of the previous owner of the
	// certificate.
	PreviousOwnedBy *string

	// The status of the certificate.
	Status CertificateStatus

	// The transfer data.
	TransferData *TransferData

	// When the certificate is valid.
	Validity *CertificateValidity
	// contains filtered or unexported fields
}

Describes a certificate.

type CertificateMode 

type CertificateMode string
const (
	CertificateModeDefault CertificateMode = "DEFAULT"
	CertificateModeSniOnly CertificateMode = "SNI_ONLY"
)

Enum values for CertificateMode

func (CertificateMode) Values added in v0.29.0 

func (CertificateMode) Values() []CertificateMode

Values returns all known values for CertificateMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateProviderOperation added in v1.47.0 

type CertificateProviderOperation string
const (
	CertificateProviderOperationCreateCertificateFromCsr CertificateProviderOperation = "CreateCertificateFromCsr"
)

Enum values for CertificateProviderOperation

func (CertificateProviderOperation) Values added in v1.47.0 

func (CertificateProviderOperation) Values() []CertificateProviderOperation

Values returns all known values for CertificateProviderOperation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateProviderSummary added in v1.47.0 

type CertificateProviderSummary struct {

	// The ARN of the certificate provider.
	CertificateProviderArn *string

	// The name of the certificate provider.
	CertificateProviderName *string
	// contains filtered or unexported fields
}

The certificate provider summary.

type CertificateStateException 

type CertificateStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The certificate operation is not allowed.

func (*CertificateStateException) Error 

func (e *CertificateStateException) Error() string

func (*CertificateStateException) ErrorCode 

func (e *CertificateStateException) ErrorCode() string

func (*CertificateStateException) ErrorFault 

func (e *CertificateStateException) ErrorFault() smithy.ErrorFault

func (*CertificateStateException) ErrorMessage 

func (e *CertificateStateException) ErrorMessage() string

type CertificateStatus 

type CertificateStatus string
const (
	CertificateStatusActive            CertificateStatus = "ACTIVE"
	CertificateStatusInactive          CertificateStatus = "INACTIVE"
	CertificateStatusRevoked           CertificateStatus = "REVOKED"
	CertificateStatusPendingTransfer   CertificateStatus = "PENDING_TRANSFER"
	CertificateStatusRegisterInactive  CertificateStatus = "REGISTER_INACTIVE"
	CertificateStatusPendingActivation CertificateStatus = "PENDING_ACTIVATION"
)

Enum values for CertificateStatus

func (CertificateStatus) Values added in v0.29.0 

func (CertificateStatus) Values() []CertificateStatus

Values returns all known values for CertificateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CertificateValidationException 

type CertificateValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The certificate is invalid.

func (*CertificateValidationException) Error 

func (e *CertificateValidationException) Error() string

func (*CertificateValidationException) ErrorCode 

func (e *CertificateValidationException) ErrorCode() string

func (*CertificateValidationException) ErrorFault 

func (e *CertificateValidationException) ErrorFault() smithy.ErrorFault

func (*CertificateValidationException) ErrorMessage 

func (e *CertificateValidationException) ErrorMessage() string

type CertificateValidity 

type CertificateValidity struct {

	// The certificate is not valid after this date.
	NotAfter *time.Time

	// The certificate is not valid before this date.
	NotBefore *time.Time
	// contains filtered or unexported fields
}

When the certificate is valid.

type ClientCertificateConfig added in v1.58.0 

type ClientCertificateConfig struct {

	// The ARN of the Lambda function that IoT invokes after mutual TLS authentication
	// during the connection.
	ClientCertificateCallbackArn *string
	// contains filtered or unexported fields
}

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

type CloudwatchAlarmAction 

type CloudwatchAlarmAction struct {

	// The CloudWatch alarm name.
	//
	// This member is required.
	AlarmName *string

	// The IAM role that allows access to the CloudWatch alarm.
	//
	// This member is required.
	RoleArn *string

	// The reason for the alarm change.
	//
	// This member is required.
	StateReason *string

	// The value of the alarm state. Acceptable values are: OK, ALARM,
	// INSUFFICIENT_DATA.
	//
	// This member is required.
	StateValue *string
	// contains filtered or unexported fields
}

Describes an action that updates a CloudWatch alarm.

type CloudwatchLogsAction 

type CloudwatchLogsAction struct {

	// The CloudWatch log group to which the action sends data.
	//
	// This member is required.
	LogGroupName *string

	// The IAM role that allows access to the CloudWatch log.
	//
	// This member is required.
	RoleArn *string

	// Indicates whether batches of log records will be extracted and uploaded into
	// CloudWatch. Values include true or false (default).
	BatchMode *bool
	// contains filtered or unexported fields
}

Describes an action that sends data to CloudWatch Logs.

type CloudwatchMetricAction 

type CloudwatchMetricAction struct {

	// The CloudWatch metric name.
	//
	// This member is required.
	MetricName *string

	// The CloudWatch metric namespace name.
	//
	// This member is required.
	MetricNamespace *string

	// The [metric unit] supported by CloudWatch.
	//
	// [metric unit]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit
	//
	// This member is required.
	MetricUnit *string

	// The CloudWatch metric value.
	//
	// This member is required.
	MetricValue *string

	// The IAM role that allows access to the CloudWatch metric.
	//
	// This member is required.
	RoleArn *string

	// An optional [Unix timestamp].
	//
	// [Unix timestamp]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp
	MetricTimestamp *string
	// contains filtered or unexported fields
}

Describes an action that captures a CloudWatch metric.

type CodeSigning 

type CodeSigning struct {

	// The ID of the AWSSignerJob which was created to sign the file.
	AwsSignerJobId *string

	// A custom method for code signing a file.
	CustomCodeSigning *CustomCodeSigning

	// Describes the code-signing job.
	StartSigningJobParameter *StartSigningJobParameter
	// contains filtered or unexported fields
}

Describes the method to use when code signing a file.

type CodeSigningCertificateChain 

type CodeSigningCertificateChain struct {

	// The name of the certificate.
	CertificateName *string

	// A base64 encoded binary representation of the code signing certificate chain.
	InlineDocument *string
	// contains filtered or unexported fields
}

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

type CodeSigningSignature 

type CodeSigningSignature struct {

	// A base64 encoded binary representation of the code signing signature.
	InlineDocument []byte
	// contains filtered or unexported fields
}

Describes the signature for a file.

type CommandExecutionResult added in v1.61.0 

type CommandExecutionResult struct {

	// An attribute of type Boolean. For example:
	//
	//     "BOOL": true
	B *bool

	// An attribute of type Binary.
	BIN []byte

	// An attribute of type String. For example:
	//
	//     "S": "Hello"
	S *string
	// contains filtered or unexported fields
}

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.

type CommandExecutionStatus added in v1.61.0 

type CommandExecutionStatus string
const (
	CommandExecutionStatusCreated    CommandExecutionStatus = "CREATED"
	CommandExecutionStatusInProgress CommandExecutionStatus = "IN_PROGRESS"
	CommandExecutionStatusSucceeded  CommandExecutionStatus = "SUCCEEDED"
	CommandExecutionStatusFailed     CommandExecutionStatus = "FAILED"
	CommandExecutionStatusRejected   CommandExecutionStatus = "REJECTED"
	CommandExecutionStatusTimedOut   CommandExecutionStatus = "TIMED_OUT"
)

Enum values for CommandExecutionStatus

func (CommandExecutionStatus) Values added in v1.61.0 

func (CommandExecutionStatus) Values() []CommandExecutionStatus

Values returns all known values for CommandExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommandExecutionSummary added in v1.61.0 

type CommandExecutionSummary struct {

	// The Amazon Resource Name (ARN) of the command execution.
	CommandArn *string

	// The date and time at which the command completed executing on the target device.
	CompletedAt *time.Time

	// The date and time at which the command execution was created for the target
	// device.
	CreatedAt *time.Time

	// The unique identifier of the command execution.
	ExecutionId *string

	// The date and time at which the command started executing on the target device.
	StartedAt *time.Time

	// The status of the command executions.
	Status CommandExecutionStatus

	// The Amazon Resource Name (ARN) of the target device for which the command is
	// being executed.
	TargetArn *string
	// contains filtered or unexported fields
}

Summary information about a particular command execution.

type CommandNamespace added in v1.61.0 

type CommandNamespace string
const (
	CommandNamespaceAWSIoT          CommandNamespace = "AWS-IoT"
	CommandNamespaceAWSIoTFleetWise CommandNamespace = "AWS-IoT-FleetWise"
)

Enum values for CommandNamespace

func (CommandNamespace) Values added in v1.61.0 

func (CommandNamespace) Values() []CommandNamespace

Values returns all known values for CommandNamespace. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommandParameter added in v1.61.0 

type CommandParameter struct {

	// The name of a specific parameter used in a command and command execution.
	//
	// This member is required.
	Name *string

	// The default value used to describe the command. This is the value assumed by
	// the parameter if no other value is assigned to it.
	DefaultValue *CommandParameterValue

	// The description of the command parameter.
	Description *string

	// The value used to describe the command. When you assign a value to a parameter,
	// it will override any default value that you had already specified.
	Value *CommandParameterValue
	// contains filtered or unexported fields
}

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

type CommandParameterValue added in v1.61.0 

type CommandParameterValue struct {

	// An attribute of type Boolean. For example:
	//
	//     "BOOL": true
	B *bool

	// An attribute of type Binary. For example:
	//
	//     "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
	BIN []byte

	// An attribute of type Double (Sixty-Four Bits).
	D *float64

	// An attribute of type Integer (Thirty-Two Bits).
	I *int32

	// An attribute of type Long.
	L *int64

	// An attribute of type String. For example:
	//
	//     "S": "Hello"
	S *string

	// An attribute of type unsigned long.
	UL *string
	// contains filtered or unexported fields
}

The range of possible values that's used to describe a specific command parameter.

The commandParameterValue can only have one of the below fields listed.

type CommandPayload added in v1.61.0 

type CommandPayload struct {

	// The static payload file for the command.
	Content []byte

	// The content type that specifies the format type of the payload file. This field
	// must use a type/subtype format, such as application/json . For information about
	// various content types, see [Common MIME types].
	//
	// [Common MIME types]: https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
	ContentType *string
	// contains filtered or unexported fields
}

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

type CommandSummary added in v1.61.0 

type CommandSummary struct {

	// The Amazon Resource Name (ARN) of the command.
	CommandArn *string

	// The unique identifier of the command.
	CommandId *string

	// The timestamp, when the command was created.
	CreatedAt *time.Time

	// Indicates whether the command has been deprecated.
	Deprecated *bool

	// The display name of the command.
	DisplayName *string

	// The timestamp, when the command was last updated.
	LastUpdatedAt *time.Time

	// Indicates whether the command is pending deletion.
	PendingDeletion *bool
	// contains filtered or unexported fields
}

Summary information about a particular command resource.

type ComparisonOperator 

type ComparisonOperator string
const (
	ComparisonOperatorLessThan          ComparisonOperator = "less-than"
	ComparisonOperatorLessThanEquals    ComparisonOperator = "less-than-equals"
	ComparisonOperatorGreaterThan       ComparisonOperator = "greater-than"
	ComparisonOperatorGreaterThanEquals ComparisonOperator = "greater-than-equals"
	ComparisonOperatorInCidrSet         ComparisonOperator = "in-cidr-set"
	ComparisonOperatorNotInCidrSet      ComparisonOperator = "not-in-cidr-set"
	ComparisonOperatorInPortSet         ComparisonOperator = "in-port-set"
	ComparisonOperatorNotInPortSet      ComparisonOperator = "not-in-port-set"
	ComparisonOperatorInSet             ComparisonOperator = "in-set"
	ComparisonOperatorNotInSet          ComparisonOperator = "not-in-set"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values added in v0.29.0 

func (ComparisonOperator) Values() []ComparisonOperator

Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfidenceLevel added in v1.2.0 

type ConfidenceLevel string
const (
	ConfidenceLevelLow    ConfidenceLevel = "LOW"
	ConfidenceLevelMedium ConfidenceLevel = "MEDIUM"
	ConfidenceLevelHigh   ConfidenceLevel = "HIGH"
)

Enum values for ConfidenceLevel

func (ConfidenceLevel) Values added in v1.2.0 

func (ConfidenceLevel) Values() []ConfidenceLevel

Values returns all known values for ConfidenceLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Configuration 

type Configuration struct {

	// True to enable the configuration.
	Enabled bool
	// contains filtered or unexported fields
}

Configuration.

type ConflictException added in v1.6.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

The request conflicts with the current state of the resource.

func (*ConflictException) Error added in v1.6.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.6.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.6.0 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v1.6.0 

func (e *ConflictException) ErrorMessage() string

type ConflictingResourceUpdateException 

type ConflictingResourceUpdateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ConflictingResourceUpdateException) Error 

func (e *ConflictingResourceUpdateException) Error() string

func (*ConflictingResourceUpdateException) ErrorCode 

func (e *ConflictingResourceUpdateException) ErrorCode() string

func (*ConflictingResourceUpdateException) ErrorFault 

func (e *ConflictingResourceUpdateException) ErrorFault() smithy.ErrorFault

func (*ConflictingResourceUpdateException) ErrorMessage 

func (e *ConflictingResourceUpdateException) ErrorMessage() string

type CustomCodeSigning 

type CustomCodeSigning struct {

	// The certificate chain.
	CertificateChain *CodeSigningCertificateChain

	// The hash algorithm used to code sign the file. You can use a string as the
	// algorithm name if the target over-the-air (OTA) update devices are able to
	// verify the signature that was generated using the same signature algorithm. For
	// example, FreeRTOS uses SHA256 or SHA1 , so you can pass either of them based on
	// which was used for generating the signature.
	HashAlgorithm *string

	// The signature for the file.
	Signature *CodeSigningSignature

	// The signature algorithm used to code sign the file. You can use a string as the
	// algorithm name if the target over-the-air (OTA) update devices are able to
	// verify the signature that was generated using the same signature algorithm. For
	// example, FreeRTOS uses ECDSA or RSA , so you can pass either of them based on
	// which was used for generating the signature.
	SignatureAlgorithm *string
	// contains filtered or unexported fields
}

Describes a custom method used to code sign a file.

type CustomMetricType added in v1.2.0 

type CustomMetricType string
const (
	CustomMetricTypeStringList    CustomMetricType = "string-list"
	CustomMetricTypeIpAddressList CustomMetricType = "ip-address-list"
	CustomMetricTypeNumberList    CustomMetricType = "number-list"
	CustomMetricTypeNumber        CustomMetricType = "number"
)

Enum values for CustomMetricType

func (CustomMetricType) Values added in v1.2.0 

func (CustomMetricType) Values() []CustomMetricType

Values returns all known values for CustomMetricType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekSun DayOfWeek = "SUN"
	DayOfWeekMon DayOfWeek = "MON"
	DayOfWeekTue DayOfWeek = "TUE"
	DayOfWeekWed DayOfWeek = "WED"
	DayOfWeekThu DayOfWeek = "THU"
	DayOfWeekFri DayOfWeek = "FRI"
	DayOfWeekSat DayOfWeek = "SAT"
)

Enum values for DayOfWeek

func (DayOfWeek) Values added in v0.29.0 

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeleteConflictException 

type DeleteConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*DeleteConflictException) Error 

func (e *DeleteConflictException) Error() string

func (*DeleteConflictException) ErrorCode 

func (e *DeleteConflictException) ErrorCode() string

func (*DeleteConflictException) ErrorFault 

func (e *DeleteConflictException) ErrorFault() smithy.ErrorFault

func (*DeleteConflictException) ErrorMessage 

func (e *DeleteConflictException) ErrorMessage() string

type Denied 

type Denied struct {

	// Information that explicitly denies the authorization.
	ExplicitDeny *ExplicitDeny

	// Information that implicitly denies the authorization. When a policy doesn't
	// explicitly deny or allow an action on a resource it is considered an implicit
	// deny.
	ImplicitDeny *ImplicitDeny
	// contains filtered or unexported fields
}

Contains information that denied the authorization.

type Destination 

type Destination struct {

	// Describes the location in S3 of the updated firmware.
	S3Destination *S3Destination
	// contains filtered or unexported fields
}

Describes the location of the updated firmware.

type DetectMitigationActionExecution added in v1.2.0 

type DetectMitigationActionExecution struct {

	//  The friendly name that uniquely identifies the mitigation action.
	ActionName *string

	//  The error code of a mitigation action.
	ErrorCode *string

	//  The date a mitigation action ended.
	ExecutionEndDate *time.Time

	//  The date a mitigation action was started.
	ExecutionStartDate *time.Time

	//  The message of a mitigation action.
	Message *string

	//  The status of a mitigation action.
	Status DetectMitigationActionExecutionStatus

	//  The unique identifier of the task.
	TaskId *string

	//  The name of the thing.
	ThingName *string

	//  The unique identifier of the violation.
	ViolationId *string
	// contains filtered or unexported fields
}

Describes which mitigation actions should be executed.

type DetectMitigationActionExecutionStatus added in v1.2.0 

type DetectMitigationActionExecutionStatus string
const (
	DetectMitigationActionExecutionStatusInProgress DetectMitigationActionExecutionStatus = "IN_PROGRESS"
	DetectMitigationActionExecutionStatusSuccessful DetectMitigationActionExecutionStatus = "SUCCESSFUL"
	DetectMitigationActionExecutionStatusFailed     DetectMitigationActionExecutionStatus = "FAILED"
	DetectMitigationActionExecutionStatusSkipped    DetectMitigationActionExecutionStatus = "SKIPPED"
)

Enum values for DetectMitigationActionExecutionStatus

func (DetectMitigationActionExecutionStatus) Values added in v1.2.0 

func (DetectMitigationActionExecutionStatus) Values() []DetectMitigationActionExecutionStatus

Values returns all known values for DetectMitigationActionExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DetectMitigationActionsTaskStatistics added in v1.2.0 

type DetectMitigationActionsTaskStatistics struct {

	//  The actions that were performed.
	ActionsExecuted *int64

	//  The actions that failed.
	ActionsFailed *int64

	//  The actions that were skipped.
	ActionsSkipped *int64
	// contains filtered or unexported fields
}

The statistics of a mitigation action task.

type DetectMitigationActionsTaskStatus added in v1.2.0 

type DetectMitigationActionsTaskStatus string
const (
	DetectMitigationActionsTaskStatusInProgress DetectMitigationActionsTaskStatus = "IN_PROGRESS"
	DetectMitigationActionsTaskStatusSuccessful DetectMitigationActionsTaskStatus = "SUCCESSFUL"
	DetectMitigationActionsTaskStatusFailed     DetectMitigationActionsTaskStatus = "FAILED"
	DetectMitigationActionsTaskStatusCanceled   DetectMitigationActionsTaskStatus = "CANCELED"
)

Enum values for DetectMitigationActionsTaskStatus

func (DetectMitigationActionsTaskStatus) Values added in v1.2.0 

func (DetectMitigationActionsTaskStatus) Values() []DetectMitigationActionsTaskStatus

Values returns all known values for DetectMitigationActionsTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DetectMitigationActionsTaskSummary added in v1.2.0 

type DetectMitigationActionsTaskSummary struct {

	//  The definition of the actions.
	ActionsDefinition []MitigationAction

	//  Includes only active violations.
	OnlyActiveViolationsIncluded bool

	//  Includes suppressed alerts.
	SuppressedAlertsIncluded bool

	//  Specifies the ML Detect findings to which the mitigation actions are applied.
	Target *DetectMitigationActionsTaskTarget

	//  The date the task ended.
	TaskEndTime *time.Time

	//  The unique identifier of the task.
	TaskId *string

	//  The date the task started.
	TaskStartTime *time.Time

	//  The statistics of a mitigation action task.
	TaskStatistics *DetectMitigationActionsTaskStatistics

	//  The status of the task.
	TaskStatus DetectMitigationActionsTaskStatus

	//  Specifies the time period of which violation events occurred between.
	ViolationEventOccurrenceRange *ViolationEventOccurrenceRange
	// contains filtered or unexported fields
}

The summary of the mitigation action tasks.

type DetectMitigationActionsTaskTarget added in v1.2.0 

type DetectMitigationActionsTaskTarget struct {

	//  The name of the behavior.
	BehaviorName *string

	//  The name of the security profile.
	SecurityProfileName *string

	//  The unique identifiers of the violations.
	ViolationIds []string
	// contains filtered or unexported fields
}

The target of a mitigation action task.

type DeviceCertificateUpdateAction 

type DeviceCertificateUpdateAction string
const (
	DeviceCertificateUpdateActionDeactivate DeviceCertificateUpdateAction = "DEACTIVATE"
)

Enum values for DeviceCertificateUpdateAction

func (DeviceCertificateUpdateAction) Values added in v0.29.0 

func (DeviceCertificateUpdateAction) Values() []DeviceCertificateUpdateAction

Values returns all known values for DeviceCertificateUpdateAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeviceDefenderIndexingMode added in v1.18.0 

type DeviceDefenderIndexingMode string
const (
	DeviceDefenderIndexingModeOff        DeviceDefenderIndexingMode = "OFF"
	DeviceDefenderIndexingModeViolations DeviceDefenderIndexingMode = "VIOLATIONS"
)

Enum values for DeviceDefenderIndexingMode

func (DeviceDefenderIndexingMode) Values added in v1.18.0 

func (DeviceDefenderIndexingMode) Values() []DeviceDefenderIndexingMode

Values returns all known values for DeviceDefenderIndexingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DimensionType 

type DimensionType string
const (
	DimensionTypeTopicFilter DimensionType = "TOPIC_FILTER"
)

Enum values for DimensionType

func (DimensionType) Values added in v0.29.0 

func (DimensionType) Values() []DimensionType

Values returns all known values for DimensionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DimensionValueOperator 

type DimensionValueOperator string
const (
	DimensionValueOperatorIn    DimensionValueOperator = "IN"
	DimensionValueOperatorNotIn DimensionValueOperator = "NOT_IN"
)

Enum values for DimensionValueOperator

func (DimensionValueOperator) Values added in v0.29.0 

func (DimensionValueOperator) Values() []DimensionValueOperator

Values returns all known values for DimensionValueOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentParameter added in v1.17.0 

type DocumentParameter struct {

	// Description of the map field containing the patterns that need to be replaced
	// in a managed template job document schema.
	Description *string

	// An example illustrating a pattern that need to be replaced in a managed
	// template job document schema.
	Example *string

	// Key of the map field containing the patterns that need to be replaced in a
	// managed template job document schema.
	Key *string

	// Specifies whether a pattern that needs to be replaced in a managed template job
	// document schema is optional or required.
	Optional bool

	// A regular expression of the patterns that need to be replaced in a managed
	// template job document schema.
	Regex *string
	// contains filtered or unexported fields
}

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.

type DomainConfigurationStatus 

type DomainConfigurationStatus string
const (
	DomainConfigurationStatusEnabled  DomainConfigurationStatus = "ENABLED"
	DomainConfigurationStatusDisabled DomainConfigurationStatus = "DISABLED"
)

Enum values for DomainConfigurationStatus

func (DomainConfigurationStatus) Values added in v0.29.0 

func (DomainConfigurationStatus) Values() []DomainConfigurationStatus

Values returns all known values for DomainConfigurationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DomainConfigurationSummary 

type DomainConfigurationSummary struct {

	// The ARN of the domain configuration.
	DomainConfigurationArn *string

	// The name of the domain configuration. This value must be unique to a region.
	DomainConfigurationName *string

	// The type of service delivered by the endpoint.
	ServiceType ServiceType
	// contains filtered or unexported fields
}

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

type DomainType 

type DomainType string
const (
	DomainTypeEndpoint        DomainType = "ENDPOINT"
	DomainTypeAwsManaged      DomainType = "AWS_MANAGED"
	DomainTypeCustomerManaged DomainType = "CUSTOMER_MANAGED"
)

Enum values for DomainType

func (DomainType) Values added in v0.29.0 

func (DomainType) Values() []DomainType

Values returns all known values for DomainType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DynamicGroupStatus 

type DynamicGroupStatus string
const (
	DynamicGroupStatusActive     DynamicGroupStatus = "ACTIVE"
	DynamicGroupStatusBuilding   DynamicGroupStatus = "BUILDING"
	DynamicGroupStatusRebuilding DynamicGroupStatus = "REBUILDING"
)

Enum values for DynamicGroupStatus

func (DynamicGroupStatus) Values added in v0.29.0 

func (DynamicGroupStatus) Values() []DynamicGroupStatus

Values returns all known values for DynamicGroupStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DynamoDBAction 

type DynamoDBAction struct {

	// The hash key name.
	//
	// This member is required.
	HashKeyField *string

	// The hash key value.
	//
	// This member is required.
	HashKeyValue *string

	// The ARN of the IAM role that grants access to the DynamoDB table.
	//
	// This member is required.
	RoleArn *string

	// The name of the DynamoDB table.
	//
	// This member is required.
	TableName *string

	// The hash key type. Valid values are "STRING" or "NUMBER"
	HashKeyType DynamoKeyType

	// The type of operation to be performed. This follows the substitution template,
	// so it can be ${operation} , but the substitution must result in one of the
	// following: INSERT , UPDATE , or DELETE .
	Operation *string

	// The action payload. This name can be customized.
	PayloadField *string

	// The range key name.
	RangeKeyField *string

	// The range key type. Valid values are "STRING" or "NUMBER"
	RangeKeyType DynamoKeyType

	// The range key value.
	RangeKeyValue *string
	// contains filtered or unexported fields
}

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

type DynamoDBv2Action 

type DynamoDBv2Action struct {

	// Specifies the DynamoDB table to which the message data will be written. For
	// example:
	//
	//     { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": {
	//     "tableName": "my-table" } } }
	//
	// Each attribute in the message payload will be written to a separate column in
	// the DynamoDB database.
	//
	// This member is required.
	PutItem *PutItemInput

	// The ARN of the IAM role that grants access to the DynamoDB table.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

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.

type DynamoKeyType 

type DynamoKeyType string
const (
	DynamoKeyTypeString DynamoKeyType = "STRING"
	DynamoKeyTypeNumber DynamoKeyType = "NUMBER"
)

Enum values for DynamoKeyType

func (DynamoKeyType) Values added in v0.29.0 

func (DynamoKeyType) Values() []DynamoKeyType

Values returns all known values for DynamoKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EffectivePolicy 

type EffectivePolicy struct {

	// The policy ARN.
	PolicyArn *string

	// The IAM policy document.
	PolicyDocument *string

	// The policy name.
	PolicyName *string
	// contains filtered or unexported fields
}

The policy that has the effect on the authorization results.

type ElasticsearchAction 

type ElasticsearchAction struct {

	// The endpoint of your OpenSearch domain.
	//
	// This member is required.
	Endpoint *string

	// The unique identifier for the document you are storing.
	//
	// This member is required.
	Id *string

	// The index where you want to store your data.
	//
	// This member is required.
	Index *string

	// The IAM role ARN that has access to OpenSearch.
	//
	// This member is required.
	RoleArn *string

	// The type of document you are storing.
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

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.

type EnableIoTLoggingParams 

type EnableIoTLoggingParams struct {

	// Specifies the type of information to be logged.
	//
	// This member is required.
	LogLevel LogLevel

	// The Amazon Resource Name (ARN) of the IAM role used for logging.
	//
	// This member is required.
	RoleArnForLogging *string
	// contains filtered or unexported fields
}

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

type ErrorInfo 

type ErrorInfo struct {

	// The error code.
	Code *string

	// The error message.
	Message *string
	// contains filtered or unexported fields
}

Error information.

type EventType 

type EventType string
const (
	EventTypeThing                EventType = "THING"
	EventTypeThingGroup           EventType = "THING_GROUP"
	EventTypeThingType            EventType = "THING_TYPE"
	EventTypeThingGroupMembership EventType = "THING_GROUP_MEMBERSHIP"
	EventTypeThingGroupHierarchy  EventType = "THING_GROUP_HIERARCHY"
	EventTypeThingTypeAssociation EventType = "THING_TYPE_ASSOCIATION"
	EventTypeJob                  EventType = "JOB"
	EventTypeJobExecution         EventType = "JOB_EXECUTION"
	EventTypePolicy               EventType = "POLICY"
	EventTypeCertificate          EventType = "CERTIFICATE"
	EventTypeCaCertificate        EventType = "CA_CERTIFICATE"
)

Enum values for EventType

func (EventType) Values added in v0.29.0 

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExplicitDeny 

type ExplicitDeny struct {

	// The policies that denied the authorization.
	Policies []Policy
	// contains filtered or unexported fields
}

Information that explicitly denies authorization.

type ExponentialRolloutRate 

type ExponentialRolloutRate struct {

	// The minimum number of things that will be notified of a pending job, per minute
	// at the start of job rollout. This parameter allows you to define the initial
	// rate of rollout.
	//
	// This member is required.
	BaseRatePerMinute *int32

	// The exponential factor to increase the rate of rollout for a job.
	//
	// Amazon Web Services IoT Core supports up to one digit after the decimal (for
	// example, 1.5, but not 1.55).
	//
	// This member is required.
	IncrementFactor *float64

	// The criteria to initiate the increase in rate of rollout for a job.
	//
	// This member is required.
	RateIncreaseCriteria *RateIncreaseCriteria
	// contains filtered or unexported fields
}

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

type Field 

type Field struct {

	// The name of the field.
	Name *string

	// The data type of the field.
	Type FieldType
	// contains filtered or unexported fields
}

Describes the name and data type at a field.

type FieldType 

type FieldType string
const (
	FieldTypeNumber  FieldType = "Number"
	FieldTypeString  FieldType = "String"
	FieldTypeBoolean FieldType = "Boolean"
)

Enum values for FieldType

func (FieldType) Values added in v0.29.0 

func (FieldType) Values() []FieldType

Values returns all known values for FieldType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FileLocation 

type FileLocation struct {

	// The location of the updated firmware in S3.
	S3Location *S3Location

	// The stream that contains the OTA update.
	Stream *Stream
	// contains filtered or unexported fields
}

The location of the OTA update.

type FirehoseAction 

type FirehoseAction struct {

	// The delivery stream name.
	//
	// This member is required.
	DeliveryStreamName *string

	// The IAM role that grants access to the Amazon Kinesis Firehose stream.
	//
	// This member is required.
	RoleArn *string

	// Whether to deliver the Kinesis Data Firehose stream as a batch by using [PutRecordBatch]
	// PutRecordBatch . The default value is false .
	//
	// When batchMode is true and the rule's SQL statement evaluates to an Array, each
	// Array element forms one record in the [PutRecordBatch]PutRecordBatch request. The resulting
	// array can't have more than 500 records.
	//
	// [PutRecordBatch]: https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html
	BatchMode *bool

	// A character separator that will be used to separate records written to the
	// Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows
	// newline), ',' (comma).
	Separator *string
	// contains filtered or unexported fields
}

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

type FleetMetricNameAndArn added in v1.11.0 

type FleetMetricNameAndArn struct {

	// The fleet metric ARN.
	MetricArn *string

	// The fleet metric name.
	MetricName *string
	// contains filtered or unexported fields
}

The name and ARN of a fleet metric.

type FleetMetricUnit added in v1.11.0 

type FleetMetricUnit string
const (
	FleetMetricUnitSeconds         FleetMetricUnit = "Seconds"
	FleetMetricUnitMicroseconds    FleetMetricUnit = "Microseconds"
	FleetMetricUnitMilliseconds    FleetMetricUnit = "Milliseconds"
	FleetMetricUnitBytes           FleetMetricUnit = "Bytes"
	FleetMetricUnitKilobytes       FleetMetricUnit = "Kilobytes"
	FleetMetricUnitMegabytes       FleetMetricUnit = "Megabytes"
	FleetMetricUnitGigabytes       FleetMetricUnit = "Gigabytes"
	FleetMetricUnitTerabytes       FleetMetricUnit = "Terabytes"
	FleetMetricUnitBits            FleetMetricUnit = "Bits"
	FleetMetricUnitKilobits        FleetMetricUnit = "Kilobits"
	FleetMetricUnitMegabits        FleetMetricUnit = "Megabits"
	FleetMetricUnitGigabits        FleetMetricUnit = "Gigabits"
	FleetMetricUnitTerabits        FleetMetricUnit = "Terabits"
	FleetMetricUnitPercent         FleetMetricUnit = "Percent"
	FleetMetricUnitCount           FleetMetricUnit = "Count"
	FleetMetricUnitBytesSecond     FleetMetricUnit = "Bytes/Second"
	FleetMetricUnitKilobytesSecond FleetMetricUnit = "Kilobytes/Second"
	FleetMetricUnitMegabytesSecond FleetMetricUnit = "Megabytes/Second"
	FleetMetricUnitGigabytesSecond FleetMetricUnit = "Gigabytes/Second"
	FleetMetricUnitTerabytesSecond FleetMetricUnit = "Terabytes/Second"
	FleetMetricUnitBitsSecond      FleetMetricUnit = "Bits/Second"
	FleetMetricUnitKilobitsSecond  FleetMetricUnit = "Kilobits/Second"
	FleetMetricUnitMegabitsSecond  FleetMetricUnit = "Megabits/Second"
	FleetMetricUnitGigabitsSecond  FleetMetricUnit = "Gigabits/Second"
	FleetMetricUnitTerabitsSecond  FleetMetricUnit = "Terabits/Second"
	FleetMetricUnitCountSecond     FleetMetricUnit = "Count/Second"
	FleetMetricUnitNone            FleetMetricUnit = "None"
)

Enum values for FleetMetricUnit

func (FleetMetricUnit) Values added in v1.11.0 

func (FleetMetricUnit) Values() []FleetMetricUnit

Values returns all known values for FleetMetricUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GeoLocationTarget added in v1.45.0 

type GeoLocationTarget struct {

	// The name of the geolocation target field. If the target field is part of a
	// named shadow, you must select the named shadow using the namedShadow filter.
	Name *string

	// The order of the geolocation target field. This field is optional. The default
	// value is LatLon .
	Order TargetFieldOrder
	// contains filtered or unexported fields
}

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.

type GroupNameAndArn 

type GroupNameAndArn struct {

	// The group ARN.
	GroupArn *string

	// The group name.
	GroupName *string
	// contains filtered or unexported fields
}

The name and ARN of a group.

type HttpAction 

type HttpAction struct {

	// The endpoint URL. If substitution templates are used in the URL, you must also
	// specify a confirmationUrl . If this is a new destination, a new
	// TopicRuleDestination is created if possible.
	//
	// This member is required.
	Url *string

	// The authentication method to use when sending data to an HTTPS endpoint.
	Auth *HttpAuthorization

	// The URL to which IoT sends a confirmation message. The value of the
	// confirmation URL must be a prefix of the endpoint URL. If you do not specify a
	// confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use
	// substitution templates in the confirmationUrl, you must create and enable topic
	// rule destinations that match each possible value of the substitution template
	// before traffic is allowed to your endpoint URL.
	ConfirmationUrl *string

	// The HTTP headers to send with the message data.
	Headers []HttpActionHeader
	// contains filtered or unexported fields
}

Send data to an HTTPS endpoint.

type HttpActionHeader 

type HttpActionHeader struct {

	// The HTTP header key.
	//
	// This member is required.
	Key *string

	// The HTTP header value. Substitution templates are supported.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The HTTP action header.

type HttpAuthorization 

type HttpAuthorization struct {

	// Use Sig V4 authorization. For more information, see [Signature Version 4 Signing Process].
	//
	// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
	Sigv4 *SigV4Authorization
	// contains filtered or unexported fields
}

The authorization method used to send messages.

type HttpContext 

type HttpContext struct {

	// The header keys and values in an HTTP authorization request.
	Headers map[string]string

	// The query string keys and values in an HTTP authorization request.
	QueryString *string
	// contains filtered or unexported fields
}

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

type HttpUrlDestinationConfiguration 

type HttpUrlDestinationConfiguration struct {

	// The URL IoT uses to confirm ownership of or access to the topic rule
	// destination URL.
	//
	// This member is required.
	ConfirmationUrl *string
	// contains filtered or unexported fields
}

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

type HttpUrlDestinationProperties 

type HttpUrlDestinationProperties struct {

	// The URL used to confirm the HTTP topic rule destination URL.
	ConfirmationUrl *string
	// contains filtered or unexported fields
}

HTTP URL destination properties.

type HttpUrlDestinationSummary 

type HttpUrlDestinationSummary struct {

	// The URL used to confirm ownership of or access to the HTTP topic rule
	// destination URL.
	ConfirmationUrl *string
	// contains filtered or unexported fields
}

Information about an HTTP URL destination.

type ImplicitDeny 

type ImplicitDeny struct {

	// Policies that don't contain a matching allow or deny statement for the
	// specified action on the specified resource.
	Policies []Policy
	// contains filtered or unexported fields
}

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

type IndexNotReadyException 

type IndexNotReadyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The index is not ready.

func (*IndexNotReadyException) Error 

func (e *IndexNotReadyException) Error() string

func (*IndexNotReadyException) ErrorCode 

func (e *IndexNotReadyException) ErrorCode() string

func (*IndexNotReadyException) ErrorFault 

func (e *IndexNotReadyException) ErrorFault() smithy.ErrorFault

func (*IndexNotReadyException) ErrorMessage 

func (e *IndexNotReadyException) ErrorMessage() string

type IndexStatus 

type IndexStatus string
const (
	IndexStatusActive     IndexStatus = "ACTIVE"
	IndexStatusBuilding   IndexStatus = "BUILDING"
	IndexStatusRebuilding IndexStatus = "REBUILDING"
)

Enum values for IndexStatus

func (IndexStatus) Values added in v0.29.0 

func (IndexStatus) Values() []IndexStatus

Values returns all known values for IndexStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IndexingFilter added in v1.27.0 

type IndexingFilter struct {

	// The list of geolocation targets that you select to index. The default maximum
	// number of geolocation targets for indexing is 1 . To increase the limit, see [Amazon Web Services IoT Device Management Quotas]
	// in the Amazon Web Services General Reference.
	//
	// [Amazon Web Services IoT Device Management Quotas]: https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits
	GeoLocations []GeoLocationTarget

	// The shadow names that you select to index. The default maximum number of shadow
	// names for indexing is 10. To increase the limit, see [Amazon Web Services IoT Device Management Quotas]in the Amazon Web Services
	// General Reference.
	//
	// [Amazon Web Services IoT Device Management Quotas]: https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits
	NamedShadowNames []string
	// contains filtered or unexported fields
}

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.

type InternalException 

type InternalException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalException) Error 

func (e *InternalException) Error() string

func (*InternalException) ErrorCode 

func (e *InternalException) ErrorCode() string

func (*InternalException) ErrorFault 

func (e *InternalException) ErrorFault() smithy.ErrorFault

func (*InternalException) ErrorMessage 

func (e *InternalException) ErrorMessage() string

type InternalFailureException 

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalFailureException) Error 

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode 

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault 

func (e *InternalFailureException) ErrorFault() smithy.ErrorFault

func (*InternalFailureException) ErrorMessage 

func (e *InternalFailureException) ErrorMessage() string

type InternalServerException added in v1.17.0 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error added in v1.17.0 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode added in v1.17.0 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault added in v1.17.0 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage added in v1.17.0 

func (e *InternalServerException) ErrorMessage() string

type InvalidAggregationException 

type InvalidAggregationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The aggregation is invalid.

func (*InvalidAggregationException) Error 

func (e *InvalidAggregationException) Error() string

func (*InvalidAggregationException) ErrorCode 

func (e *InvalidAggregationException) ErrorCode() string

func (*InvalidAggregationException) ErrorFault 

func (e *InvalidAggregationException) ErrorFault() smithy.ErrorFault

func (*InvalidAggregationException) ErrorMessage 

func (e *InvalidAggregationException) ErrorMessage() string

type InvalidQueryException 

type InvalidQueryException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The query is invalid.

func (*InvalidQueryException) Error 

func (e *InvalidQueryException) Error() string

func (*InvalidQueryException) ErrorCode 

func (e *InvalidQueryException) ErrorCode() string

func (*InvalidQueryException) ErrorFault 

func (e *InvalidQueryException) ErrorFault() smithy.ErrorFault

func (*InvalidQueryException) ErrorMessage 

func (e *InvalidQueryException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is not valid.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type InvalidResponseException 

type InvalidResponseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The response is invalid.

func (*InvalidResponseException) Error 

func (e *InvalidResponseException) Error() string

func (*InvalidResponseException) ErrorCode 

func (e *InvalidResponseException) ErrorCode() string

func (*InvalidResponseException) ErrorFault 

func (e *InvalidResponseException) ErrorFault() smithy.ErrorFault

func (*InvalidResponseException) ErrorMessage 

func (e *InvalidResponseException) ErrorMessage() string

type InvalidStateTransitionException 

type InvalidStateTransitionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

func (*InvalidStateTransitionException) Error 

func (e *InvalidStateTransitionException) Error() string

func (*InvalidStateTransitionException) ErrorCode 

func (e *InvalidStateTransitionException) ErrorCode() string

func (*InvalidStateTransitionException) ErrorFault 

func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault

func (*InvalidStateTransitionException) ErrorMessage 

func (e *InvalidStateTransitionException) ErrorMessage() string

type IotAnalyticsAction 

type IotAnalyticsAction struct {

	// Whether to process the action as a batch. The default value is false .
	//
	// When batchMode is true and the rule SQL statement evaluates to an Array, each
	// Array element is delivered as a separate message when passed by [BatchPutMessage]BatchPutMessage
	// to the IoT Analytics channel. The resulting array can't have more than 100
	// messages.
	//
	// [BatchPutMessage]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html
	BatchMode *bool

	// (deprecated) The ARN of the IoT Analytics channel to which message data will be
	// sent.
	ChannelArn *string

	// The name of the IoT Analytics channel to which message data will be sent.
	ChannelName *string

	// The ARN of the role which has a policy that grants IoT Analytics permission to
	// send message data via IoT Analytics (iotanalytics:BatchPutMessage).
	RoleArn *string
	// contains filtered or unexported fields
}

Sends message data to an IoT Analytics channel.

type IotEventsAction 

type IotEventsAction struct {

	// The name of the IoT Events input.
	//
	// This member is required.
	InputName *string

	// The ARN of the role that grants IoT permission to send an input to an IoT
	// Events detector. ("Action":"iotevents:BatchPutMessage").
	//
	// This member is required.
	RoleArn *string

	// Whether to process the event actions as a batch. The default value is false .
	//
	// When batchMode is true , you can't specify a messageId .
	//
	// When batchMode is true and the rule SQL statement evaluates to an Array, each
	// Array element is treated as a separate message when it's sent to IoT Events by
	// calling [BatchPutMessage]BatchPutMessage . The resulting array can't have more than 10 messages.
	//
	// [BatchPutMessage]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html
	BatchMode *bool

	// The ID of the message. The default messageId is a new UUID value.
	//
	// When batchMode is true , you can't specify a messageId --a new UUID value will
	// be assigned.
	//
	// Assign a value to this property to ensure that only one input (message) with a
	// given messageId will be processed by an IoT Events detector.
	MessageId *string
	// contains filtered or unexported fields
}

Sends an input to an IoT Events detector.

type IotSiteWiseAction 

type IotSiteWiseAction struct {

	// A list of asset property value entries.
	//
	// This member is required.
	PutAssetPropertyValueEntries []PutAssetPropertyValueEntry

	// The ARN of the role that grants IoT permission to send an asset property value
	// to IoT SiteWise. ( "Action": "iotsitewise:BatchPutAssetPropertyValue" ). The
	// trust policy can restrict access to specific asset hierarchy paths.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

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

type IssuerCertificateIdentifier added in v1.31.0 

type IssuerCertificateIdentifier struct {

	// The issuer certificate serial number.
	IssuerCertificateSerialNumber *string

	// The subject of the issuer certificate.
	IssuerCertificateSubject *string

	// The issuer ID.
	IssuerId *string
	// contains filtered or unexported fields
}

The certificate issuer indentifier.

type Job 

type Job struct {

	// Configuration for criteria to abort the job.
	AbortConfig *AbortConfig

	// If the job was updated, describes the reason for the update.
	Comment *string

	// The time, in seconds since the epoch, when the job was completed.
	CompletedAt *time.Time

	// The time, in seconds since the epoch, when the job was created.
	CreatedAt *time.Time

	// A short text description of the job.
	Description *string

	// The package version Amazon Resource Names (ARNs) that are installed on the
	// device when the job successfully completes. The package version must be in
	// either the Published or Deprecated state when the job deploys. For more
	// information, see [Package version lifecycle].The package version must be in either the Published or
	// Deprecated state when the job deploys. For more information, see [Package version lifecycle].
	//
	// Note:The following Length Constraints relates to a single ARN. Up to 25 package
	// version ARNs are allowed.
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	DestinationPackageVersions []string

	// A key-value map that pairs 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.
	DocumentParameters map[string]string

	// Will be true if the job was canceled with the optional force parameter set to
	// true .
	ForceCanceled *bool

	// Indicates whether a job is concurrent. Will be true when a job is rolling out
	// new job executions or canceling previously created executions, otherwise false.
	IsConcurrent *bool

	// An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
	JobArn *string

	// The configuration for the criteria to retry the job.
	JobExecutionsRetryConfig *JobExecutionsRetryConfig

	// Allows you to create a staged rollout of a job.
	JobExecutionsRolloutConfig *JobExecutionsRolloutConfig

	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// Details about the job process.
	JobProcessDetails *JobProcessDetails

	// The ARN of the job template used to create the job.
	JobTemplateArn *string

	// The time, in seconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string

	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig *PresignedUrlConfig

	// If the job was updated, provides the reason code for the update.
	ReasonCode *string

	// Displays the next seven maintenance window occurrences and their start times.
	ScheduledJobRollouts []ScheduledJobRollout

	// The configuration that allows you to schedule a job for a future date and time
	// in addition to specifying the end behavior for each job execution.
	SchedulingConfig *SchedulingConfig

	// The status of the job, one of IN_PROGRESS , CANCELED , DELETION_IN_PROGRESS or
	// COMPLETED .
	Status JobStatus

	// Specifies whether the job will continue to run (CONTINUOUS), or will be
	// complete after all those things specified as targets have completed the job
	// (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
	// detected in a target. For example, a job will run on a device when the thing
	// representing the device is added to a target group, even after the job was
	// completed by all things originally in the group.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	TargetSelection TargetSelection

	// A list of IoT things and thing groups to which the job should be sent.
	Targets []string

	// 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 .
	TimeoutConfig *TimeoutConfig
	// contains filtered or unexported fields
}

The Job object contains details about a job.

type JobEndBehavior added in v1.32.0 

type JobEndBehavior string
const (
	JobEndBehaviorStopRollout JobEndBehavior = "STOP_ROLLOUT"
	JobEndBehaviorCancel      JobEndBehavior = "CANCEL"
	JobEndBehaviorForceCancel JobEndBehavior = "FORCE_CANCEL"
)

Enum values for JobEndBehavior

func (JobEndBehavior) Values added in v1.32.0 

func (JobEndBehavior) Values() []JobEndBehavior

Values returns all known values for JobEndBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobExecution 

type JobExecution struct {

	// The estimated number of seconds that remain before the job execution status
	// will be changed to TIMED_OUT . The timeout interval can be anywhere between 1
	// minute and 7 days (1 to 10080 minutes). The actual job execution timeout can
	// occur up to 60 seconds later than the estimated duration. This value will not be
	// included if the job execution has reached a terminal status.
	ApproximateSecondsBeforeTimedOut *int64

	// A string (consisting of the digits "0" through "9") which identifies this
	// particular job execution on this particular device. It can be used in commands
	// which return or update job execution information.
	ExecutionNumber *int64

	// Will be true if the job execution was canceled with the optional force
	// parameter set to true .
	ForceCanceled *bool

	// The unique identifier you assigned to the job when it was created.
	JobId *string

	// The time, in seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt *time.Time

	// The time, in seconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time

	// The time, in seconds since the epoch, when the job execution started.
	StartedAt *time.Time

	// The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED,
	// TIMED_OUT, CANCELED, or REJECTED).
	Status JobExecutionStatus

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails *JobExecutionStatusDetails

	// The ARN of the thing on which the job execution is running.
	ThingArn *string

	// The version of the job execution. Job execution versions are incremented each
	// time they are updated by a device.
	VersionNumber int64
	// contains filtered or unexported fields
}

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

type JobExecutionFailureType 

type JobExecutionFailureType string
const (
	JobExecutionFailureTypeFailed   JobExecutionFailureType = "FAILED"
	JobExecutionFailureTypeRejected JobExecutionFailureType = "REJECTED"
	JobExecutionFailureTypeTimedOut JobExecutionFailureType = "TIMED_OUT"
	JobExecutionFailureTypeAll      JobExecutionFailureType = "ALL"
)

Enum values for JobExecutionFailureType

func (JobExecutionFailureType) Values added in v0.29.0 

func (JobExecutionFailureType) Values() []JobExecutionFailureType

Values returns all known values for JobExecutionFailureType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobExecutionStatus 

type JobExecutionStatus string
const (
	JobExecutionStatusQueued     JobExecutionStatus = "QUEUED"
	JobExecutionStatusInProgress JobExecutionStatus = "IN_PROGRESS"
	JobExecutionStatusSucceeded  JobExecutionStatus = "SUCCEEDED"
	JobExecutionStatusFailed     JobExecutionStatus = "FAILED"
	JobExecutionStatusTimedOut   JobExecutionStatus = "TIMED_OUT"
	JobExecutionStatusRejected   JobExecutionStatus = "REJECTED"
	JobExecutionStatusRemoved    JobExecutionStatus = "REMOVED"
	JobExecutionStatusCanceled   JobExecutionStatus = "CANCELED"
)

Enum values for JobExecutionStatus

func (JobExecutionStatus) Values added in v0.29.0 

func (JobExecutionStatus) Values() []JobExecutionStatus

Values returns all known values for JobExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobExecutionStatusDetails 

type JobExecutionStatusDetails struct {

	// The job execution status.
	DetailsMap map[string]string
	// contains filtered or unexported fields
}

Details of the job execution status.

type JobExecutionSummary 

type JobExecutionSummary struct {

	// A string (consisting of the digits "0" through "9") which identifies this
	// particular job execution on this particular device. It can be used later in
	// commands which return or update job execution information.
	ExecutionNumber *int64

	// The time, in seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt *time.Time

	// The time, in seconds since the epoch, when the job execution was queued.
	QueuedAt *time.Time

	// The number that indicates how many retry attempts have been completed for this
	// job on this device.
	RetryAttempt *int32

	// The time, in seconds since the epoch, when the job execution started.
	StartedAt *time.Time

	// The status of the job execution.
	Status JobExecutionStatus
	// contains filtered or unexported fields
}

The job execution summary.

type JobExecutionSummaryForJob 

type JobExecutionSummaryForJob struct {

	// Contains a subset of information about a job execution.
	JobExecutionSummary *JobExecutionSummary

	// The ARN of the thing on which the job execution is running.
	ThingArn *string
	// contains filtered or unexported fields
}

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

type JobExecutionSummaryForThing 

type JobExecutionSummaryForThing struct {

	// Contains a subset of information about a job execution.
	JobExecutionSummary *JobExecutionSummary

	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// contains filtered or unexported fields
}

The job execution summary for a thing.

type JobExecutionsRetryConfig added in v1.20.0 

type JobExecutionsRetryConfig struct {

	// The list of criteria that determines how many retries are allowed for each
	// failure type for a job.
	//
	// This member is required.
	CriteriaList []RetryCriteria
	// contains filtered or unexported fields
}

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

type JobExecutionsRolloutConfig 

type JobExecutionsRolloutConfig struct {

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

	// The maximum number of things that will be notified of a pending job, per
	// minute. This parameter allows you to create a staged rollout.
	MaximumPerMinute *int32
	// contains filtered or unexported fields
}

Allows you to create a staged rollout of a job.

type JobProcessDetails 

type JobProcessDetails struct {

	// The number of things that cancelled the job.
	NumberOfCanceledThings *int32

	// The number of things that failed executing the job.
	NumberOfFailedThings *int32

	// The number of things currently executing the job.
	NumberOfInProgressThings *int32

	// The number of things that are awaiting execution of the job.
	NumberOfQueuedThings *int32

	// The number of things that rejected the job.
	NumberOfRejectedThings *int32

	// The number of things that are no longer scheduled to execute the job because
	// they have been deleted or have been removed from the group that was a target of
	// the job.
	NumberOfRemovedThings *int32

	// The number of things which successfully completed the job.
	NumberOfSucceededThings *int32

	// The number of things whose job execution status is TIMED_OUT .
	NumberOfTimedOutThings *int32

	// The target devices to which the job execution is being rolled out. This value
	// will be null after the job execution has finished rolling out to all the target
	// devices.
	ProcessingTargets []string
	// contains filtered or unexported fields
}

The job process details.

type JobStatus 

type JobStatus string
const (
	JobStatusInProgress         JobStatus = "IN_PROGRESS"
	JobStatusCanceled           JobStatus = "CANCELED"
	JobStatusCompleted          JobStatus = "COMPLETED"
	JobStatusDeletionInProgress JobStatus = "DELETION_IN_PROGRESS"
	JobStatusScheduled          JobStatus = "SCHEDULED"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobSummary 

type JobSummary struct {

	// The time, in seconds since the epoch, when the job completed.
	CompletedAt *time.Time

	// The time, in seconds since the epoch, when the job was created.
	CreatedAt *time.Time

	// Indicates whether a job is concurrent. Will be true when a job is rolling out
	// new job executions or canceling previously created executions, otherwise false.
	IsConcurrent *bool

	// The job ARN.
	JobArn *string

	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// The time, in seconds since the epoch, when the job was last updated.
	LastUpdatedAt *time.Time

	// The job summary status.
	Status JobStatus

	// Specifies whether the job will continue to run (CONTINUOUS), or will be
	// complete after all those things specified as targets have completed the job
	// (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
	// detected in a target. For example, a job will run on a thing when the thing is
	// added to a target group, even after the job was completed by all things
	// originally in the group.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	TargetSelection TargetSelection

	// The ID of the thing group.
	ThingGroupId *string
	// contains filtered or unexported fields
}

The job summary.

type JobTemplateSummary added in v1.6.0 

type JobTemplateSummary struct {

	// The time, in seconds since the epoch, when the job template was created.
	CreatedAt *time.Time

	// A description of the job template.
	Description *string

	// The ARN of the job template.
	JobTemplateArn *string

	// The unique identifier of the job template.
	JobTemplateId *string
	// contains filtered or unexported fields
}

An object that contains information about the job template.

type KafkaAction added in v1.2.0 

type KafkaAction struct {

	// Properties of the Apache Kafka producer client.
	//
	// This member is required.
	ClientProperties map[string]string

	// The ARN of Kafka action's VPC TopicRuleDestination .
	//
	// This member is required.
	DestinationArn *string

	// The Kafka topic for messages to be sent to the Kafka broker.
	//
	// This member is required.
	Topic *string

	// The list of Kafka headers that you specify.
	Headers []KafkaActionHeader

	// The Kafka message key.
	Key *string

	// The Kafka message partition.
	Partition *string
	// contains filtered or unexported fields
}

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

type KafkaActionHeader added in v1.40.0 

type KafkaActionHeader struct {

	// The key of the Kafka header.
	//
	// This member is required.
	Key *string

	// The value of the Kafka header.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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.

type KeyPair 

type KeyPair struct {

	// The private key.
	PrivateKey *string

	// The public key.
	PublicKey *string
	// contains filtered or unexported fields
}

Describes a key pair.

type KinesisAction 

type KinesisAction struct {

	// The ARN of the IAM role that grants access to the Amazon Kinesis stream.
	//
	// This member is required.
	RoleArn *string

	// The name of the Amazon Kinesis stream.
	//
	// This member is required.
	StreamName *string

	// The partition key.
	PartitionKey *string
	// contains filtered or unexported fields
}

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

type LambdaAction 

type LambdaAction struct {

	// The ARN of the Lambda function.
	//
	// This member is required.
	FunctionArn *string
	// contains filtered or unexported fields
}

Describes an action to invoke a Lambda function.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A limit has been exceeded.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LocationAction added in v1.30.0 

type LocationAction struct {

	// The unique ID of the device providing the location data.
	//
	// This member is required.
	DeviceId *string

	// A string that evaluates to a double value that represents the latitude of the
	// device's location.
	//
	// This member is required.
	Latitude *string

	// A string that evaluates to a double value that represents the longitude of the
	// device's location.
	//
	// This member is required.
	Longitude *string

	// The IAM role that grants permission to write to the Amazon Location resource.
	//
	// This member is required.
	RoleArn *string

	// The name of the tracker resource in Amazon Location in which the location is
	// updated.
	//
	// This member is required.
	TrackerName *string

	// The time that the location data was sampled. The default value is the time the
	// MQTT message was processed.
	Timestamp *LocationTimestamp
	// contains filtered or unexported fields
}

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

type LocationTimestamp added in v1.30.0 

type LocationTimestamp struct {

	// An expression that returns a long epoch time value.
	//
	// This member is required.
	Value *string

	// The precision of the timestamp value that results from the expression described
	// in value .
	//
	// Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS . The default
	// is MILLISECONDS .
	Unit *string
	// contains filtered or unexported fields
}

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

type LogLevel 

type LogLevel string
const (
	LogLevelDebug    LogLevel = "DEBUG"
	LogLevelInfo     LogLevel = "INFO"
	LogLevelError    LogLevel = "ERROR"
	LogLevelWarn     LogLevel = "WARN"
	LogLevelDisabled LogLevel = "DISABLED"
)

Enum values for LogLevel

func (LogLevel) Values added in v0.29.0 

func (LogLevel) Values() []LogLevel

Values returns all known values for LogLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LogTarget 

type LogTarget struct {

	// The target type.
	//
	// This member is required.
	TargetType LogTargetType

	// The target name.
	TargetName *string
	// contains filtered or unexported fields
}

A log target.

type LogTargetConfiguration 

type LogTargetConfiguration struct {

	// The logging level.
	LogLevel LogLevel

	// A log target
	LogTarget *LogTarget
	// contains filtered or unexported fields
}

The target configuration.

type LogTargetType 

type LogTargetType string
const (
	LogTargetTypeDefault     LogTargetType = "DEFAULT"
	LogTargetTypeThingGroup  LogTargetType = "THING_GROUP"
	LogTargetTypeClientId    LogTargetType = "CLIENT_ID"
	LogTargetTypeSourceIp    LogTargetType = "SOURCE_IP"
	LogTargetTypePrincipalId LogTargetType = "PRINCIPAL_ID"
)

Enum values for LogTargetType

func (LogTargetType) Values added in v0.29.0 

func (LogTargetType) Values() []LogTargetType

Values returns all known values for LogTargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingOptionsPayload 

type LoggingOptionsPayload struct {

	// The ARN of the IAM role that grants access.
	//
	// This member is required.
	RoleArn *string

	// The log level.
	LogLevel LogLevel
	// contains filtered or unexported fields
}

Describes the logging options payload.

type MachineLearningDetectionConfig added in v1.2.0 

type MachineLearningDetectionConfig struct {

	//  The sensitivity of anomalous behavior evaluation. Can be Low , Medium , or High
	// .
	//
	// This member is required.
	ConfidenceLevel ConfidenceLevel
	// contains filtered or unexported fields
}

The configuration of an ML Detect Security Profile.

type MaintenanceWindow added in v1.35.0 

type MaintenanceWindow struct {

	// Displays the duration of the next maintenance window.
	//
	// This member is required.
	DurationInMinutes *int32

	// Displays the start time of the next maintenance window.
	//
	// This member is required.
	StartTime *string
	// contains filtered or unexported fields
}

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.

type MalformedPolicyException 

type MalformedPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The policy documentation is not valid.

func (*MalformedPolicyException) Error 

func (e *MalformedPolicyException) Error() string

func (*MalformedPolicyException) ErrorCode 

func (e *MalformedPolicyException) ErrorCode() string

func (*MalformedPolicyException) ErrorFault 

func (e *MalformedPolicyException) ErrorFault() smithy.ErrorFault

func (*MalformedPolicyException) ErrorMessage 

func (e *MalformedPolicyException) ErrorMessage() string

type ManagedJobTemplateSummary added in v1.17.0 

type ManagedJobTemplateSummary struct {

	// The description for a managed template.
	Description *string

	// A list of environments that are supported with the managed job template.
	Environments []string

	// The Amazon Resource Name (ARN) for a managed template.
	TemplateArn *string

	// The unique Name for a managed template.
	TemplateName *string

	// The version for a managed template.
	TemplateVersion *string
	// contains filtered or unexported fields
}

An object that contains information about the managed template.

type MessageFormat 

type MessageFormat string
const (
	MessageFormatRaw  MessageFormat = "RAW"
	MessageFormatJson MessageFormat = "JSON"
)

Enum values for MessageFormat

func (MessageFormat) Values added in v0.29.0 

func (MessageFormat) Values() []MessageFormat

Values returns all known values for MessageFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MetricDatum added in v1.24.0 

type MetricDatum struct {

	// The time the metric value was reported.
	Timestamp *time.Time

	// The value reported for the metric.
	Value *MetricValue
	// contains filtered or unexported fields
}

A metric.

type MetricDimension 

type MetricDimension struct {

	// A unique identifier for the dimension.
	//
	// This member is required.
	DimensionName *string

	// Defines how the dimensionValues of a dimension are interpreted. For example,
	// for dimension type TOPIC_FILTER, the IN operator, a message will be counted
	// only if its topic matches one of the topic filters. With NOT_IN operator, a
	// message will be counted only if it doesn't match any of the topic filters. The
	// operator is optional: if it's not provided (is null ), it will be interpreted as
	// IN .
	Operator DimensionValueOperator
	// contains filtered or unexported fields
}

The dimension of a metric.

type MetricToRetain 

type MetricToRetain struct {

	// What is measured by the behavior.
	//
	// This member is required.
	Metric *string

	// The value indicates exporting metrics related to the MetricToRetain  when it's
	// true.
	ExportMetric *bool

	// The dimension of a metric. This can't be used with custom metrics.
	MetricDimension *MetricDimension
	// contains filtered or unexported fields
}

The metric you want to retain. Dimensions are optional.

type MetricValue 

type MetricValue struct {

	// If the comparisonOperator calls for a set of CIDRs, use this to specify that
	// set to be compared with the metric .
	Cidrs []string

	// If the comparisonOperator calls for a numeric value, use this to specify that
	// numeric value to be compared with the metric .
	Count *int64

	//  The numeral value of a metric.
	Number *float64

	//  The numeral values of a metric.
	Numbers []float64

	// If the comparisonOperator calls for a set of ports, use this to specify that
	// set to be compared with the metric .
	Ports []int32

	//  The string values of a metric.
	Strings []string
	// contains filtered or unexported fields
}

The value to be compared with the metric .

type MetricsExportConfig added in v1.44.0 

type MetricsExportConfig struct {

	// The MQTT topic that Device Defender Detect should publish messages to for
	// metrics export.
	//
	// This member is required.
	MqttTopic *string

	// This role ARN has permission to publish MQTT messages, after which Device
	// Defender Detect can assume the role and publish messages on your behalf.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

Set configurations for metrics export.

type MitigationAction 

type MitigationAction struct {

	// The set of parameters for this mitigation action. The parameters vary,
	// depending on the kind of action you apply.
	ActionParams *MitigationActionParams

	// A unique identifier for the mitigation action.
	Id *string

	// A user-friendly name for the mitigation action.
	Name *string

	// The IAM role ARN used to apply this mitigation action.
	RoleArn *string
	// contains filtered or unexported fields
}

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

type MitigationActionIdentifier 

type MitigationActionIdentifier struct {

	// The IAM role ARN used to apply this mitigation action.
	ActionArn *string

	// The friendly name of the mitigation action.
	ActionName *string

	// The date when this mitigation action was created.
	CreationDate *time.Time
	// contains filtered or unexported fields
}

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

type MitigationActionParams 

type MitigationActionParams struct {

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

	// Parameters to define a mitigation action that enables Amazon Web Services IoT
	// Core logging at a specified level of detail.
	EnableIoTLoggingParams *EnableIoTLoggingParams

	// Parameters to define a mitigation action that publishes findings to Amazon
	// Simple Notification Service (Amazon SNS. You can implement your own custom
	// actions in response to the Amazon SNS messages.
	PublishFindingToSnsParams *PublishFindingToSnsParams

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

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

	// Parameters to define a mitigation action that changes the state of the device
	// certificate to inactive.
	UpdateDeviceCertificateParams *UpdateDeviceCertificateParams
	// contains filtered or unexported fields
}

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

type MitigationActionType 

type MitigationActionType string
const (
	MitigationActionTypeUpdateDeviceCertificate     MitigationActionType = "UPDATE_DEVICE_CERTIFICATE"
	MitigationActionTypeUpdateCaCertificate         MitigationActionType = "UPDATE_CA_CERTIFICATE"
	MitigationActionTypeAddThingsToThingGroup       MitigationActionType = "ADD_THINGS_TO_THING_GROUP"
	MitigationActionTypeReplaceDefaultPolicyVersion MitigationActionType = "REPLACE_DEFAULT_POLICY_VERSION"
	MitigationActionTypeEnableIotLogging            MitigationActionType = "ENABLE_IOT_LOGGING"
	MitigationActionTypePublishFindingToSns         MitigationActionType = "PUBLISH_FINDING_TO_SNS"
)

Enum values for MitigationActionType

func (MitigationActionType) Values added in v0.29.0 

func (MitigationActionType) Values() []MitigationActionType

Values returns all known values for MitigationActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ModelStatus added in v1.2.0 

type ModelStatus string
const (
	ModelStatusPendingBuild ModelStatus = "PENDING_BUILD"
	ModelStatusActive       ModelStatus = "ACTIVE"
	ModelStatusExpired      ModelStatus = "EXPIRED"
)

Enum values for ModelStatus

func (ModelStatus) Values added in v1.2.0 

func (ModelStatus) Values() []ModelStatus

Values returns all known values for ModelStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Mqtt5Configuration added in v1.60.0 

type Mqtt5Configuration struct {

	// An object that represents the propagating thing attributes and the connection
	// attributes.
	PropagatingAttributes []PropagatingAttribute
	// contains filtered or unexported fields
}

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

type MqttContext 

type MqttContext struct {

	// The value of the clientId key in an MQTT authorization request.
	ClientId *string

	// The value of the password key in an MQTT authorization request.
	Password []byte

	// The value of the username key in an MQTT authorization request.
	Username *string
	// contains filtered or unexported fields
}

Specifies the MQTT context to use for the test authorizer request

type MqttHeaders added in v1.32.0 

type MqttHeaders struct {

	// A UTF-8 encoded string that describes the content of the publishing message.
	//
	// For more information, see [Content Type] from the MQTT Version 5.0 specification.
	//
	// Supports [substitution templates].
	//
	// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	// [Content Type]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118
	ContentType *string

	// The base64-encoded binary data used by the sender of the request message to
	// identify which request the response message is for when it's received.
	//
	// For more information, see [Correlation Data] from the MQTT Version 5.0 specification.
	//
	// This binary data must be based64-encoded.
	//
	// Supports [substitution templates].
	//
	// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	// [Correlation Data]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115
	CorrelationData *string

	// A user-defined integer value that will persist a message at the message broker
	// for a specified amount of time to ensure that the message will expire if it's no
	// longer relevant to the subscriber. The value of messageExpiry represents the
	// number of seconds before it expires. For more information about the limits of
	// messageExpiry , see [Amazon Web Services IoT Core message broker and protocol limits and quotas] from the Amazon Web Services Reference Guide.
	//
	// Supports [substitution templates].
	//
	// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	// [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html
	MessageExpiry *string

	// An Enum string value that indicates whether the payload is formatted as UTF-8.
	//
	// Valid values are UNSPECIFIED_BYTES and UTF8_DATA .
	//
	// For more information, see [Payload Format Indicator] from the MQTT Version 5.0 specification.
	//
	// Supports [substitution templates].
	//
	// [Payload Format Indicator]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111
	// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	PayloadFormatIndicator *string

	// A UTF-8 encoded string that's used as the topic name for a response message.
	// The response topic is used to describe the topic which the receiver should
	// publish to as part of the request-response flow. The topic must not contain
	// wildcard characters.
	//
	// For more information, see [Response Topic] from the MQTT Version 5.0 specification.
	//
	// Supports [substitution templates].
	//
	// [Response Topic]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114
	// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	ResponseTopic *string

	// An array of key-value pairs that you define in the MQTT5 header.
	UserProperties []UserProperty
	// contains filtered or unexported fields
}

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

type NamedShadowIndexingMode added in v1.18.0 

type NamedShadowIndexingMode string
const (
	NamedShadowIndexingModeOff NamedShadowIndexingMode = "OFF"
	NamedShadowIndexingModeOn  NamedShadowIndexingMode = "ON"
)

Enum values for NamedShadowIndexingMode

func (NamedShadowIndexingMode) Values added in v1.18.0 

func (NamedShadowIndexingMode) Values() []NamedShadowIndexingMode

Values returns all known values for NamedShadowIndexingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NonCompliantResource 

type NonCompliantResource struct {

	// Other information about the noncompliant resource.
	AdditionalInfo map[string]string

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *ResourceIdentifier

	// The type of the noncompliant resource.
	ResourceType ResourceType
	// contains filtered or unexported fields
}

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

type NotConfiguredException 

type NotConfiguredException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is not configured.

func (*NotConfiguredException) Error 

func (e *NotConfiguredException) Error() string

func (*NotConfiguredException) ErrorCode 

func (e *NotConfiguredException) ErrorCode() string

func (*NotConfiguredException) ErrorFault 

func (e *NotConfiguredException) ErrorFault() smithy.ErrorFault

func (*NotConfiguredException) ErrorMessage 

func (e *NotConfiguredException) ErrorMessage() string

type OTAUpdateFile 

type OTAUpdateFile struct {

	// A list of name-attribute pairs. They won't be sent to devices as a part of the
	// Job document.
	Attributes map[string]string

	// The code signing method of the file.
	CodeSigning *CodeSigning

	// The location of the updated firmware.
	FileLocation *FileLocation

	// The name of the file.
	FileName *string

	// An integer value you can include in the job document to allow your devices to
	// identify the type of file received from the cloud.
	FileType *int32

	// The file version.
	FileVersion *string
	// contains filtered or unexported fields
}

Describes a file to be associated with an OTA update.

type OTAUpdateInfo 

type OTAUpdateInfo struct {

	// A collection of name/value pairs
	AdditionalParameters map[string]string

	// The IoT job ARN associated with the OTA update.
	AwsIotJobArn *string

	// The IoT job ID associated with the OTA update.
	AwsIotJobId *string

	// Configuration for the rollout of OTA updates.
	AwsJobExecutionsRolloutConfig *AwsJobExecutionsRolloutConfig

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

	// The date when the OTA update was created.
	CreationDate *time.Time

	// A description of the OTA update.
	Description *string

	// Error information associated with the OTA update.
	ErrorInfo *ErrorInfo

	// The date when the OTA update was last updated.
	LastModifiedDate *time.Time

	// The OTA update ARN.
	OtaUpdateArn *string

	// A list of files associated with the OTA update.
	OtaUpdateFiles []OTAUpdateFile

	// The OTA update ID.
	OtaUpdateId *string

	// The status of the OTA update.
	OtaUpdateStatus OTAUpdateStatus

	// The protocol used to transfer the OTA update image. Valid values are [HTTP],
	// [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device
	// can choose the protocol.
	Protocols []Protocol

	// Specifies whether the OTA update will continue to run (CONTINUOUS), or will be
	// complete after all those things specified as targets have completed the OTA
	// update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when
	// a change is detected in a target. For example, an OTA update will run on a thing
	// when the thing is added to a target group, even after the OTA update was
	// completed by all things originally in the group.
	TargetSelection TargetSelection

	// The targets of the OTA update.
	Targets []string
	// contains filtered or unexported fields
}

Information about an OTA update.

type OTAUpdateStatus 

type OTAUpdateStatus string
const (
	OTAUpdateStatusCreatePending    OTAUpdateStatus = "CREATE_PENDING"
	OTAUpdateStatusCreateInProgress OTAUpdateStatus = "CREATE_IN_PROGRESS"
	OTAUpdateStatusCreateComplete   OTAUpdateStatus = "CREATE_COMPLETE"
	OTAUpdateStatusCreateFailed     OTAUpdateStatus = "CREATE_FAILED"
	OTAUpdateStatusDeleteInProgress OTAUpdateStatus = "DELETE_IN_PROGRESS"
	OTAUpdateStatusDeleteFailed     OTAUpdateStatus = "DELETE_FAILED"
)

Enum values for OTAUpdateStatus

func (OTAUpdateStatus) Values added in v0.29.0 

func (OTAUpdateStatus) Values() []OTAUpdateStatus

Values returns all known values for OTAUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OTAUpdateSummary 

type OTAUpdateSummary struct {

	// The date when the OTA update was created.
	CreationDate *time.Time

	// The OTA update ARN.
	OtaUpdateArn *string

	// The OTA update ID.
	OtaUpdateId *string
	// contains filtered or unexported fields
}

An OTA update summary.

type OpenSearchAction added in v1.12.0 

type OpenSearchAction struct {

	// The endpoint of your OpenSearch domain.
	//
	// This member is required.
	Endpoint *string

	// The unique identifier for the document you are storing.
	//
	// This member is required.
	Id *string

	// The OpenSearch index where you want to store your data.
	//
	// This member is required.
	Index *string

	// The IAM role ARN that has access to OpenSearch.
	//
	// This member is required.
	RoleArn *string

	// The type of document you are storing.
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

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

type OutgoingCertificate 

type OutgoingCertificate struct {

	// The certificate ARN.
	CertificateArn *string

	// The certificate ID.
	CertificateId *string

	// The certificate creation date.
	CreationDate *time.Time

	// The date the transfer was initiated.
	TransferDate *time.Time

	// The transfer message.
	TransferMessage *string

	// The Amazon Web Services account to which the transfer was made.
	TransferredTo *string
	// contains filtered or unexported fields
}

A certificate that has been transferred but not yet accepted.

type PackageSummary added in v1.38.0 

type PackageSummary struct {

	// The date that the package was created.
	CreationDate *time.Time

	// The name of the default package version.
	DefaultVersionName *string

	// The date that the package was last updated.
	LastModifiedDate *time.Time

	// The name for the target software package.
	PackageName *string
	// contains filtered or unexported fields
}

A summary of information about a software package.

type PackageVersionAction added in v1.38.0 

type PackageVersionAction string
const (
	PackageVersionActionPublish   PackageVersionAction = "PUBLISH"
	PackageVersionActionDeprecate PackageVersionAction = "DEPRECATE"
)

Enum values for PackageVersionAction

func (PackageVersionAction) Values added in v1.38.0 

func (PackageVersionAction) Values() []PackageVersionAction

Values returns all known values for PackageVersionAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PackageVersionArtifact added in v1.56.0 

type PackageVersionArtifact struct {

	// The S3 location.
	S3Location *S3Location
	// contains filtered or unexported fields
}

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

type PackageVersionStatus added in v1.38.0 

type PackageVersionStatus string
const (
	PackageVersionStatusDraft      PackageVersionStatus = "DRAFT"
	PackageVersionStatusPublished  PackageVersionStatus = "PUBLISHED"
	PackageVersionStatusDeprecated PackageVersionStatus = "DEPRECATED"
)

Enum values for PackageVersionStatus

func (PackageVersionStatus) Values added in v1.38.0 

func (PackageVersionStatus) Values() []PackageVersionStatus

Values returns all known values for PackageVersionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PackageVersionSummary added in v1.38.0 

type PackageVersionSummary struct {

	// The date that the package version was created.
	CreationDate *time.Time

	// The date that the package version was last updated.
	LastModifiedDate *time.Time

	// The name of the associated software package.
	PackageName *string

	// The status of the package version. For more information, see [Package version lifecycle].
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	Status PackageVersionStatus

	// The name of the target package version.
	VersionName *string
	// contains filtered or unexported fields
}

A summary of information about a package version.

type PercentPair 

type PercentPair struct {

	// The percentile.
	Percent float64

	// The value of the percentile.
	Value float64
	// contains filtered or unexported fields
}

Describes the percentile and percentile value.

type Policy 

type Policy struct {

	// The policy ARN.
	PolicyArn *string

	// The policy name.
	PolicyName *string
	// contains filtered or unexported fields
}

Describes an IoT policy.

type PolicyTemplateName 

type PolicyTemplateName string
const (
	PolicyTemplateNameBlankPolicy PolicyTemplateName = "BLANK_POLICY"
)

Enum values for PolicyTemplateName

func (PolicyTemplateName) Values added in v0.29.0 

func (PolicyTemplateName) Values() []PolicyTemplateName

Values returns all known values for PolicyTemplateName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PolicyVersion 

type PolicyVersion struct {

	// The date and time the policy was created.
	CreateDate *time.Time

	// Specifies whether the policy version is the default.
	IsDefaultVersion bool

	// The policy version ID.
	VersionId *string
	// contains filtered or unexported fields
}

Describes a policy version.

type PolicyVersionIdentifier 

type PolicyVersionIdentifier struct {

	// The name of the policy.
	PolicyName *string

	// The ID of the version of the policy associated with the resource.
	PolicyVersionId *string
	// contains filtered or unexported fields
}

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

type PresignedUrlConfig 

type PresignedUrlConfig struct {

	// How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600,
	// the default value is 3600 seconds. Pre-signed URLs are generated when Jobs
	// receives an MQTT request for the job document.
	ExpiresInSec *int64

	// The ARN of an IAM role that grants permission to download files from the S3
	// bucket where the job data/updates are stored. The role must also grant
	// permission for IoT to download the files.
	//
	// For information about addressing the confused deputy problem, see [cross-service confused deputy prevention] in the
	// Amazon Web Services IoT Core developer guide.
	//
	// [cross-service confused deputy prevention]: https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html
	RoleArn *string
	// contains filtered or unexported fields
}

Configuration for pre-signed S3 URLs.

type PrincipalThingObject added in v1.60.0 

type PrincipalThingObject struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The type of the relation you want to specify when you attach a principal to a
	// thing. The value defaults to NON_EXCLUSIVE_THING .
	//
	//   - EXCLUSIVE_THING - Attaches the specified principal to the specified thing,
	//   exclusively. The thing will be the only thing that’s attached to the principal.
	//
	//   - NON_EXCLUSIVE_THING - Attaches the specified principal to the specified
	//   thing. Multiple things can be attached to the principal.
	ThingPrincipalType ThingPrincipalType
	// contains filtered or unexported fields
}

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

type PropagatingAttribute added in v1.60.0 

type PropagatingAttribute struct {

	// The attribute associated with the connection between a device and Amazon Web
	// Services IoT Core.
	ConnectionAttribute *string

	// The user-defined thing attribute that is propagating for MQTT 5 message
	// enrichment.
	ThingAttribute *string

	// The key of the user property key-value pair.
	UserPropertyKey *string
	// contains filtered or unexported fields
}

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

type Protocol 

type Protocol string
const (
	ProtocolMqtt Protocol = "MQTT"
	ProtocolHttp Protocol = "HTTP"
)

Enum values for Protocol

func (Protocol) Values added in v0.29.0 

func (Protocol) Values() []Protocol

Values returns all known values for Protocol. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProvisioningHook 

type ProvisioningHook struct {

	// The ARN of the target function.
	//
	// Note: Only Lambda functions are currently supported.
	//
	// This member is required.
	TargetArn *string

	// The payload that was sent to the target function.
	//
	// Note: Only Lambda functions are currently supported.
	PayloadVersion *string
	// contains filtered or unexported fields
}

Structure that contains payloadVersion and targetArn .

type ProvisioningTemplateSummary 

type ProvisioningTemplateSummary struct {

	// The date when the provisioning template summary was created.
	CreationDate *time.Time

	// The description of the provisioning template.
	Description *string

	// True if the fleet provision template is enabled, otherwise false.
	Enabled *bool

	// The date when the provisioning template summary was last modified.
	LastModifiedDate *time.Time

	// The ARN of the provisioning template.
	TemplateArn *string

	// The name of the provisioning template.
	TemplateName *string

	// The type you define in a provisioning template. You can create a template with
	// only one type. You can't change the template type after its creation. The
	// default value is FLEET_PROVISIONING . For more information about provisioning
	// template, see: [Provisioning template].
	//
	// [Provisioning template]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html
	Type TemplateType
	// contains filtered or unexported fields
}

A summary of information about a provisioning template.

type ProvisioningTemplateVersionSummary 

type ProvisioningTemplateVersionSummary struct {

	// The date when the provisioning template version was created
	CreationDate *time.Time

	// True if the provisioning template version is the default version, otherwise
	// false.
	IsDefaultVersion bool

	// The ID of the fleet provisioning template version.
	VersionId *int32
	// contains filtered or unexported fields
}

A summary of information about a fleet provision template version.

type PublishFindingToSnsParams 

type PublishFindingToSnsParams struct {

	// The ARN of the topic to which you want to publish the findings.
	//
	// This member is required.
	TopicArn *string
	// contains filtered or unexported fields
}

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.

type PutAssetPropertyValueEntry 

type PutAssetPropertyValueEntry struct {

	// A list of property values to insert that each contain timestamp, quality, and
	// value (TQV) information.
	//
	// This member is required.
	PropertyValues []AssetPropertyValue

	// The ID of the IoT SiteWise asset. You must specify either a propertyAlias or
	// both an aliasId and a propertyId . Accepts substitution templates.
	AssetId *string

	// Optional. A unique identifier for this entry that you can define to better
	// track which message caused an error in case of failure. Accepts substitution
	// templates. Defaults to a new UUID.
	EntryId *string

	// The name of the property alias associated with your asset property. You must
	// specify either a propertyAlias or both an aliasId and a propertyId . Accepts
	// substitution templates.
	PropertyAlias *string

	// The ID of the asset's property. You must specify either a propertyAlias or both
	// an aliasId and a propertyId . Accepts substitution templates.
	PropertyId *string
	// contains filtered or unexported fields
}

An asset property value entry containing the following information.

type PutItemInput 

type PutItemInput struct {

	// The table where the message data will be written.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

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

type RateIncreaseCriteria 

type RateIncreaseCriteria struct {

	// The threshold for number of notified things that will initiate the increase in
	// rate of rollout.
	NumberOfNotifiedThings *int32

	// The threshold for number of succeeded things that will initiate the increase in
	// rate of rollout.
	NumberOfSucceededThings *int32
	// contains filtered or unexported fields
}

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

type RegistrationCodeValidationException 

type RegistrationCodeValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The registration code is invalid.

func (*RegistrationCodeValidationException) Error 

func (e *RegistrationCodeValidationException) Error() string

func (*RegistrationCodeValidationException) ErrorCode 

func (e *RegistrationCodeValidationException) ErrorCode() string

func (*RegistrationCodeValidationException) ErrorFault 

func (e *RegistrationCodeValidationException) ErrorFault() smithy.ErrorFault

func (*RegistrationCodeValidationException) ErrorMessage 

func (e *RegistrationCodeValidationException) ErrorMessage() string

type RegistrationConfig 

type RegistrationConfig struct {

	// The ARN of the role.
	RoleArn *string

	// The template body.
	TemplateBody *string

	// The name of the provisioning template.
	TemplateName *string
	// contains filtered or unexported fields
}

The registration configuration.

type RelatedResource 

type RelatedResource struct {

	// Other information about the resource.
	AdditionalInfo map[string]string

	// Information that identifies the resource.
	ResourceIdentifier *ResourceIdentifier

	// The type of resource.
	ResourceType ResourceType
	// contains filtered or unexported fields
}

Information about a related resource.

type ReplaceDefaultPolicyVersionParams 

type ReplaceDefaultPolicyVersionParams struct {

	// The name of the template to be applied. The only supported value is BLANK_POLICY
	// .
	//
	// This member is required.
	TemplateName PolicyTemplateName
	// contains filtered or unexported fields
}

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

type ReportType 

type ReportType string
const (
	ReportTypeErrors  ReportType = "ERRORS"
	ReportTypeResults ReportType = "RESULTS"
)

Enum values for ReportType

func (ReportType) Values added in v0.29.0 

func (ReportType) Values() []ReportType

Values returns all known values for ReportType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RepublishAction 

type RepublishAction struct {

	// The ARN of the IAM role that grants access.
	//
	// This member is required.
	RoleArn *string

	// The name of the MQTT topic.
	//
	// This member is required.
	Topic *string

	// MQTT Version 5.0 headers information. For more information, see [MQTT] from the
	// Amazon Web Services IoT Core Developer Guide.
	//
	// [MQTT]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html
	Headers *MqttHeaders

	// The Quality of Service (QoS) level to use when republishing messages. The
	// default value is 0.
	Qos *int32
	// contains filtered or unexported fields
}

Describes an action to republish to another topic.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId  *string
	ResourceArn *string
	// contains filtered or unexported fields
}

The resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceIdentifier 

type ResourceIdentifier struct {

	// The account with which the resource is associated.
	Account *string

	// The ID of the CA certificate used to authorize the certificate.
	CaCertificateId *string

	// The client ID.
	ClientId *string

	// The ID of the Amazon Cognito identity pool.
	CognitoIdentityPoolId *string

	// The ARN of the identified device certificate.
	DeviceCertificateArn *string

	// The ID of the certificate attached to the resource.
	DeviceCertificateId *string

	// The ARN of the IAM role that has overly permissive actions.
	IamRoleArn *string

	// The issuer certificate identifier.
	IssuerCertificateIdentifier *IssuerCertificateIdentifier

	// The version of the policy associated with the resource.
	PolicyVersionIdentifier *PolicyVersionIdentifier

	// The ARN of the role alias that has overly permissive actions.
	RoleAliasArn *string
	// contains filtered or unexported fields
}

Information that identifies the noncompliant resource.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceRegistrationFailureException 

type ResourceRegistrationFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource registration failed.

func (*ResourceRegistrationFailureException) Error 

func (e *ResourceRegistrationFailureException) Error() string

func (*ResourceRegistrationFailureException) ErrorCode 

func (e *ResourceRegistrationFailureException) ErrorCode() string

func (*ResourceRegistrationFailureException) ErrorFault 

func (e *ResourceRegistrationFailureException) ErrorFault() smithy.ErrorFault

func (*ResourceRegistrationFailureException) ErrorMessage 

func (e *ResourceRegistrationFailureException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeDeviceCertificate   ResourceType = "DEVICE_CERTIFICATE"
	ResourceTypeCaCertificate       ResourceType = "CA_CERTIFICATE"
	ResourceTypeIotPolicy           ResourceType = "IOT_POLICY"
	ResourceTypeCognitoIdentityPool ResourceType = "COGNITO_IDENTITY_POOL"
	ResourceTypeClientId            ResourceType = "CLIENT_ID"
	ResourceTypeAccountSettings     ResourceType = "ACCOUNT_SETTINGS"
	ResourceTypeRoleAlias           ResourceType = "ROLE_ALIAS"
	ResourceTypeIamRole             ResourceType = "IAM_ROLE"
	ResourceTypeIssuerCertificate   ResourceType = "ISSUER_CERTIFICATE"
)

Enum values for ResourceType

func (ResourceType) Values added in v0.29.0 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RetryCriteria added in v1.20.0 

type RetryCriteria struct {

	// The type of job execution failures that can initiate a job retry.
	//
	// This member is required.
	FailureType RetryableFailureType

	// The number of retries allowed for a failure type for the job.
	//
	// This member is required.
	NumberOfRetries *int32
	// contains filtered or unexported fields
}

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

type RetryableFailureType added in v1.20.0 

type RetryableFailureType string
const (
	RetryableFailureTypeFailed   RetryableFailureType = "FAILED"
	RetryableFailureTypeTimedOut RetryableFailureType = "TIMED_OUT"
	RetryableFailureTypeAll      RetryableFailureType = "ALL"
)

Enum values for RetryableFailureType

func (RetryableFailureType) Values added in v1.20.0 

func (RetryableFailureType) Values() []RetryableFailureType

Values returns all known values for RetryableFailureType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RoleAliasDescription 

type RoleAliasDescription struct {

	// The UNIX timestamp of when the role alias was created.
	CreationDate *time.Time

	// The number of seconds for which the credential is valid.
	CredentialDurationSeconds *int32

	// The UNIX timestamp of when the role alias was last modified.
	LastModifiedDate *time.Time

	// The role alias owner.
	Owner *string

	// The role alias.
	RoleAlias *string

	// The ARN of the role alias.
	RoleAliasArn *string

	// The role ARN.
	RoleArn *string
	// contains filtered or unexported fields
}

Role alias description.

type S3Action 

type S3Action struct {

	// The Amazon S3 bucket.
	//
	// This member is required.
	BucketName *string

	// The object key. For more information, see [Actions, resources, and condition keys for Amazon S3].
	//
	// [Actions, resources, and condition keys for Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html
	//
	// This member is required.
	Key *string

	// The ARN of the IAM role that grants access.
	//
	// This member is required.
	RoleArn *string

	// The Amazon S3 canned ACL that controls access to the object identified by the
	// object key. For more information, see [S3 canned ACLs].
	//
	// [S3 canned ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
	CannedAcl CannedAccessControlList
	// contains filtered or unexported fields
}

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

type S3Destination 

type S3Destination struct {

	// The S3 bucket that contains the updated firmware.
	Bucket *string

	// The S3 prefix.
	Prefix *string
	// contains filtered or unexported fields
}

Describes the location of updated firmware in S3.

type S3Location 

type S3Location struct {

	// The S3 bucket.
	Bucket *string

	// The S3 key.
	Key *string

	// The S3 bucket version.
	Version *string
	// contains filtered or unexported fields
}

The S3 location.

type SalesforceAction 

type SalesforceAction struct {

	// The token used to authenticate access to the Salesforce IoT Cloud Input Stream.
	// The token is available from the Salesforce IoT Cloud platform after creation of
	// the Input Stream.
	//
	// This member is required.
	Token *string

	// The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available
	// from the Salesforce IoT Cloud platform after creation of the Input Stream.
	//
	// This member is required.
	Url *string
	// contains filtered or unexported fields
}

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

type Sbom added in v1.56.0 

type Sbom struct {

	// The S3 location.
	S3Location *S3Location
	// contains filtered or unexported fields
}

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

type SbomValidationErrorCode added in v1.56.0 

type SbomValidationErrorCode string
const (
	SbomValidationErrorCodeIncompatibleFormat    SbomValidationErrorCode = "INCOMPATIBLE_FORMAT"
	SbomValidationErrorCodeFileSizeLimitExceeded SbomValidationErrorCode = "FILE_SIZE_LIMIT_EXCEEDED"
)

Enum values for SbomValidationErrorCode

func (SbomValidationErrorCode) Values added in v1.56.0 

func (SbomValidationErrorCode) Values() []SbomValidationErrorCode

Values returns all known values for SbomValidationErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SbomValidationResult added in v1.56.0 

type SbomValidationResult string
const (
	SbomValidationResultFailed    SbomValidationResult = "FAILED"
	SbomValidationResultSucceeded SbomValidationResult = "SUCCEEDED"
)

Enum values for SbomValidationResult

func (SbomValidationResult) Values added in v1.56.0 

func (SbomValidationResult) Values() []SbomValidationResult

Values returns all known values for SbomValidationResult. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SbomValidationResultSummary added in v1.56.0 

type SbomValidationResultSummary struct {

	// The errorCode representing the validation failure error if the SBOM validation
	// failed.
	ErrorCode SbomValidationErrorCode

	// The errorMessage representing the validation failure error if the SBOM
	// validation failed.
	ErrorMessage *string

	// The name of the SBOM file.
	FileName *string

	// The end result of the SBOM validation.
	ValidationResult SbomValidationResult
	// contains filtered or unexported fields
}

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

type SbomValidationStatus added in v1.56.0 

type SbomValidationStatus string
const (
	SbomValidationStatusInProgress SbomValidationStatus = "IN_PROGRESS"
	SbomValidationStatusFailed     SbomValidationStatus = "FAILED"
	SbomValidationStatusSucceeded  SbomValidationStatus = "SUCCEEDED"
)

Enum values for SbomValidationStatus

func (SbomValidationStatus) Values added in v1.56.0 

func (SbomValidationStatus) Values() []SbomValidationStatus

Values returns all known values for SbomValidationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ScheduledAuditMetadata 

type ScheduledAuditMetadata struct {

	// The day of the month on which the scheduled audit is run (if the frequency is
	// "MONTHLY"). If days 29-31 are specified, and the month does not have that many
	// days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string

	// The day of the week on which the scheduled audit is run (if the frequency is
	// "WEEKLY" or "BIWEEKLY").
	DayOfWeek DayOfWeek

	// How often the scheduled audit occurs.
	Frequency AuditFrequency

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string

	// The name of the scheduled audit.
	ScheduledAuditName *string
	// contains filtered or unexported fields
}

Information about the scheduled audit.

type ScheduledJobRollout added in v1.35.0 

type ScheduledJobRollout struct {

	// Displays the start times of the next seven maintenance window occurrences.
	StartTime *string
	// contains filtered or unexported fields
}

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

type SchedulingConfig added in v1.32.0 

type SchedulingConfig struct {

	// Specifies the end behavior for all job executions after a job reaches the
	// selected endTime . If endTime is not selected when creating the job, then
	// endBehavior does not apply.
	EndBehavior JobEndBehavior

	// The time a job will stop rollout of the job document to all devices in the
	// target group for a job. The endTime must take place no later than two years
	// from the current time and be scheduled a minimum of thirty minutes from the
	// current time. The minimum duration between startTime and endTime is thirty
	// minutes. The maximum duration between startTime and endTime is two years. The
	// date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for
	// the time.
	//
	// For more information on the syntax for endTime when using an API command or the
	// Command Line Interface, see [Timestamp].
	//
	// [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
	EndTime *string

	// 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.
	MaintenanceWindows []MaintenanceWindow

	// The time a job will begin rollout of the job document to all devices in the
	// target group for a job. The startTime can be scheduled up to a year in advance
	// and must be scheduled a minimum of thirty minutes from the current time. The
	// date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for
	// the time.
	//
	// For more information on the syntax for startTime when using an API command or
	// the Command Line Interface, see [Timestamp].
	//
	// [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
	StartTime *string
	// contains filtered or unexported fields
}

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.

type SecurityProfileIdentifier 

type SecurityProfileIdentifier struct {

	// The ARN of the security profile.
	//
	// This member is required.
	Arn *string

	// The name you've given to the security profile.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Identifying information for a Device Defender security profile.

type SecurityProfileTarget 

type SecurityProfileTarget struct {

	// The ARN of the security profile.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

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

type SecurityProfileTargetMapping 

type SecurityProfileTargetMapping struct {

	// Information that identifies the security profile.
	SecurityProfileIdentifier *SecurityProfileIdentifier

	// Information about the target (thing group) associated with the security profile.
	Target *SecurityProfileTarget
	// contains filtered or unexported fields
}

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

type ServerCertificateConfig added in v1.50.0 

type ServerCertificateConfig struct {

	// A Boolean value that indicates whether Online Certificate Status Protocol
	// (OCSP) server certificate check is enabled or not.
	//
	// For more information, see [Server certificate configuration for OCSP stapling] from Amazon Web Services IoT Core Developer Guide.
	//
	// [Server certificate configuration for OCSP stapling]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html
	EnableOCSPCheck *bool

	// The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web
	// Services Certificate Manager (ACM). If provided, Amazon Web Services IoT Core
	// will use this certificate to validate the signature of the received OCSP
	// response. The OCSP responder must sign responses using either this authorized
	// responder certificate or the issuing certificate, depending on whether the ARN
	// is provided or not. The certificate must be in the same Amazon Web Services
	// account and region as the domain configuration.
	OcspAuthorizedResponderArn *string

	// The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for
	// Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP)
	// responder, supporting basic OCSP responses. The Lambda function accepts a
	// base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER)
	// format. The Lambda function's response is also a base64-encoded OCSP response in
	// the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda
	// function must be in the same Amazon Web Services account and region as the
	// domain configuration. For more information, see [Configuring server certificate OCSP for private endpoints in Amazon Web Services IoT Core]from the Amazon Web Services
	// IoT Core developer guide.
	//
	// [Configuring server certificate OCSP for private endpoints in Amazon Web Services IoT Core]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-cert-config.html#iot-custom-endpoints-cert-config-ocsp-private-endpoint.html
	OcspLambdaArn *string
	// contains filtered or unexported fields
}

The server certificate configuration.

type ServerCertificateStatus 

type ServerCertificateStatus string
const (
	ServerCertificateStatusInvalid ServerCertificateStatus = "INVALID"
	ServerCertificateStatusValid   ServerCertificateStatus = "VALID"
)

Enum values for ServerCertificateStatus

func (ServerCertificateStatus) Values added in v0.29.0 

func (ServerCertificateStatus) Values() []ServerCertificateStatus

Values returns all known values for ServerCertificateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServerCertificateSummary 

type ServerCertificateSummary struct {

	// The ARN of the server certificate.
	ServerCertificateArn *string

	// The status of the server certificate.
	ServerCertificateStatus ServerCertificateStatus

	// Details that explain the status of the server certificate.
	ServerCertificateStatusDetail *string
	// contains filtered or unexported fields
}

An object that contains information about a server certificate.

type ServiceQuotaExceededException added in v1.38.0 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Service quota has been exceeded.

func (*ServiceQuotaExceededException) Error added in v1.38.0 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode added in v1.38.0 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v1.38.0 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage added in v1.38.0 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceType 

type ServiceType string
const (
	ServiceTypeData               ServiceType = "DATA"
	ServiceTypeCredentialProvider ServiceType = "CREDENTIAL_PROVIDER"
	ServiceTypeJobs               ServiceType = "JOBS"
)

Enum values for ServiceType

func (ServiceType) Values added in v0.29.0 

func (ServiceType) Values() []ServiceType

Values returns all known values for ServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type SigV4Authorization 

type SigV4Authorization struct {

	// The ARN of the signing role.
	//
	// This member is required.
	RoleArn *string

	// The service name to use while signing with Sig V4.
	//
	// This member is required.
	ServiceName *string

	// The signing region.
	//
	// This member is required.
	SigningRegion *string
	// contains filtered or unexported fields
}

For more information, see Signature Version 4 signing process.

type SigningProfileParameter 

type SigningProfileParameter struct {

	// Certificate ARN.
	CertificateArn *string

	// The location of the code-signing certificate on your device.
	CertificatePathOnDevice *string

	// The hardware platform of your device.
	Platform *string
	// contains filtered or unexported fields
}

Describes the code-signing profile.

type SnsAction 

type SnsAction struct {

	// The ARN of the IAM role that grants access.
	//
	// This member is required.
	RoleArn *string

	// The ARN of the SNS topic.
	//
	// This member is required.
	TargetArn *string

	// (Optional) The message format of the message to publish. Accepted values are
	// "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this
	// setting to determine if the payload should be parsed and relevant
	// platform-specific bits of the payload should be extracted. To read more about
	// SNS message formats, see [https://docs.aws.amazon.com/sns/latest/dg/json-formats.html]refer to their official documentation.
	//
	// [https://docs.aws.amazon.com/sns/latest/dg/json-formats.html]: https://docs.aws.amazon.com/sns/latest/dg/json-formats.html
	MessageFormat MessageFormat
	// contains filtered or unexported fields
}

Describes an action to publish to an Amazon SNS topic.

type SortOrder added in v1.61.0 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values added in v1.61.0 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SqlParseException 

type SqlParseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*SqlParseException) Error 

func (e *SqlParseException) Error() string

func (*SqlParseException) ErrorCode 

func (e *SqlParseException) ErrorCode() string

func (*SqlParseException) ErrorFault 

func (e *SqlParseException) ErrorFault() smithy.ErrorFault

func (*SqlParseException) ErrorMessage 

func (e *SqlParseException) ErrorMessage() string

type SqsAction 

type SqsAction struct {

	// The URL of the Amazon SQS queue.
	//
	// This member is required.
	QueueUrl *string

	// The ARN of the IAM role that grants access.
	//
	// This member is required.
	RoleArn *string

	// Specifies whether to use Base64 encoding.
	UseBase64 *bool
	// contains filtered or unexported fields
}

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

type StartSigningJobParameter 

type StartSigningJobParameter struct {

	// The location to write the code-signed file.
	Destination *Destination

	// The code-signing profile name.
	SigningProfileName *string

	// Describes the code-signing profile.
	SigningProfileParameter *SigningProfileParameter
	// contains filtered or unexported fields
}

Information required to start a signing job.

type StatisticalThreshold 

type StatisticalThreshold struct {

	// The percentile that resolves to a threshold value by which compliance with a
	// behavior is determined. Metrics are collected over the specified period (
	// durationSeconds ) from all reporting devices in your account and statistical
	// ranks are calculated. Then, the measurements from a device are collected over
	// the same period. If the accumulated measurements from the device fall above or
	// below ( comparisonOperator ) the value associated with the percentile specified,
	// then the device is considered to be in compliance with the behavior, otherwise a
	// violation occurs.
	Statistic *string
	// contains filtered or unexported fields
}

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.

type Statistics 

type Statistics struct {

	// The average of the aggregated field values.
	Average *float64

	// The count of things that match the query string criteria and contain a valid
	// aggregation field value.
	Count int32

	// The maximum aggregated field value.
	Maximum *float64

	// The minimum aggregated field value.
	Minimum *float64

	// The standard deviation of the aggregated field values.
	StdDeviation *float64

	// The sum of the aggregated field values.
	Sum *float64

	// The sum of the squares of the aggregated field values.
	SumOfSquares *float64

	// The variance of the aggregated field values.
	Variance *float64
	// contains filtered or unexported fields
}

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.

type Status 

type Status string
const (
	StatusInProgress Status = "InProgress"
	StatusCompleted  Status = "Completed"
	StatusFailed     Status = "Failed"
	StatusCancelled  Status = "Cancelled"
	StatusCancelling Status = "Cancelling"
)

Enum values for Status

func (Status) Values added in v0.29.0 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StatusReason added in v1.61.0 

type StatusReason struct {

	// A code that provides additional context for the command execution status.
	//
	// This member is required.
	ReasonCode *string

	// A literal string for devices to optionally provide additional information about
	// the reason code for a command execution status.
	ReasonDescription *string
	// contains filtered or unexported fields
}

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

type StepFunctionsAction 

type StepFunctionsAction struct {

	// The ARN of the role that grants IoT permission to start execution of a state
	// machine ("Action":"states:StartExecution").
	//
	// This member is required.
	RoleArn *string

	// The name of the Step Functions state machine whose execution will be started.
	//
	// This member is required.
	StateMachineName *string

	// (Optional) A name will be given to the state machine execution consisting of
	// this prefix followed by a UUID. Step Functions automatically creates a unique
	// name for each state machine execution if one is not provided.
	ExecutionNamePrefix *string
	// contains filtered or unexported fields
}

Starts execution of a Step Functions state machine.

type Stream 

type Stream struct {

	// The ID of a file associated with a stream.
	FileId *int32

	// The stream ID.
	StreamId *string
	// contains filtered or unexported fields
}

Describes a group of files that can be streamed.

type StreamFile 

type StreamFile struct {

	// The file ID.
	FileId *int32

	// The location of the file in S3.
	S3Location *S3Location
	// contains filtered or unexported fields
}

Represents a file to stream.

type StreamInfo 

type StreamInfo struct {

	// The date when the stream was created.
	CreatedAt *time.Time

	// The description of the stream.
	Description *string

	// The files to stream.
	Files []StreamFile

	// The date when the stream was last updated.
	LastUpdatedAt *time.Time

	// An IAM role IoT assumes to access your S3 files.
	RoleArn *string

	// The stream ARN.
	StreamArn *string

	// The stream ID.
	StreamId *string

	// The stream version.
	StreamVersion *int32
	// contains filtered or unexported fields
}

Information about a stream.

type StreamSummary 

type StreamSummary struct {

	// A description of the stream.
	Description *string

	// The stream ARN.
	StreamArn *string

	// The stream ID.
	StreamId *string

	// The stream version.
	StreamVersion *int32
	// contains filtered or unexported fields
}

A summary of a stream.

type Tag 

type Tag struct {

	// The tag's key.
	//
	// This member is required.
	Key *string

	// The tag's value.
	Value *string
	// contains filtered or unexported fields
}

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

type TargetFieldOrder added in v1.45.0 

type TargetFieldOrder string
const (
	TargetFieldOrderLatLon TargetFieldOrder = "LatLon"
	TargetFieldOrderLonLat TargetFieldOrder = "LonLat"
)

Enum values for TargetFieldOrder

func (TargetFieldOrder) Values added in v1.45.0 

func (TargetFieldOrder) Values() []TargetFieldOrder

Values returns all known values for TargetFieldOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TargetSelection 

type TargetSelection string
const (
	TargetSelectionContinuous TargetSelection = "CONTINUOUS"
	TargetSelectionSnapshot   TargetSelection = "SNAPSHOT"
)

Enum values for TargetSelection

func (TargetSelection) Values added in v0.29.0 

func (TargetSelection) Values() []TargetSelection

Values returns all known values for TargetSelection. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TaskAlreadyExistsException 

type TaskAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
This exception occurs if you attempt to start a task with the same task-id as

an existing task but with a different clientRequestToken.

func (*TaskAlreadyExistsException) Error 

func (e *TaskAlreadyExistsException) Error() string

func (*TaskAlreadyExistsException) ErrorCode 

func (e *TaskAlreadyExistsException) ErrorCode() string

func (*TaskAlreadyExistsException) ErrorFault 

func (e *TaskAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*TaskAlreadyExistsException) ErrorMessage 

func (e *TaskAlreadyExistsException) ErrorMessage() string

type TaskStatistics 

type TaskStatistics struct {

	// The number of checks that did not run because the audit was canceled.
	CanceledChecks *int32

	// The number of checks that found compliant resources.
	CompliantChecks *int32

	// The number of checks.
	FailedChecks *int32

	// The number of checks in progress.
	InProgressChecks *int32

	// The number of checks that found noncompliant resources.
	NonCompliantChecks *int32

	// The number of checks in this audit.
	TotalChecks *int32

	// The number of checks waiting for data collection.
	WaitingForDataCollectionChecks *int32
	// contains filtered or unexported fields
}

Statistics for the checks performed during the audit.

type TaskStatisticsForAuditCheck 

type TaskStatisticsForAuditCheck struct {

	// The number of findings to which the mitigation action task was canceled when
	// applied.
	CanceledFindingsCount *int64

	// The number of findings for which at least one of the actions failed when
	// applied.
	FailedFindingsCount *int64

	// The number of findings skipped because of filter conditions provided in the
	// parameters to the command.
	SkippedFindingsCount *int64

	// The number of findings for which all mitigation actions succeeded when applied.
	SucceededFindingsCount *int64

	// The total number of findings to which a task is being applied.
	TotalFindingsCount *int64
	// contains filtered or unexported fields
}

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

type TemplateType added in v1.28.0 

type TemplateType string
const (
	TemplateTypeFleetProvisioning TemplateType = "FLEET_PROVISIONING"
	TemplateTypeJitp              TemplateType = "JITP"
)

Enum values for TemplateType

func (TemplateType) Values added in v1.28.0 

func (TemplateType) Values() []TemplateType

Values returns all known values for TemplateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TermsAggregation added in v1.11.0 

type TermsAggregation struct {

	// The number of buckets to return in the response. Default to 10.
	MaxBuckets *int32
	// contains filtered or unexported fields
}

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.

type ThingAttribute 

type ThingAttribute struct {

	// A list of thing attributes which are name-value pairs.
	Attributes map[string]string

	// The thing ARN.
	ThingArn *string

	// The name of the thing.
	ThingName *string

	// The name of the thing type, if the thing has been associated with a type.
	ThingTypeName *string

	// The version of the thing record in the registry.
	Version int64
	// contains filtered or unexported fields
}

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

type ThingConnectivity 

type ThingConnectivity struct {

	// True if the thing is connected to the Amazon Web Services IoT Core service;
	// false if it is not connected.
	Connected *bool

	// The reason why the client is disconnected. If the thing has been disconnected
	// for approximately an hour, the disconnectReason value might be missing.
	DisconnectReason *string

	// The epoch time (in milliseconds) when the thing last connected or disconnected.
	// If the thing has been disconnected for approximately an hour, the time value
	// might be missing.
	Timestamp *int64
	// contains filtered or unexported fields
}

The connectivity status of the thing.

type ThingConnectivityIndexingMode 

type ThingConnectivityIndexingMode string
const (
	ThingConnectivityIndexingModeOff    ThingConnectivityIndexingMode = "OFF"
	ThingConnectivityIndexingModeStatus ThingConnectivityIndexingMode = "STATUS"
)

Enum values for ThingConnectivityIndexingMode

func (ThingConnectivityIndexingMode) Values added in v0.29.0 

func (ThingConnectivityIndexingMode) Values() []ThingConnectivityIndexingMode

Values returns all known values for ThingConnectivityIndexingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThingDocument 

type ThingDocument struct {

	// The attributes.
	Attributes map[string]string

	// Indicates whether the thing is connected to the Amazon Web Services IoT Core
	// service.
	Connectivity *ThingConnectivity

	// Contains Device Defender data.
	//
	// For more information about Device Defender, see [Device Defender].
	//
	// [Device Defender]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender.html
	DeviceDefender *string

	// The unnamed shadow and named shadow.
	//
	// For more information about shadows, see [IoT Device Shadow service.]
	//
	// [IoT Device Shadow service.]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html
	Shadow *string

	// Thing group and billing group names.
	ThingGroupNames []string

	// The thing ID.
	ThingId *string

	// The thing name.
	ThingName *string

	// The thing type name.
	ThingTypeName *string
	// contains filtered or unexported fields
}

The thing search index document.

type ThingGroupDocument 

type ThingGroupDocument struct {

	// The thing group attributes.
	Attributes map[string]string

	// Parent group names.
	ParentGroupNames []string

	// The thing group description.
	ThingGroupDescription *string

	// The thing group ID.
	ThingGroupId *string

	// The thing group name.
	ThingGroupName *string
	// contains filtered or unexported fields
}

The thing group search index document.

type ThingGroupIndexingConfiguration 

type ThingGroupIndexingConfiguration struct {

	// Thing group indexing mode.
	//
	// This member is required.
	ThingGroupIndexingMode ThingGroupIndexingMode

	// A list of thing group fields to index. This list cannot contain any managed
	// fields. Use the GetIndexingConfiguration API to get a list of managed fields.
	//
	// Contains custom field names and their data type.
	CustomFields []Field

	// Contains fields that are indexed and whose types are already known by the Fleet
	// Indexing service. This is an optional field. For more information, see [Managed fields]in the
	// Amazon Web Services IoT Core Developer Guide.
	//
	// You can't modify managed fields by updating fleet indexing configuration.
	//
	// [Managed fields]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field
	ManagedFields []Field
	// contains filtered or unexported fields
}

Thing group indexing configuration.

type ThingGroupIndexingMode 

type ThingGroupIndexingMode string
const (
	ThingGroupIndexingModeOff ThingGroupIndexingMode = "OFF"
	ThingGroupIndexingModeOn  ThingGroupIndexingMode = "ON"
)

Enum values for ThingGroupIndexingMode

func (ThingGroupIndexingMode) Values added in v0.29.0 

func (ThingGroupIndexingMode) Values() []ThingGroupIndexingMode

Values returns all known values for ThingGroupIndexingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThingGroupMetadata 

type ThingGroupMetadata struct {

	// The UNIX timestamp of when the thing group was created.
	CreationDate *time.Time

	// The parent thing group name.
	ParentGroupName *string

	// The root parent thing group.
	RootToParentThingGroups []GroupNameAndArn
	// contains filtered or unexported fields
}

Thing group metadata.

type ThingGroupProperties 

type ThingGroupProperties struct {

	// The thing group attributes in JSON format.
	AttributePayload *AttributePayload

	// The thing group description.
	ThingGroupDescription *string
	// contains filtered or unexported fields
}

Thing group properties.

type ThingIndexingConfiguration 

type ThingIndexingConfiguration struct {

	// Thing indexing mode. Valid values are:
	//
	//   - REGISTRY – Your thing index contains registry data only.
	//
	//   - REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
	//
	//   - OFF - Thing indexing is disabled.
	//
	// This member is required.
	ThingIndexingMode ThingIndexingMode

	// Contains custom field names and their data type.
	CustomFields []Field

	// Device Defender indexing mode. Valid values are:
	//
	//   - VIOLATIONS – Your thing index contains Device Defender violations. To
	//   enable Device Defender indexing, deviceDefenderIndexingMode must not be set to
	//   OFF.
	//
	//   - OFF - Device Defender indexing is disabled.
	//
	// For more information about Device Defender violations, see [Device Defender Detect.]
	//
	// [Device Defender Detect.]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html
	DeviceDefenderIndexingMode DeviceDefenderIndexingMode

	// 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].
	//
	// [Managing fleet indexing]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html
	Filter *IndexingFilter

	// Contains fields that are indexed and whose types are already known by the Fleet
	// Indexing service. This is an optional field. For more information, see [Managed fields]in the
	// Amazon Web Services IoT Core Developer Guide.
	//
	// You can't modify managed fields by updating fleet indexing configuration.
	//
	// [Managed fields]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field
	ManagedFields []Field

	// Named shadow indexing mode. Valid values are:
	//
	//   - ON – Your thing index contains named shadow. To enable thing named shadow
	//   indexing, namedShadowIndexingMode must not be set to OFF.
	//
	//   - OFF - Named shadow indexing is disabled.
	//
	// For more information about Shadows, see [IoT Device Shadow service.]
	//
	// [IoT Device Shadow service.]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html
	NamedShadowIndexingMode NamedShadowIndexingMode

	// Thing connectivity indexing mode. Valid values are:
	//
	//   - STATUS – Your thing index contains connectivity status. To enable thing
	//   connectivity indexing, thingIndexMode must not be set to OFF.
	//
	//   - OFF - Thing connectivity status indexing is disabled.
	ThingConnectivityIndexingMode ThingConnectivityIndexingMode
	// contains filtered or unexported fields
}

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

type ThingIndexingMode 

type ThingIndexingMode string
const (
	ThingIndexingModeOff               ThingIndexingMode = "OFF"
	ThingIndexingModeRegistry          ThingIndexingMode = "REGISTRY"
	ThingIndexingModeRegistryAndShadow ThingIndexingMode = "REGISTRY_AND_SHADOW"
)

Enum values for ThingIndexingMode

func (ThingIndexingMode) Values added in v0.29.0 

func (ThingIndexingMode) Values() []ThingIndexingMode

Values returns all known values for ThingIndexingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThingPrincipalObject added in v1.60.0 

type ThingPrincipalObject struct {

	// The principal of the thing principal object.
	//
	// This member is required.
	Principal *string

	// The type of the relation you want to specify when you attach a principal to a
	// thing. The value defaults to NON_EXCLUSIVE_THING .
	//
	//   - EXCLUSIVE_THING - Attaches the specified principal to the specified thing,
	//   exclusively. The thing will be the only thing that’s attached to the principal.
	//
	//   - NON_EXCLUSIVE_THING - Attaches the specified principal to the specified
	//   thing. Multiple things can be attached to the principal.
	ThingPrincipalType ThingPrincipalType
	// contains filtered or unexported fields
}

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

type ThingPrincipalType added in v1.60.0 

type ThingPrincipalType string
const (
	ThingPrincipalTypeExclusiveThing    ThingPrincipalType = "EXCLUSIVE_THING"
	ThingPrincipalTypeNonExclusiveThing ThingPrincipalType = "NON_EXCLUSIVE_THING"
)

Enum values for ThingPrincipalType

func (ThingPrincipalType) Values added in v1.60.0 

func (ThingPrincipalType) Values() []ThingPrincipalType

Values returns all known values for ThingPrincipalType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThingTypeDefinition 

type ThingTypeDefinition struct {

	// The thing type ARN.
	ThingTypeArn *string

	// 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 it was deprecated.
	ThingTypeMetadata *ThingTypeMetadata

	// The name of the thing type.
	ThingTypeName *string

	// The ThingTypeProperties for the thing type.
	ThingTypeProperties *ThingTypeProperties
	// contains filtered or unexported fields
}

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

type ThingTypeMetadata 

type ThingTypeMetadata struct {

	// The date and time when the thing type was created.
	CreationDate *time.Time

	// Whether the thing type is deprecated. If true, no new things could be
	// associated with this type.
	Deprecated bool

	// The date and time when the thing type was deprecated.
	DeprecationDate *time.Time
	// contains filtered or unexported fields
}

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.

type ThingTypeProperties 

type ThingTypeProperties struct {

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

	// A list of searchable thing attribute names.
	SearchableAttributes []string

	// The description of the thing type.
	ThingTypeDescription *string
	// contains filtered or unexported fields
}

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

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The rate exceeds the limit.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimeFilter added in v1.61.0 

type TimeFilter struct {

	// Filter to display command executions that started or completed only after a
	// particular date and time.
	After *string

	// Filter to display command executions that started or completed only before a
	// particular date and time.
	Before *string
	// contains filtered or unexported fields
}

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.

type TimeoutConfig 

type TimeoutConfig struct {

	// Specifies the amount of time, in minutes, this device has to finish execution
	// of this job. The timeout interval can be anywhere between 1 minute and 7 days (1
	// to 10080 minutes). The in progress timer can't be updated and will apply to all
	// job executions for the job. Whenever a job execution remains in the IN_PROGRESS
	// status for longer than this interval, the job execution will fail and switch to
	// the terminal TIMED_OUT status.
	InProgressTimeoutInMinutes *int64
	// contains filtered or unexported fields
}

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 .

type TimestreamAction added in v0.29.0 

type TimestreamAction struct {

	// The name of an Amazon Timestream database.
	//
	// This member is required.
	DatabaseName *string

	// Metadata attributes of the time series that are written in each measure record.
	//
	// This member is required.
	Dimensions []TimestreamDimension

	// The ARN of the role that grants permission to write to the Amazon Timestream
	// database table.
	//
	// This member is required.
	RoleArn *string

	// The name of the database table into which to write the measure records.
	//
	// This member is required.
	TableName *string

	// Specifies an application-defined value to replace the default value assigned to
	// the Timestream record's timestamp in the time column.
	//
	// You can use this property to specify the value and the precision of the
	// Timestream record's timestamp. You can specify a value from the message payload
	// or a value computed by a substitution template.
	//
	// If omitted, the topic rule action assigns the timestamp, in milliseconds, at
	// the time it processed the rule.
	Timestamp *TimestreamTimestamp
	// contains filtered or unexported fields
}

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestreamtopic rule action documentation.

type TimestreamDimension added in v0.29.0 

type TimestreamDimension struct {

	// The metadata dimension name. This is the name of the column in the Amazon
	// Timestream database table record.
	//
	// Dimensions cannot be named: measure_name , measure_value , or time . These names
	// are reserved. Dimension names cannot start with ts_ or measure_value and they
	// cannot contain the colon ( : ) character.
	//
	// This member is required.
	Name *string

	// The value to write in this column of the database record.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

type TimestreamTimestamp added in v0.29.0 

type TimestreamTimestamp struct {

	// The precision of the timestamp value that results from the expression described
	// in value .
	//
	// Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS . The default
	// is MILLISECONDS .
	//
	// This member is required.
	Unit *string

	// An expression that returns a long epoch time value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

type TlsConfig added in v1.37.0 

type TlsConfig struct {

	// The security policy for a domain configuration. For more information, see [Security policies] in
	// the Amazon Web Services IoT Core developer guide.
	//
	// [Security policies]: https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table
	SecurityPolicy *string
	// contains filtered or unexported fields
}

An object that specifies the TLS configuration for a domain.

type TlsContext 

type TlsContext struct {

	// The value of the serverName key in a TLS authorization request.
	ServerName *string
	// contains filtered or unexported fields
}

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

type TopicRule 

type TopicRule struct {

	// The actions associated with the rule.
	Actions []Action

	// The version of the SQL rules engine to use when evaluating the rule.
	AwsIotSqlVersion *string

	// The date and time the rule was created.
	CreatedAt *time.Time

	// The description of the rule.
	Description *string

	// The action to perform when an error occurs.
	ErrorAction *Action

	// Specifies whether the rule is disabled.
	RuleDisabled *bool

	// The name of the rule.
	RuleName *string

	// The SQL statement used to query the topic. When using a SQL query with multiple
	// lines, be sure to escape the newline characters.
	Sql *string
	// contains filtered or unexported fields
}

Describes a rule.

type TopicRuleDestination 

type TopicRuleDestination struct {

	// The topic rule destination URL.
	Arn *string

	// The date and time when the topic rule destination was created.
	CreatedAt *time.Time

	// Properties of the HTTP URL.
	HttpUrlProperties *HttpUrlDestinationProperties

	// The date and time when the topic rule destination was last updated.
	LastUpdatedAt *time.Time

	// The status of the topic rule destination. Valid values are:
	//
	// IN_PROGRESS A topic rule destination was created but has not been confirmed.
	// You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination .
	// Calling UpdateTopicRuleDestination causes a new confirmation challenge to be
	// sent to your confirmation endpoint.
	//
	// ENABLED Confirmation was completed, and traffic to this destination is allowed.
	// You can set status to DISABLED by calling UpdateTopicRuleDestination .
	//
	// DISABLED Confirmation was completed, and traffic to this destination is not
	// allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .
	//
	// ERROR Confirmation could not be completed, for example if the confirmation
	// timed out. You can call GetTopicRuleDestination for details about the error.
	// You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination .
	// Calling UpdateTopicRuleDestination causes a new confirmation challenge to be
	// sent to your confirmation endpoint.
	Status TopicRuleDestinationStatus

	// Additional details or reason why the topic rule destination is in the current
	// status.
	StatusReason *string

	// Properties of the virtual private cloud (VPC) connection.
	VpcProperties *VpcDestinationProperties
	// contains filtered or unexported fields
}

A topic rule destination.

type TopicRuleDestinationConfiguration 

type TopicRuleDestinationConfiguration struct {

	// Configuration of the HTTP URL.
	HttpUrlConfiguration *HttpUrlDestinationConfiguration

	// Configuration of the virtual private cloud (VPC) connection.
	VpcConfiguration *VpcDestinationConfiguration
	// contains filtered or unexported fields
}

Configuration of the topic rule destination.

type TopicRuleDestinationStatus 

type TopicRuleDestinationStatus string
const (
	TopicRuleDestinationStatusEnabled    TopicRuleDestinationStatus = "ENABLED"
	TopicRuleDestinationStatusInProgress TopicRuleDestinationStatus = "IN_PROGRESS"
	TopicRuleDestinationStatusDisabled   TopicRuleDestinationStatus = "DISABLED"
	TopicRuleDestinationStatusError      TopicRuleDestinationStatus = "ERROR"
	TopicRuleDestinationStatusDeleting   TopicRuleDestinationStatus = "DELETING"
)

Enum values for TopicRuleDestinationStatus

func (TopicRuleDestinationStatus) Values added in v0.29.0 

func (TopicRuleDestinationStatus) Values() []TopicRuleDestinationStatus

Values returns all known values for TopicRuleDestinationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TopicRuleDestinationSummary 

type TopicRuleDestinationSummary struct {

	// The topic rule destination ARN.
	Arn *string

	// The date and time when the topic rule destination was created.
	CreatedAt *time.Time

	// Information about the HTTP URL.
	HttpUrlSummary *HttpUrlDestinationSummary

	// The date and time when the topic rule destination was last updated.
	LastUpdatedAt *time.Time

	// The status of the topic rule destination. Valid values are:
	//
	// IN_PROGRESS A topic rule destination was created but has not been confirmed.
	// You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination .
	// Calling UpdateTopicRuleDestination causes a new confirmation challenge to be
	// sent to your confirmation endpoint.
	//
	// ENABLED Confirmation was completed, and traffic to this destination is allowed.
	// You can set status to DISABLED by calling UpdateTopicRuleDestination .
	//
	// DISABLED Confirmation was completed, and traffic to this destination is not
	// allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination .
	//
	// ERROR Confirmation could not be completed, for example if the confirmation
	// timed out. You can call GetTopicRuleDestination for details about the error.
	// You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination .
	// Calling UpdateTopicRuleDestination causes a new confirmation challenge to be
	// sent to your confirmation endpoint.
	Status TopicRuleDestinationStatus

	// The reason the topic rule destination is in the current status.
	StatusReason *string

	// Information about the virtual private cloud (VPC) connection.
	VpcDestinationSummary *VpcDestinationSummary
	// contains filtered or unexported fields
}

Information about the topic rule destination.

type TopicRuleListItem 

type TopicRuleListItem struct {

	// The date and time the rule was created.
	CreatedAt *time.Time

	// The rule ARN.
	RuleArn *string

	// Specifies whether the rule is disabled.
	RuleDisabled *bool

	// The name of the rule.
	RuleName *string

	// The pattern for the topic names that apply.
	TopicPattern *string
	// contains filtered or unexported fields
}

Describes a rule.

type TopicRulePayload 

type TopicRulePayload struct {

	// The actions associated with the rule.
	//
	// This member is required.
	Actions []Action

	// The SQL statement used to query the topic. For more information, see [IoT SQL Reference] in the
	// IoT Developer Guide.
	//
	// [IoT SQL Reference]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html
	//
	// This member is required.
	Sql *string

	// The version of the SQL rules engine to use when evaluating the rule.
	AwsIotSqlVersion *string

	// The description of the rule.
	Description *string

	// The action to take when an error occurs.
	ErrorAction *Action

	// Specifies whether the rule is disabled.
	RuleDisabled *bool
	// contains filtered or unexported fields
}

Describes a rule.

type TransferAlreadyCompletedException 

type TransferAlreadyCompletedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*TransferAlreadyCompletedException) Error 

func (e *TransferAlreadyCompletedException) Error() string

func (*TransferAlreadyCompletedException) ErrorCode 

func (e *TransferAlreadyCompletedException) ErrorCode() string

func (*TransferAlreadyCompletedException) ErrorFault 

func (e *TransferAlreadyCompletedException) ErrorFault() smithy.ErrorFault

func (*TransferAlreadyCompletedException) ErrorMessage 

func (e *TransferAlreadyCompletedException) ErrorMessage() string

type TransferConflictException 

type TransferConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*TransferConflictException) Error 

func (e *TransferConflictException) Error() string

func (*TransferConflictException) ErrorCode 

func (e *TransferConflictException) ErrorCode() string

func (*TransferConflictException) ErrorFault 

func (e *TransferConflictException) ErrorFault() smithy.ErrorFault

func (*TransferConflictException) ErrorMessage 

func (e *TransferConflictException) ErrorMessage() string

type TransferData 

type TransferData struct {

	// The date the transfer was accepted.
	AcceptDate *time.Time

	// The date the transfer was rejected.
	RejectDate *time.Time

	// The reason why the transfer was rejected.
	RejectReason *string

	// The date the transfer took place.
	TransferDate *time.Time

	// The transfer message.
	TransferMessage *string
	// contains filtered or unexported fields
}

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

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You are not authorized to perform this operation.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UnknownUnionMember added in v0.31.0 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateCACertificateParams 

type UpdateCACertificateParams struct {

	// The action that you want to apply to the CA certificate. The only supported
	// value is DEACTIVATE .
	//
	// This member is required.
	Action CACertificateUpdateAction
	// contains filtered or unexported fields
}

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

type UpdateDeviceCertificateParams 

type UpdateDeviceCertificateParams struct {

	// The action that you want to apply to the device certificate. The only supported
	// value is DEACTIVATE .
	//
	// This member is required.
	Action DeviceCertificateUpdateAction
	// contains filtered or unexported fields
}

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

type UserProperty added in v1.32.0 

type UserProperty struct {

	// A key to be specified in UserProperty .
	//
	// This member is required.
	Key *string

	// A value to be specified in UserProperty .
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

type ValidationError 

type ValidationError struct {

	// The description of an error found in the behaviors.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Information about an error found in a behavior specification.

type ValidationException added in v1.38.0 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is not valid.

func (*ValidationException) Error added in v1.38.0 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode added in v1.38.0 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault added in v1.38.0 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage added in v1.38.0 

func (e *ValidationException) ErrorMessage() string

type VerificationState added in v1.13.0 

type VerificationState string
const (
	VerificationStateFalsePositive  VerificationState = "FALSE_POSITIVE"
	VerificationStateBenignPositive VerificationState = "BENIGN_POSITIVE"
	VerificationStateTruePositive   VerificationState = "TRUE_POSITIVE"
	VerificationStateUnknown        VerificationState = "UNKNOWN"
)

Enum values for VerificationState

func (VerificationState) Values added in v1.13.0 

func (VerificationState) Values() []VerificationState

Values returns all known values for VerificationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VersionConflictException 

type VersionConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*VersionConflictException) Error 

func (e *VersionConflictException) Error() string

func (*VersionConflictException) ErrorCode 

func (e *VersionConflictException) ErrorCode() string

func (*VersionConflictException) ErrorFault 

func (e *VersionConflictException) ErrorFault() smithy.ErrorFault

func (*VersionConflictException) ErrorMessage 

func (e *VersionConflictException) ErrorMessage() string

type VersionUpdateByJobsConfig added in v1.38.0 

type VersionUpdateByJobsConfig struct {

	// Indicates whether the Job is enabled or not.
	Enabled *bool

	// The Amazon Resource Name (ARN) of the role that grants permission to the IoT
	// jobs service to update the reserved named shadow when the job successfully
	// completes.
	RoleArn *string
	// contains filtered or unexported fields
}

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.

type VersionsLimitExceededException 

type VersionsLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of policy versions exceeds the limit.

func (*VersionsLimitExceededException) Error 

func (e *VersionsLimitExceededException) Error() string

func (*VersionsLimitExceededException) ErrorCode 

func (e *VersionsLimitExceededException) ErrorCode() string

func (*VersionsLimitExceededException) ErrorFault 

func (e *VersionsLimitExceededException) ErrorFault() smithy.ErrorFault

func (*VersionsLimitExceededException) ErrorMessage 

func (e *VersionsLimitExceededException) ErrorMessage() string

type ViolationEvent 

type ViolationEvent struct {

	// The behavior that was violated.
	Behavior *Behavior

	// The value of the metric (the measurement).
	MetricValue *MetricValue

	// The name of the security profile whose behavior was violated.
	SecurityProfileName *string

	// The name of the thing responsible for the violation event.
	ThingName *string

	// The verification state of the violation (detect alarm).
	VerificationState VerificationState

	// The description of the verification state of the violation.
	VerificationStateDescription *string

	//  The details of a violation event.
	ViolationEventAdditionalInfo *ViolationEventAdditionalInfo

	// The time the violation event occurred.
	ViolationEventTime *time.Time

	// The type of violation event.
	ViolationEventType ViolationEventType

	// The ID of the violation event.
	ViolationId *string
	// contains filtered or unexported fields
}

Information about a Device Defender security profile behavior violation.

type ViolationEventAdditionalInfo added in v1.2.0 

type ViolationEventAdditionalInfo struct {

	//  The sensitivity of anomalous behavior evaluation. Can be Low , Medium , or High
	// .
	ConfidenceLevel ConfidenceLevel
	// contains filtered or unexported fields
}

The details of a violation event.

type ViolationEventOccurrenceRange added in v1.2.0 

type ViolationEventOccurrenceRange struct {

	//  The end date and time of a time period in which violation events occurred.
	//
	// This member is required.
	EndTime *time.Time

	//  The start date and time of a time period in which violation events occurred.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Specifies the time period of which violation events occurred between.

type ViolationEventType 

type ViolationEventType string
const (
	ViolationEventTypeInAlarm          ViolationEventType = "in-alarm"
	ViolationEventTypeAlarmCleared     ViolationEventType = "alarm-cleared"
	ViolationEventTypeAlarmInvalidated ViolationEventType = "alarm-invalidated"
)

Enum values for ViolationEventType

func (ViolationEventType) Values added in v0.29.0 

func (ViolationEventType) Values() []ViolationEventType

Values returns all known values for ViolationEventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcDestinationConfiguration added in v1.2.0 

type VpcDestinationConfiguration struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	//
	// This member is required.
	RoleArn *string

	// The subnet IDs of the VPC destination.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC.
	//
	// This member is required.
	VpcId *string

	// The security groups of the VPC destination.
	SecurityGroups []string
	// contains filtered or unexported fields
}

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

type VpcDestinationProperties added in v1.2.0 

type VpcDestinationProperties struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	RoleArn *string

	// The security groups of the VPC destination.
	SecurityGroups []string

	// The subnet IDs of the VPC destination.
	SubnetIds []string

	// The ID of the VPC.
	VpcId *string
	// contains filtered or unexported fields
}

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

type VpcDestinationSummary added in v1.2.0 

type VpcDestinationSummary struct {

	// The ARN of a role that has permission to create and attach to elastic network
	// interfaces (ENIs).
	RoleArn *string

	// The security groups of the VPC destination.
	SecurityGroups []string

	// The subnet IDs of the VPC destination.
	SubnetIds []string

	// The ID of the VPC.
	VpcId *string
	// contains filtered or unexported fields
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.