types

package
v1.5.7 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AbortConfigCriteria

type AbortConfigCriteria struct {

	// The action taken by the abort configuration.
	Action AbortCriteriaAction

	// Over-the-air (OTA) task abort criteria failure type.
	FailureType AbortCriteriaFailureType

	// The minimum number of things that must receive task execution notifications
	// before the task can be aborted.
	MinNumberOfExecutedThings *int32

	// The minimum percentage of over-the-air (OTA) task execution failures that must
	// occur to initiate the last abort.
	ThresholdPercentage *float64
	// contains filtered or unexported fields
}

Structure representing one abort config criteria.

type AbortCriteriaAction

type AbortCriteriaAction string
const (
	AbortCriteriaActionCancel AbortCriteriaAction = "CANCEL"
)

Enum values for AbortCriteriaAction

func (AbortCriteriaAction) Values

Values returns all known values for AbortCriteriaAction. 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 AbortCriteriaFailureType

type AbortCriteriaFailureType string
const (
	AbortCriteriaFailureTypeFailed   AbortCriteriaFailureType = "FAILED"
	AbortCriteriaFailureTypeRejected AbortCriteriaFailureType = "REJECTED"
	AbortCriteriaFailureTypeTimedOut AbortCriteriaFailureType = "TIMED_OUT"
	AbortCriteriaFailureTypeAll      AbortCriteriaFailureType = "ALL"
)

Enum values for AbortCriteriaFailureType

func (AbortCriteriaFailureType) Values

Values returns all known values for AbortCriteriaFailureType. 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 AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

User is not authorized.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

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

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AccountAssociationItem added in v1.1.0

type AccountAssociationItem struct {

	// The unique identifier of the account association.
	//
	// This member is required.
	AccountAssociationId *string

	// The current state of the account association, indicating its status in the
	// association lifecycle.
	//
	// This member is required.
	AssociationState AssociationState

	// The Amazon Resource Name (ARN) of the account association.
	Arn *string

	// The identifier of the connector destination associated with this account
	// association.
	ConnectorDestinationId *string

	// A description of the account association.
	Description *string

	// The error message explaining any issues with the account association, if
	// applicable.
	ErrorMessage *string

	// The name of the account association.
	Name *string
	// contains filtered or unexported fields
}

Structure containing information about an account association, including its identifier, state, and related metadata.

type AssociationState added in v1.1.0

type AssociationState string
const (
	AssociationStateAssociationInProgress AssociationState = "ASSOCIATION_IN_PROGRESS"
	AssociationStateAssociationFailed     AssociationState = "ASSOCIATION_FAILED"
	AssociationStateAssociationSucceeded  AssociationState = "ASSOCIATION_SUCCEEDED"
	AssociationStateAssociationDeleting   AssociationState = "ASSOCIATION_DELETING"
	AssociationStateRefreshTokenExpired   AssociationState = "REFRESH_TOKEN_EXPIRED"
)

Enum values for AssociationState

func (AssociationState) Values added in v1.1.0

Values returns all known values for AssociationState. 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 AuthConfig added in v1.1.0

type AuthConfig struct {

	// The OAuth configuration settings used for authentication with the third-party
	// service.
	OAuth *OAuthConfig
	// contains filtered or unexported fields
}

The authentication configuration details for a connector destination, including OAuth settings and other authentication parameters.

type AuthConfigUpdate added in v1.1.0

type AuthConfigUpdate struct {

	// The updated OAuth configuration settings for the authentication configuration.
	OAuthUpdate *OAuthUpdate
	// contains filtered or unexported fields
}

The updated authentication configuration details for a connector destination.

type AuthMaterialType

type AuthMaterialType string
const (
	AuthMaterialTypeCustomProtocolQrBarCode AuthMaterialType = "CUSTOM_PROTOCOL_QR_BAR_CODE"
	AuthMaterialTypeWifiSetupQrBarCode      AuthMaterialType = "WIFI_SETUP_QR_BAR_CODE"
	AuthMaterialTypeZwaveQrBarCode          AuthMaterialType = "ZWAVE_QR_BAR_CODE"
	AuthMaterialTypeZigbeeQrBarCode         AuthMaterialType = "ZIGBEE_QR_BAR_CODE"
	AuthMaterialTypeDiscoveredDevice        AuthMaterialType = "DISCOVERED_DEVICE"
)

Enum values for AuthMaterialType

func (AuthMaterialType) Values

Values returns all known values for AuthMaterialType. 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 AuthType added in v1.1.0

type AuthType string
const (
	AuthTypeOauth AuthType = "OAUTH"
)

Enum values for AuthType

func (AuthType) Values added in v1.1.0

func (AuthType) Values() []AuthType

Values returns all known values for AuthType. 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 CapabilityAction

type CapabilityAction struct {

	// Describe a capability action with a name.
	//
	// This member is required.
	Name *string

	// Describe a capability action with an actionTraceId for a response command.
	ActionTraceId *string

	// Describe a capability action with a capability property.
	Parameters document.Interface

	// Describe a capability action with an reference.
	Ref *string
	// contains filtered or unexported fields
}

Action for an Amazon Web Services capability, containing the action parameters for control.

type CapabilityReport

type CapabilityReport struct {

	// The endpoints used in the capability report.
	//
	// This member is required.
	Endpoints []CapabilityReportEndpoint

	// The version of the capability report.
	//
	// This member is required.
	Version *string

	// The numeric identifier of the node.
	NodeId *string
	// contains filtered or unexported fields
}

Report of all capabilities supported by the device.

type CapabilityReportCapability

type CapabilityReportCapability struct {

	// The capability actions used in the capability report.
	//
	// This member is required.
	Actions []string

	// The capability events used in the capability report.
	//
	// This member is required.
	Events []string

	// The id of the schema version.
	//
	// This member is required.
	Id *string

	// The name of the capability.
	//
	// This member is required.
	Name *string

	// The capability properties used in the capability report.
	//
	// This member is required.
	Properties []string

	// The version of the capability.
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

The capability used in capability report.

type CapabilityReportEndpoint

type CapabilityReportEndpoint struct {

	// The capabilities used in the capability report.
	//
	// This member is required.
	Capabilities []CapabilityReportCapability

	// The type of device.
	//
	// This member is required.
	DeviceTypes []string

	// The id of the endpoint used in the capability report.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

The endpoint used in the capability report.

type CapabilitySchemaItem added in v1.1.0

type CapabilitySchemaItem struct {

	// The unique identifier of the capability defined in the schema.
	//
	// This member is required.
	CapabilityId *string

	// The external identifier for the capability, used when referencing the
	// capability outside of the AWS ecosystem.
	//
	// This member is required.
	ExtrinsicId *string

	// The version of the external capability definition, used to track compatibility
	// with external systems.
	//
	// This member is required.
	ExtrinsicVersion *int32

	// The format of the capability schema, which defines how the schema is structured
	// and interpreted.
	//
	// This member is required.
	Format SchemaVersionFormat

	// The actual schema definition that describes the capability's properties,
	// actions, and events.
	//
	// This member is required.
	Schema document.Interface
	// contains filtered or unexported fields
}

Structure representing a capability schema item that defines the functionality and features supported by a managed thing.

type CloudConnectorType added in v1.1.0

type CloudConnectorType string
const (
	CloudConnectorTypeListed   CloudConnectorType = "LISTED"
	CloudConnectorTypeUnlisted CloudConnectorType = "UNLISTED"
)

Enum values for CloudConnectorType

func (CloudConnectorType) Values added in v1.1.0

Values returns all known values for CloudConnectorType. 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 CommandCapability

type CommandCapability struct {

	// Describe the command capability with the actions it supports.
	//
	// This member is required.
	Actions []CapabilityAction

	// Describe the capability with an id.
	//
	// This member is required.
	Id *string

	// Describe the capability with an name.
	//
	// This member is required.
	Name *string

	// Describe the capability with a version.
	//
	// This member is required.
	Version *string
	// contains filtered or unexported fields
}

The command capabilities added for the managed thing

type CommandEndpoint

type CommandEndpoint struct {

	// Describe the endpoint with an id, a name, and the relevant capabilities for
	// sending commands.
	//
	// This member is required.
	Capabilities []CommandCapability

	// The id of the endpoint for a managed thing.
	//
	// This member is required.
	EndpointId *string
	// contains filtered or unexported fields
}

The endpoint for a managed thing when sending a command.

type ConfigurationError

type ConfigurationError struct {

	// The error code returned when the default encryption configuration update fails.
	Code *string

	// The error message returned when the default encryption configuration update
	// fails.
	Message *string
	// contains filtered or unexported fields
}

Provides the default encryption configuration error update details.

type ConfigurationState

type ConfigurationState string
const (
	ConfigurationStateEnabled          ConfigurationState = "ENABLED"
	ConfigurationStateUpdateInProgress ConfigurationState = "UPDATE_IN_PROGRESS"
	ConfigurationStateUpdateFailed     ConfigurationState = "UPDATE_FAILED"
)

Enum values for ConfigurationState

func (ConfigurationState) Values

Values returns all known values for ConfigurationState. 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 ConfigurationStatus

type ConfigurationStatus struct {

	// The status state describing the default encryption configuration update.
	//
	// This member is required.
	State ConfigurationState

	// The error details describing a failed default encryption configuration update.
	Error *ConfigurationError
	// contains filtered or unexported fields
}

Provides the status of the default encryption configuration for an Amazon Web Services account.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is a conflict with the request.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

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

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type ConnectorDestinationSummary added in v1.1.0

type ConnectorDestinationSummary struct {

	// The identifier of the cloud connector associated with this connector
	// destination.
	CloudConnectorId *string

	// A description of the connector destination.
	Description *string

	// The unique identifier of the connector destination.
	Id *string

	// The display name of the connector destination.
	Name *string
	// contains filtered or unexported fields
}

Structure containing summary information about a connector destination, which defines how a cloud-to-cloud connector connects to a customer's AWS account.

type ConnectorEventOperation added in v1.1.0

type ConnectorEventOperation string
const (
	ConnectorEventOperationDeviceCommandResponse ConnectorEventOperation = "DEVICE_COMMAND_RESPONSE"
	ConnectorEventOperationDeviceDiscovery       ConnectorEventOperation = "DEVICE_DISCOVERY"
	ConnectorEventOperationDeviceEvent           ConnectorEventOperation = "DEVICE_EVENT"
	ConnectorEventOperationDeviceCommandRequest  ConnectorEventOperation = "DEVICE_COMMAND_REQUEST"
)

Enum values for ConnectorEventOperation

func (ConnectorEventOperation) Values added in v1.1.0

Values returns all known values for ConnectorEventOperation. 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 ConnectorItem added in v1.1.0

type ConnectorItem struct {

	// The configuration details for the cloud connector endpoint, including
	// connection parameters and authentication requirements.
	//
	// This member is required.
	EndpointConfig *EndpointConfig

	// The display name of the C2C connector.
	//
	// This member is required.
	Name *string

	// A description of the C2C connector.
	Description *string

	// The type of endpoint used for the C2C connector.
	EndpointType EndpointType

	// The identifier of the C2C connector.
	Id *string

	// The type of cloud connector created.
	Type CloudConnectorType
	// contains filtered or unexported fields
}

Structure describing a connector.

type CredentialLockerSummary

type CredentialLockerSummary struct {

	// The Amazon Resource Name (ARN) of the credential locker.
	Arn *string

	// The timestampe value of when the credential locker was created at.
	CreatedAt *time.Time

	// The id of the credential locker.
	Id *string

	// The name of the credential locker.
	Name *string
	// contains filtered or unexported fields
}

Structure describing one Credential Locker.

type DeliveryDestinationType

type DeliveryDestinationType string
const (
	DeliveryDestinationTypeKinesis DeliveryDestinationType = "KINESIS"
)

Enum values for DeliveryDestinationType

func (DeliveryDestinationType) Values

Values returns all known values for DeliveryDestinationType. 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 DestinationSummary

type DestinationSummary struct {

	// The Amazon Resource Name (ARN) of the customer-managed destination.
	DeliveryDestinationArn *string

	// The destination type for the customer-managed destination.
	DeliveryDestinationType DeliveryDestinationType

	// The description of the customer-managed destination.
	Description *string

	// The name of the customer-managed destination.
	Name *string

	// The Amazon Resource Name (ARN) of the delivery destination.
	RoleArn *string
	// contains filtered or unexported fields
}

Structure describing a destination for IoT managed integrations to deliver notifications for a device.

type Device added in v1.1.0

type Device struct {

	// The capability report for the device.
	//
	// This member is required.
	CapabilityReport *MatterCapabilityReport

	// The device id as defined by the connector.
	//
	// This parameter is used for cloud-to-cloud devices only.
	//
	// This member is required.
	ConnectorDeviceId *string

	// Report of all capabilities supported by the device.
	CapabilitySchemas []CapabilitySchemaItem

	// The name of the device as defined by the connector.
	ConnectorDeviceName *string

	// The metadata attributes for a device.
	DeviceMetadata document.Interface
	// contains filtered or unexported fields
}

Describe the device using the relevant metadata and supported clusters for device discovery.

type DeviceDiscoveryStatus

type DeviceDiscoveryStatus string
const (
	DeviceDiscoveryStatusRunning   DeviceDiscoveryStatus = "RUNNING"
	DeviceDiscoveryStatusSucceeded DeviceDiscoveryStatus = "SUCCEEDED"
	DeviceDiscoveryStatusFailed    DeviceDiscoveryStatus = "FAILED"
	DeviceDiscoveryStatusTimedOut  DeviceDiscoveryStatus = "TIMED_OUT"
)

Enum values for DeviceDiscoveryStatus

func (DeviceDiscoveryStatus) Values

Values returns all known values for DeviceDiscoveryStatus. 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 DeviceDiscoverySummary added in v1.1.0

type DeviceDiscoverySummary struct {

	// The type of discovery process used to find devices.
	DiscoveryType DiscoveryType

	// The unique identifier of the device discovery job.
	Id *string

	// The current status of the device discovery job.
	Status DeviceDiscoveryStatus
	// contains filtered or unexported fields
}

Structure containing summary information about a device discovery job, including its identifier, type, and status.

type DisconnectReasonValue

type DisconnectReasonValue string
const (
	DisconnectReasonValueAuthError                 DisconnectReasonValue = "AUTH_ERROR"
	DisconnectReasonValueClientInitiatedDisconnect DisconnectReasonValue = "CLIENT_INITIATED_DISCONNECT"
	DisconnectReasonValueClientError               DisconnectReasonValue = "CLIENT_ERROR"
	DisconnectReasonValueConnectionLost            DisconnectReasonValue = "CONNECTION_LOST"
	DisconnectReasonValueDuplicateClientid         DisconnectReasonValue = "DUPLICATE_CLIENTID"
	DisconnectReasonValueForbiddenAccess           DisconnectReasonValue = "FORBIDDEN_ACCESS"
	DisconnectReasonValueMqttKeepAliveTimeout      DisconnectReasonValue = "MQTT_KEEP_ALIVE_TIMEOUT"
	DisconnectReasonValueServerError               DisconnectReasonValue = "SERVER_ERROR"
	DisconnectReasonValueServerInitiatedDisconnect DisconnectReasonValue = "SERVER_INITIATED_DISCONNECT"
	DisconnectReasonValueThrottled                 DisconnectReasonValue = "THROTTLED"
	DisconnectReasonValueWebsocketTtlExpiration    DisconnectReasonValue = "WEBSOCKET_TTL_EXPIRATION"
	DisconnectReasonValueCustomauthTtlExpiration   DisconnectReasonValue = "CUSTOMAUTH_TTL_EXPIRATION"
	DisconnectReasonValueUnknown                   DisconnectReasonValue = "UNKNOWN"
	DisconnectReasonValueNone                      DisconnectReasonValue = "NONE"
)

Enum values for DisconnectReasonValue

func (DisconnectReasonValue) Values

Values returns all known values for DisconnectReasonValue. 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 DiscoveredDeviceSummary added in v1.1.0

type DiscoveredDeviceSummary struct {

	// The authentication material required for connecting to the discovered device,
	// such as credentials or tokens.
	AuthenticationMaterial *string

	// The brand of the discovered device.
	Brand *string

	// The third-party device identifier as defined by the connector. This identifier
	// must not contain personal identifiable information (PII).
	ConnectorDeviceId *string

	// The name of the device as defined by the connector or third-party system.
	ConnectorDeviceName *string

	// The list of device types or categories that the discovered device belongs to.
	DeviceTypes []string

	// The timestamp indicating when the device was discovered.
	DiscoveredAt *time.Time

	// The identifier of the managed thing created for this discovered device, if one
	// exists.
	ManagedThingId *string

	// The model of the discovered device.
	Model *string

	// The status of the discovered device, indicating whether it has been added,
	// removed, or modified since the last discovery.
	Modification DiscoveryModification
	// contains filtered or unexported fields
}

Structure containing summary information about a device discovered during a device discovery job.

type DiscoveryAuthMaterialType

type DiscoveryAuthMaterialType string
const (
	DiscoveryAuthMaterialTypeZwaveInstallCode DiscoveryAuthMaterialType = "ZWAVE_INSTALL_CODE"
)

Enum values for DiscoveryAuthMaterialType

func (DiscoveryAuthMaterialType) Values

Values returns all known values for DiscoveryAuthMaterialType. 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 DiscoveryModification added in v1.1.0

type DiscoveryModification string
const (
	DiscoveryModificationDiscovered DiscoveryModification = "DISCOVERED"
	DiscoveryModificationUpdated    DiscoveryModification = "UPDATED"
	DiscoveryModificationNoChange   DiscoveryModification = "NO_CHANGE"
)

Enum values for DiscoveryModification

func (DiscoveryModification) Values added in v1.1.0

Values returns all known values for DiscoveryModification. 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 DiscoveryType

type DiscoveryType string
const (
	DiscoveryTypeZwave  DiscoveryType = "ZWAVE"
	DiscoveryTypeZigbee DiscoveryType = "ZIGBEE"
	DiscoveryTypeCloud  DiscoveryType = "CLOUD"
	DiscoveryTypeCustom DiscoveryType = "CUSTOM"
)

Enum values for DiscoveryType

func (DiscoveryType) Values

func (DiscoveryType) Values() []DiscoveryType

Values returns all known values for DiscoveryType. 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 EncryptionType

type EncryptionType string
const (
	EncryptionTypeManagedIntegrationsDefaultEncryption EncryptionType = "MANAGED_INTEGRATIONS_DEFAULT_ENCRYPTION"
	EncryptionTypeCustomerKeyEncryption                EncryptionType = "CUSTOMER_KEY_ENCRYPTION"
)

Enum values for EncryptionType

func (EncryptionType) Values

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. 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 EndpointConfig added in v1.1.0

type EndpointConfig struct {

	// The Lambda function configuration for the endpoint, used when the endpoint
	// communicates through an AWS Lambda function.
	Lambda *LambdaConfig
	// contains filtered or unexported fields
}

The configuration details for an endpoint, which defines how to connect to and communicate with external services.

type EndpointType added in v1.1.0

type EndpointType string
const (
	EndpointTypeLambda EndpointType = "LAMBDA"
)

Enum values for EndpointType

func (EndpointType) Values added in v1.1.0

func (EndpointType) Values() []EndpointType

Values returns all known values for EndpointType. 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 EventLogConfigurationSummary

type EventLogConfigurationSummary struct {

	// The logging level for the event log configuration.
	EventLogLevel LogLevel

	// The identifier of the event log configuration.
	Id *string

	// The identifier of the resource for the event log configuration.
	ResourceId *string

	// The type of resource for the event log configuration.
	ResourceType *string
	// contains filtered or unexported fields
}

List of event log configurations.

type EventType

type EventType string
const (
	EventTypeDeviceCommand         EventType = "DEVICE_COMMAND"
	EventTypeDeviceCommandRequest  EventType = "DEVICE_COMMAND_REQUEST"
	EventTypeDeviceDiscoveryStatus EventType = "DEVICE_DISCOVERY_STATUS"
	EventTypeDeviceEvent           EventType = "DEVICE_EVENT"
	EventTypeDeviceLifeCycle       EventType = "DEVICE_LIFE_CYCLE"
	EventTypeDeviceState           EventType = "DEVICE_STATE"
	EventTypeDeviceOta             EventType = "DEVICE_OTA"
	EventTypeConnectorAssociation  EventType = "CONNECTOR_ASSOCIATION"
	EventTypeAccountAssociation    EventType = "ACCOUNT_ASSOCIATION"
	EventTypeConnectorErrorReport  EventType = "CONNECTOR_ERROR_REPORT"
)

Enum values for EventType

func (EventType) Values

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 ExponentialRolloutRate

type ExponentialRolloutRate struct {

	// The base rate per minute for the rollout of an over-the-air (OTA) task.
	BaseRatePerMinute *int32

	// The incremental factor for increasing the rollout rate of an over-the-air (OTA)
	// task.
	IncrementFactor *float64

	// The criteria for increasing the rollout rate of an over-the-air (OTA) task.
	RateIncreaseCriteria *RolloutRateIncreaseCriteria
	// contains filtered or unexported fields
}

Structure representing exponential rate of rollout for an over-the-air (OTA) task.

type HubNetworkMode

type HubNetworkMode string
const (
	HubNetworkModeStandard             HubNetworkMode = "STANDARD"
	HubNetworkModeNetworkWideExclusion HubNetworkMode = "NETWORK_WIDE_EXCLUSION"
)

Enum values for HubNetworkMode

func (HubNetworkMode) Values

func (HubNetworkMode) Values() []HubNetworkMode

Values returns all known values for HubNetworkMode. 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 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

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

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

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

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type InvalidRequestException added in v1.1.0

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is not valid.

func (*InvalidRequestException) Error added in v1.1.0

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode added in v1.1.0

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault added in v1.1.0

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

func (*InvalidRequestException) ErrorMessage added in v1.1.0

func (e *InvalidRequestException) ErrorMessage() string

type LambdaConfig added in v1.1.0

type LambdaConfig struct {

	// The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

Configuration details for an AWS Lambda function used as an endpoint for a cloud connector.

type LimitExceededException added in v1.1.0

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request exceeds a service limit or quota. Adjust your request parameters and try again.

func (*LimitExceededException) Error added in v1.1.0

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode added in v1.1.0

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault added in v1.1.0

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

func (*LimitExceededException) ErrorMessage added in v1.1.0

func (e *LimitExceededException) ErrorMessage() string

type LogLevel

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

Enum values for LogLevel

func (LogLevel) Values

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 ManagedThingAssociation added in v1.1.0

type ManagedThingAssociation struct {

	// The identifier of the account association in the association.
	AccountAssociationId *string

	// The identifier of the managed thing in the association.
	ManagedThingId *string
	// contains filtered or unexported fields
}

Structure representing an association between a managed thing and an account association, which connects a device to a third-party account.

type ManagedThingSchemaListItem

type ManagedThingSchemaListItem struct {

	// The id of the capability for a managed thing.
	CapabilityId *string

	// The id of the endpoint for a managed thing.
	EndpointId *string

	// The validation schema for one schema item associated with a managed thing.
	Schema document.Interface
	// contains filtered or unexported fields
}

Structure representing one schema item associated with a managed thing.

type ManagedThingSummary

type ManagedThingSummary struct {

	// The timestampe value of when the managed thing was activated at.
	ActivatedAt *time.Time

	// The id of the advertised product.
	AdvertisedProductId *string

	// The Amazon Resource Name (ARN) of the managed thing.
	Arn *string

	// The brand of the device.
	Brand *string

	// The classification of the managed thing such as light bulb or thermostat.
	Classification *string

	// The identifier of the connector destination associated with this managed thing,
	// if applicable.
	ConnectorDestinationId *string

	// The third-party device id as defined by the connector. This device id must not
	// contain personal identifiable information (PII).
	//
	// This parameter is used for cloud-to-cloud devices only.
	ConnectorDeviceId *string

	// The id of the connector policy.
	//
	// This parameter is used for cloud-to-cloud devices only.
	//
	// Deprecated: ConnectorPolicyId has been deprecated
	ConnectorPolicyId *string

	// The timestamp value of when the device creation request occurred.
	CreatedAt *time.Time

	// The identifier of the credential locker for the managed thing.
	CredentialLockerId *string

	// The id of the device.
	Id *string

	// The model of the device.
	Model *string

	// The name of the managed thing representing the physical device.
	Name *string

	// Owner of the device, usually an indication of whom the device belongs to. This
	// value should not contain personal identifiable information.
	Owner *string

	// Id of the controller device used for the discovery job.
	ParentControllerId *string

	// The provisioning status of the device in the provisioning workflow for
	// onboarding to IoT managed integrations.
	ProvisioningStatus ProvisioningStatus

	// The type of device used. This will be the Amazon Web Services hub controller,
	// cloud device, or IoT device.
	Role Role

	// The serial number of the device.
	SerialNumber *string

	// The timestamp value of when the managed thing was last updated at.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Structure representing one managed thing.

type MatterCapabilityReport added in v1.1.0

type MatterCapabilityReport struct {

	// The endpoints used in the capability report.
	//
	// This member is required.
	Endpoints []MatterCapabilityReportEndpoint

	// The version of the capability report.
	//
	// This member is required.
	Version *string

	// The numeric identifier of the node.
	NodeId *string
	// contains filtered or unexported fields
}

Matter based capability report.

type MatterCapabilityReportAttribute added in v1.1.0

type MatterCapabilityReportAttribute struct {

	// The id of the Matter attribute.
	Id *string

	// Name for the Amazon Web Services Matter capability report attribute.
	Name *string

	// Value for the Amazon Web Services Matter capability report attribute.
	Value document.Interface
	// contains filtered or unexported fields
}

Matter attribute used in capability report.

type MatterCapabilityReportCluster added in v1.1.0

type MatterCapabilityReportCluster struct {

	// The id of the Amazon Web Services Matter capability report cluster.
	//
	// This member is required.
	Id *string

	// The id of the revision for the Amazon Web Services Matter capability report.
	//
	// This member is required.
	Revision *int32

	// The attributes of the Amazon Web Services Matter capability report.
	Attributes []MatterCapabilityReportAttribute

	// The commands used with the Amazon Web Services Matter capability report.
	Commands []string

	// The events used with the Amazon Web Services Matter capability report.
	Events []string

	// The fabric index for the Amazon Web Services Matter capability report.
	FabricIndex *int32

	// 32 bit-map used to indicate which features a cluster supports.
	FeatureMap *int64

	// Matter clusters used in capability report.
	GeneratedCommands []string

	// The capability name used in the Amazon Web Services Matter capability report.
	Name *string

	// The id of the schema version.
	PublicId *string

	// The spec version used in the Amazon Web Services Matter capability report.
	SpecVersion *string
	// contains filtered or unexported fields
}

Capability used in Matter capability report.

type MatterCapabilityReportEndpoint added in v1.1.0

type MatterCapabilityReportEndpoint struct {

	// Matter clusters used in capability report.
	//
	// This member is required.
	Clusters []MatterCapabilityReportCluster

	// The type of device.
	//
	// This member is required.
	DeviceTypes []string

	// The id of the Amazon Web Services Matter capability report endpoint.
	//
	// This member is required.
	Id *string

	// Semantic information related to endpoint.
	ClientClusters []string

	// Heirachy of child endpoints contained in the given endpoint.
	Parts []string

	// Semantic information related to endpoint.
	SemanticTags []string
	// contains filtered or unexported fields
}

Matter endpoint used in capability report.

type MatterCluster added in v1.1.0

type MatterCluster struct {

	// The Matter attributes.
	Attributes document.Interface

	// Describe the Matter commands with the Matter command identifier mapped to the
	// command fields.
	Commands map[string]document.Interface

	// Describe the Matter events with the Matter event identifier mapped to the event
	// fields.
	Events map[string]document.Interface

	// The cluster id.
	Id *string
	// contains filtered or unexported fields
}

Describe a Matter cluster with an id, and the relevant attributes, commands, and events.

type MatterEndpoint added in v1.1.0

type MatterEndpoint struct {

	// A list of Matter clusters for a managed thing.
	Clusters []MatterCluster

	// The Matter endpoint id.
	Id *string
	// contains filtered or unexported fields
}

Structure describing a managed thing.

type NotificationConfigurationSummary

type NotificationConfigurationSummary struct {

	// The name of the destination for the notification configuration.
	DestinationName *string

	// The type of event triggering a device notification to the customer-managed
	// destination.
	EventType EventType
	// contains filtered or unexported fields
}

Structure describing a notification configuration.

type OAuthConfig added in v1.1.0

type OAuthConfig struct {

	// The authorization URL for the OAuth service, where users are directed to
	// authenticate and authorize access.
	//
	// This member is required.
	AuthUrl *string

	// The authentication scheme used when requesting tokens from the token endpoint.
	//
	// This member is required.
	TokenEndpointAuthenticationScheme TokenEndpointAuthenticationScheme

	// The token URL for the OAuth service, where authorization codes are exchanged
	// for access tokens.
	//
	// This member is required.
	TokenUrl *string

	// The URL where users are redirected after completing the OAuth authorization
	// process.
	OAuthCompleteRedirectUrl *string

	// Configuration for proactively refreshing OAuth tokens before they expire.
	ProactiveRefreshTokenRenewal *ProactiveRefreshTokenRenewal

	// The OAuth scopes requested during authorization, which define the permissions
	// granted to the application.
	Scope *string
	// contains filtered or unexported fields
}

Configuration details for OAuth authentication with a third-party service.

type OAuthUpdate added in v1.1.0

type OAuthUpdate struct {

	// The updated URL where users are redirected after completing the OAuth
	// authorization process.
	OAuthCompleteRedirectUrl *string

	// Updated configuration for proactively refreshing OAuth tokens before they
	// expire.
	ProactiveRefreshTokenRenewal *ProactiveRefreshTokenRenewal
	// contains filtered or unexported fields
}

Structure containing updated OAuth configuration settings.

type OtaMechanism

type OtaMechanism string
const (
	OtaMechanismPush OtaMechanism = "PUSH"
)

Enum values for OtaMechanism

func (OtaMechanism) Values

func (OtaMechanism) Values() []OtaMechanism

Values returns all known values for OtaMechanism. 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 OtaProtocol

type OtaProtocol string
const (
	OtaProtocolHttp OtaProtocol = "HTTP"
)

Enum values for OtaProtocol

func (OtaProtocol) Values

func (OtaProtocol) Values() []OtaProtocol

Values returns all known values for OtaProtocol. 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 OtaStatus

type OtaStatus string
const (
	OtaStatusInProgress         OtaStatus = "IN_PROGRESS"
	OtaStatusCanceled           OtaStatus = "CANCELED"
	OtaStatusCompleted          OtaStatus = "COMPLETED"
	OtaStatusDeletionInProgress OtaStatus = "DELETION_IN_PROGRESS"
	OtaStatusScheduled          OtaStatus = "SCHEDULED"
)

Enum values for OtaStatus

func (OtaStatus) Values

func (OtaStatus) Values() []OtaStatus

Values returns all known values for OtaStatus. 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 OtaTaskAbortConfig

type OtaTaskAbortConfig struct {

	// The list of criteria for the abort config.
	AbortConfigCriteriaList []AbortConfigCriteria
	// contains filtered or unexported fields
}

Over-the-air (OTA) task abort config.

type OtaTaskConfigurationSummary

type OtaTaskConfigurationSummary struct {

	// The timestamp value of when the over-the-air (OTA) task configuration was
	// created at.
	CreatedAt *time.Time

	// The name of the over-the-air (OTA) task configuration.
	Name *string

	// The id of the over-the-air (OTA) task configuration
	TaskConfigurationId *string
	// contains filtered or unexported fields
}

Structure representing one over-the-air (OTA) task configuration.

type OtaTaskExecutionRetryConfig

type OtaTaskExecutionRetryConfig struct {

	// The list of retry config criteria.
	RetryConfigCriteria []RetryConfigCriteria
	// contains filtered or unexported fields
}

Over-the-air (OTA) task retry config.

type OtaTaskExecutionRolloutConfig

type OtaTaskExecutionRolloutConfig struct {

	// Structure representing exponential rate of rollout for an over-the-air (OTA)
	// task.
	ExponentialRolloutRate *ExponentialRolloutRate

	// The maximum number of things that will be notified of a pending task, per
	// minute.
	MaximumPerMinute *int32
	// contains filtered or unexported fields
}

Over-the-air (OTA) task rollout config.

type OtaTaskExecutionStatus

type OtaTaskExecutionStatus string
const (
	OtaTaskExecutionStatusQueued     OtaTaskExecutionStatus = "QUEUED"
	OtaTaskExecutionStatusInProgress OtaTaskExecutionStatus = "IN_PROGRESS"
	OtaTaskExecutionStatusSucceeded  OtaTaskExecutionStatus = "SUCCEEDED"
	OtaTaskExecutionStatusFailed     OtaTaskExecutionStatus = "FAILED"
	OtaTaskExecutionStatusTimedOut   OtaTaskExecutionStatus = "TIMED_OUT"
	OtaTaskExecutionStatusRejected   OtaTaskExecutionStatus = "REJECTED"
	OtaTaskExecutionStatusRemoved    OtaTaskExecutionStatus = "REMOVED"
	OtaTaskExecutionStatusCanceled   OtaTaskExecutionStatus = "CANCELED"
)

Enum values for OtaTaskExecutionStatus

func (OtaTaskExecutionStatus) Values

Values returns all known values for OtaTaskExecutionStatus. 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 OtaTaskExecutionSummaries

type OtaTaskExecutionSummaries struct {

	// The id of a managed thing.
	ManagedThingId *string

	// Structure representing one over-the-air (OTA) task execution summary
	TaskExecutionSummary *OtaTaskExecutionSummary
	// contains filtered or unexported fields
}

Structure representing one execution summary.

type OtaTaskExecutionSummary

type OtaTaskExecutionSummary struct {

	// The execution number of the over-the-air (OTA) task execution summary.
	ExecutionNumber *int64

	// The timestamp value of when the over-the-air (OTA) task execution summary was
	// last updated.
	LastUpdatedAt *time.Time

	// The timestamp value of when the over-the-air (OTA) task execution summary is
	// targeted to start.
	QueuedAt *time.Time

	// The number of retry attempts for starting the over-the-air (OTA) task execution
	// summary after a failed attempt.
	RetryAttempt *int32

	// The timestamp value of when the over-the-air (OTA) task execution summary
	// started.
	StartedAt *time.Time

	// The status of the over-the-air (OTA) task execution summary.
	Status OtaTaskExecutionStatus
	// contains filtered or unexported fields
}

Structure representing one over-the-air (OTA) task execution summary.

type OtaTaskSchedulingConfig

type OtaTaskSchedulingConfig struct {

	// Specifies the end behavior for all task executions after a task reaches the
	// selected endTime . If endTime is not selected when creating the task, then
	// endBehavior does not apply.
	EndBehavior SchedulingConfigEndBehavior

	// The time an over-the-air (OTA) task will stop.
	EndTime *string

	// Maintenance window list for over-the-air (OTA) task scheduling config.
	MaintenanceWindows []ScheduleMaintenanceWindow

	// The time an over-the-air (OTA) task will start.
	StartTime *string
	// contains filtered or unexported fields
}

Over-the-air (OTA) task scheduling config.

type OtaTaskSummary

type OtaTaskSummary struct {

	// The timestamp value of when the over-the-air (OTA) task was created at.
	CreatedAt *time.Time

	// The timestamp value of when the over-the-air (OTA) task was last updated at.
	LastUpdatedAt *time.Time

	// The status of the over-the-air (OTA) task summary.
	Status OtaStatus

	// The Amazon Resource Name (ARN) of the over-the-air (OTA) task.
	TaskArn *string

	// The identifier for the over-the-air (OTA) task configuration.
	TaskConfigurationId *string

	// The id of the over-the-air (OTA) task.
	TaskId *string
	// contains filtered or unexported fields
}

Structure representing one over-the-air (OTA) task.

type OtaTaskTimeoutConfig

type OtaTaskTimeoutConfig struct {

	// Specifies the amount of time the device has to finish execution of this task.
	// The timeout interval can be anywhere between 1 minute and 7 days.
	InProgressTimeoutInMinutes *int64
	// contains filtered or unexported fields
}

Over-the-air (OTA) task timeout config.

type OtaType

type OtaType string
const (
	OtaTypeOneTime    OtaType = "ONE_TIME"
	OtaTypeContinuous OtaType = "CONTINUOUS"
)

Enum values for OtaType

func (OtaType) Values

func (OtaType) Values() []OtaType

Values returns all known values for OtaType. 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 ProactiveRefreshTokenRenewal added in v1.1.0

type ProactiveRefreshTokenRenewal struct {

	// The days before token expiration when the system should attempt to renew the
	// token, specified in days.
	DaysBeforeRenewal *int32

	// Indicates whether proactive refresh token renewal is enabled.
	Enabled *bool
	// contains filtered or unexported fields
}

Configuration settings for proactively refreshing OAuth tokens before they expire.

type ProvisioningProfileSummary

type ProvisioningProfileSummary struct {

	// The Amazon Resource Name (ARN) of the provisioning template used in the
	// provisioning profile.
	Arn *string

	// The identifier of the provisioning profile.
	Id *string

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

	// The type of provisioning workflow the device uses for onboarding to IoT managed
	// integrations.
	ProvisioningType ProvisioningType
	// contains filtered or unexported fields
}

Structure describing a provisioning profile.

type ProvisioningStatus

type ProvisioningStatus string
const (
	ProvisioningStatusUnassociated     ProvisioningStatus = "UNASSOCIATED"
	ProvisioningStatusPreAssociated    ProvisioningStatus = "PRE_ASSOCIATED"
	ProvisioningStatusDiscovered       ProvisioningStatus = "DISCOVERED"
	ProvisioningStatusActivated        ProvisioningStatus = "ACTIVATED"
	ProvisioningStatusDeletionFailed   ProvisioningStatus = "DELETION_FAILED"
	ProvisioningStatusDeleteInProgress ProvisioningStatus = "DELETE_IN_PROGRESS"
	ProvisioningStatusIsolated         ProvisioningStatus = "ISOLATED"
	ProvisioningStatusDeleted          ProvisioningStatus = "DELETED"
)

Enum values for ProvisioningStatus

func (ProvisioningStatus) Values

Values returns all known values for ProvisioningStatus. 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 ProvisioningType

type ProvisioningType string
const (
	ProvisioningTypeFleetProvisioning ProvisioningType = "FLEET_PROVISIONING"
	ProvisioningTypeJitr              ProvisioningType = "JITR"
)

Enum values for ProvisioningType

func (ProvisioningType) Values

Values returns all known values for ProvisioningType. 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 PushConfig

type PushConfig struct {

	// Structure representing one abort config.
	AbortConfig *OtaTaskAbortConfig

	// Structure representing one rollout config.
	RolloutConfig *OtaTaskExecutionRolloutConfig

	// Structure representing one timeout config.
	TimeoutConfig *OtaTaskTimeoutConfig
	// contains filtered or unexported fields
}

Structure representing a push config.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *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 (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type RetryConfigCriteria

type RetryConfigCriteria struct {

	// Over-the-air (OTA) retry criteria failure type.
	FailureType RetryCriteriaFailureType

	// The number of retries allowed for a failure type for the over-the-air (OTA)
	// task.
	MinNumberOfRetries *int32
	// contains filtered or unexported fields
}

Structure representing one retry config criteria.

type RetryCriteriaFailureType

type RetryCriteriaFailureType string
const (
	RetryCriteriaFailureTypeFailed   RetryCriteriaFailureType = "FAILED"
	RetryCriteriaFailureTypeTimedOut RetryCriteriaFailureType = "TIMED_OUT"
	RetryCriteriaFailureTypeAll      RetryCriteriaFailureType = "ALL"
)

Enum values for RetryCriteriaFailureType

func (RetryCriteriaFailureType) Values

Values returns all known values for RetryCriteriaFailureType. 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 Role

type Role string
const (
	RoleController Role = "CONTROLLER"
	RoleDevice     Role = "DEVICE"
)

Enum values for Role

func (Role) Values

func (Role) Values() []Role

Values returns all known values for Role. 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 RolloutRateIncreaseCriteria

type RolloutRateIncreaseCriteria 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
}

Structure representing rollout config criteria.

type RuntimeLogConfigurations

type RuntimeLogConfigurations struct {

	// Configuration to enable or disable deleting of runtime logs in the device once
	// uploaded to the cloud.
	DeleteLocalStoreAfterUpload *bool

	// Configuration to set the maximum bytes of runtime logs that can be stored on
	// the device before the oldest logs are deleted or overwritten.
	LocalStoreFileRotationMaxBytes *int32

	// Configuration to set the maximum number of runtime log files that can be stored
	// on the device before the oldest files are deleted or overwritten.
	LocalStoreFileRotationMaxFiles *int32

	// Configuration of where to store runtime logs in the device.
	LocalStoreLocation *string

	// The different log levels available for configuration.
	LogFlushLevel LogLevel

	// The different log levels available for configuration.
	LogLevel LogLevel

	// Configuration to enable or disable uploading of runtime logs to the cloud.
	UploadLog *bool

	// Configuration to set the time interval in minutes between each batch of runtime
	// logs that the device uploads to the cloud.
	UploadPeriodMinutes *int32
	// contains filtered or unexported fields
}

The different configurations for runtime logs.

type ScheduleMaintenanceWindow

type ScheduleMaintenanceWindow struct {

	// Displays the duration of the next maintenance window.
	DurationInMinutes *int32

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

Structure representing scheduling maintenance window.

type SchedulingConfigEndBehavior

type SchedulingConfigEndBehavior string
const (
	SchedulingConfigEndBehaviorStopRollout SchedulingConfigEndBehavior = "STOP_ROLLOUT"
	SchedulingConfigEndBehaviorCancel      SchedulingConfigEndBehavior = "CANCEL"
	SchedulingConfigEndBehaviorForceCancel SchedulingConfigEndBehavior = "FORCE_CANCEL"
)

Enum values for SchedulingConfigEndBehavior

func (SchedulingConfigEndBehavior) Values

Values returns all known values for SchedulingConfigEndBehavior. 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 SchemaVersionFormat

type SchemaVersionFormat string
const (
	SchemaVersionFormatAws       SchemaVersionFormat = "AWS"
	SchemaVersionFormatZcl       SchemaVersionFormat = "ZCL"
	SchemaVersionFormatConnector SchemaVersionFormat = "CONNECTOR"
)

Enum values for SchemaVersionFormat

func (SchemaVersionFormat) Values

Values returns all known values for SchemaVersionFormat. 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 SchemaVersionListItem

type SchemaVersionListItem struct {

	// A description of the schema version.
	Description *string

	// The name of the schema version.
	Namespace *string

	// The identifier of the schema version.
	SchemaId *string

	// The schema version. If this is left blank, it defaults to the latest version.
	SemanticVersion *string

	// The type of schema version.
	Type SchemaVersionType

	// The visibility of the schema version.
	Visibility SchemaVersionVisibility
	// contains filtered or unexported fields
}

List item describing a schema version.

type SchemaVersionType

type SchemaVersionType string
const (
	SchemaVersionTypeCapability SchemaVersionType = "capability"
	SchemaVersionTypeDefinition SchemaVersionType = "definition"
)

Enum values for SchemaVersionType

func (SchemaVersionType) Values

Values returns all known values for SchemaVersionType. 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 SchemaVersionVisibility

type SchemaVersionVisibility string
const (
	SchemaVersionVisibilityPublic  SchemaVersionVisibility = "PUBLIC"
	SchemaVersionVisibilityPrivate SchemaVersionVisibility = "PRIVATE"
)

Enum values for SchemaVersionVisibility

func (SchemaVersionVisibility) Values

Values returns all known values for SchemaVersionVisibility. 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 SecretsManager added in v1.1.0

type SecretsManager struct {

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret.
	//
	// This member is required.
	Arn *string

	// The version ID of the AWS Secrets Manager secret.
	//
	// This member is required.
	VersionId *string
	// contains filtered or unexported fields
}

Configuration for AWS Secrets Manager, used to securely store and manage sensitive information for connector destinations.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service quota has been exceeded for this request.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

type StateCapability

type StateCapability struct {

	// The id of the managed thing in the capability report.
	//
	// This member is required.
	Id *string

	// Name for the Amazon Web Services capability.
	//
	// This member is required.
	Name *string

	// Version for the Amazon Web Services capability.
	//
	// This member is required.
	Version *string

	// Describe the command capability with the properties it supports.
	Properties document.Interface
	// contains filtered or unexported fields
}

State capabilities added for the managed thing.

type StateEndpoint

type StateEndpoint struct {

	// Describe the endpoint with an id, a name, and the relevant capabilities for the
	// reporting state.
	//
	// This member is required.
	Capabilities []StateCapability

	// Numeric identifier of the endpoint
	//
	// This member is required.
	EndpointId *string
	// contains filtered or unexported fields
}

Describe the endpoint with an Id, a name, and the relevant capabilities for reporting state

type TaskProcessingDetails

type TaskProcessingDetails struct {

	// The number of canceled things in an over-the-air (OTA) task.
	NumberOfCanceledThings *int32

	// The number of failed things in an over-the-air (OTA) task.
	NumberOfFailedThings *int32

	// The number of in progress things in an over-the-air (OTA) task.
	NumberOfInProgressThings *int32

	// The number of queued things in an over-the-air (OTA) task.
	NumberOfQueuedThings *int32

	// The number of rejected things in an over-the-air (OTA) task.
	NumberOfRejectedThings *int32

	// The number of removed things in an over-the-air (OTA) task.
	NumberOfRemovedThings *int32

	// The number of succeeded things in an over-the-air (OTA) task.
	NumberOfSucceededThings *int32

	// The number of timed out things in an over-the-air (OTA) task.
	NumberOfTimedOutThings *int32

	// The targets of the over-the-air (OTA) task.
	ProcessingTargets []string
	// contains filtered or unexported fields
}

Details about the over-the-air (OTA) task process.

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 TokenEndpointAuthenticationScheme added in v1.1.0

type TokenEndpointAuthenticationScheme string
const (
	TokenEndpointAuthenticationSchemeHttpBasic              TokenEndpointAuthenticationScheme = "HTTP_BASIC"
	TokenEndpointAuthenticationSchemeRequestBodyCredentials TokenEndpointAuthenticationScheme = "REQUEST_BODY_CREDENTIALS"
)

Enum values for TokenEndpointAuthenticationScheme

func (TokenEndpointAuthenticationScheme) Values added in v1.1.0

Values returns all known values for TokenEndpointAuthenticationScheme. 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 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 ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A validation error occurred when performing the API request.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

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

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL