types

package
v1.30.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permission to perform the action.

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 AssociateClientDeviceWithCoreDeviceEntry added in v1.4.0

type AssociateClientDeviceWithCoreDeviceEntry struct {

	// The name of the IoT thing that represents the client device to associate.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) operation consumes a list of these requests.

type AssociateClientDeviceWithCoreDeviceErrorEntry added in v1.4.0

type AssociateClientDeviceWithCoreDeviceErrorEntry struct {

	// The error code for the request.
	Code *string

	// A message that provides additional information about the error.
	Message *string

	// The name of the IoT thing whose associate request failed.
	ThingName *string
	// contains filtered or unexported fields
}

Contains an error that occurs from a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html) operation returns a list of these errors.

type AssociatedClientDevice added in v1.4.0

type AssociatedClientDevice struct {

	// The time that the client device was associated, expressed in ISO 8601 format.
	AssociationTimestamp *time.Time

	// The name of the IoT thing that represents the associated client device.
	ThingName *string
	// contains filtered or unexported fields
}

Contains information about a client device that is associated to a core device for cloud discovery.

type CloudComponentState

type CloudComponentState string
const (
	CloudComponentStateRequested  CloudComponentState = "REQUESTED"
	CloudComponentStateInitiated  CloudComponentState = "INITIATED"
	CloudComponentStateDeployable CloudComponentState = "DEPLOYABLE"
	CloudComponentStateFailed     CloudComponentState = "FAILED"
	CloudComponentStateDeprecated CloudComponentState = "DEPRECATED"
)

Enum values for CloudComponentState

func (CloudComponentState) Values

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

type CloudComponentStatus struct {

	// The state of the component version.
	ComponentState CloudComponentState

	// A dictionary of errors that communicate why the component version is in an
	// error state. For example, if IoT Greengrass can't access an artifact for the
	// component version, then errors contains the artifact's URI as a key, and the
	// error message as the value for that key.
	Errors map[string]string

	// A message that communicates details, such as errors, about the status of the
	// component version.
	Message *string

	// The vendor guidance state for the component version. This state indicates
	// whether the component version has any issues that you should consider before you
	// deploy it. The vendor guidance state can be:
	//   - ACTIVE – This component version is available and recommended for use.
	//   - DISCONTINUED – This component version has been discontinued by its
	//   publisher. You can deploy this component version, but we recommend that you use
	//   a different version of this component.
	//   - DELETED – This component version has been deleted by its publisher, so you
	//   can't deploy it. If you have any existing deployments that specify this
	//   component version, those deployments will fail.
	VendorGuidance VendorGuidance

	// A message that communicates details about the vendor guidance state of the
	// component version. This message communicates why a component version is
	// discontinued or deleted.
	VendorGuidanceMessage *string
	// contains filtered or unexported fields
}

Contains the status of a component version in the IoT Greengrass service.

type Component

type Component struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	Arn *string

	// The name of the component.
	ComponentName *string

	// The latest version of the component and its details.
	LatestVersion *ComponentLatestVersion
	// contains filtered or unexported fields
}

Contains information about a component.

type ComponentCandidate

type ComponentCandidate struct {

	// The name of the component.
	ComponentName *string

	// The version of the component.
	ComponentVersion *string

	// The version requirements for the component's dependencies. Greengrass core
	// devices get the version requirements from component recipes. IoT Greengrass V2
	// uses semantic version constraints. For more information, see Semantic Versioning (https://semver.org/)
	// .
	VersionRequirements map[string]string
	// contains filtered or unexported fields
}

Contains information about a component that is a candidate to deploy to a Greengrass core device.

type ComponentConfigurationUpdate

type ComponentConfigurationUpdate struct {

	// A serialized JSON string that contains the configuration object to merge to
	// target devices. The core device merges this configuration with the component's
	// existing configuration. If this is the first time a component deploys on a
	// device, the core device merges this configuration with the component's default
	// configuration. This means that the core device keeps it's existing configuration
	// for keys and values that you don't specify in this object. For more information,
	// see Merge configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update)
	// in the IoT Greengrass V2 Developer Guide.
	Merge *string

	// The list of configuration nodes to reset to default values on target devices.
	// Use JSON pointers to specify each node to reset. JSON pointers start with a
	// forward slash ( / ) and use forward slashes to separate the key for each level
	// in the object. For more information, see the JSON pointer specification (https://tools.ietf.org/html/rfc6901)
	// and Reset configuration updates (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update)
	// in the IoT Greengrass V2 Developer Guide.
	Reset []string
	// contains filtered or unexported fields
}

Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see Update component configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html) in the IoT Greengrass V2 Developer Guide.

type ComponentDependencyRequirement

type ComponentDependencyRequirement struct {

	// The type of this dependency. Choose from the following options:
	//   - SOFT – The component doesn't restart if the dependency changes state.
	//   - HARD – The component restarts if the dependency changes state.
	// Default: HARD
	DependencyType ComponentDependencyType

	// The component version requirement for the component dependency. IoT Greengrass
	// V2 uses semantic version constraints. For more information, see Semantic
	// Versioning (https://semver.org/) .
	VersionRequirement *string
	// contains filtered or unexported fields
}

Contains information about a component dependency for a Lambda function component.

type ComponentDependencyType

type ComponentDependencyType string
const (
	ComponentDependencyTypeHard ComponentDependencyType = "HARD"
	ComponentDependencyTypeSoft ComponentDependencyType = "SOFT"
)

Enum values for ComponentDependencyType

func (ComponentDependencyType) Values

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

type ComponentDeploymentSpecification struct {

	// The version of the component.
	ComponentVersion *string

	// The configuration updates to deploy for the component. You can define reset
	// updates and merge updates. A reset updates the keys that you specify to the
	// default configuration for the component. A merge updates the core device's
	// component configuration with the keys and values that you specify. The IoT
	// Greengrass Core software applies reset updates before it applies merge updates.
	// For more information, see Update component configurations (https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)
	// in the IoT Greengrass V2 Developer Guide.
	ConfigurationUpdate *ComponentConfigurationUpdate

	// The system user and group that the IoT Greengrass Core software uses to run
	// component processes on the core device. If you omit this parameter, the IoT
	// Greengrass Core software uses the system user and group that you configure for
	// the core device. For more information, see Configure the user and group that
	// run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)
	// in the IoT Greengrass V2 Developer Guide.
	RunWith *ComponentRunWith
	// contains filtered or unexported fields
}

Contains information about a component to deploy.

type ComponentLatestVersion

type ComponentLatestVersion struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	Arn *string

	// The version of the component.
	ComponentVersion *string

	// The time at which the component was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time

	// The description of the component version.
	Description *string

	// The platforms that the component version supports.
	Platforms []ComponentPlatform

	// The publisher of the component version.
	Publisher *string
	// contains filtered or unexported fields
}

Contains information about the latest version of a component.

type ComponentPlatform

type ComponentPlatform struct {

	// A dictionary of attributes for the platform. The IoT Greengrass Core software
	// defines the os and architecture by default. You can specify additional platform
	// attributes for a core device when you deploy the Greengrass nucleus component.
	// For more information, see the Greengrass nucleus component (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html)
	// in the IoT Greengrass V2 Developer Guide.
	Attributes map[string]string

	// The friendly name of the platform. This name helps you identify the platform.
	// If you omit this parameter, IoT Greengrass creates a friendly name from the os
	// and architecture of the platform.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a platform that a component supports.

type ComponentRunWith

type ComponentRunWith struct {

	// The POSIX system user and, optionally, group to use to run this component on
	// Linux core devices. The user, and group if specified, must exist on each Linux
	// core device. Specify the user and group separated by a colon ( : ) in the
	// following format: user:group . The group is optional. If you don't specify a
	// group, the IoT Greengrass Core software uses the primary user for the group. If
	// you omit this parameter, the IoT Greengrass Core software uses the default
	// system user and group that you configure on the Greengrass nucleus component.
	// For more information, see Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)
	// .
	PosixUser *string

	// The system resource limits to apply to this component's process on the core
	// device. IoT Greengrass currently supports this feature on only Linux core
	// devices. If you omit this parameter, the IoT Greengrass Core software uses the
	// default system resource limits that you configure on the Greengrass nucleus
	// component. For more information, see Configure system resource limits for
	// components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)
	// .
	SystemResourceLimits *SystemResourceLimits

	// The Windows user to use to run this component on Windows core devices. The user
	// must exist on each Windows core device, and its name and password must be in the
	// LocalSystem account's Credentials Manager instance. If you omit this parameter,
	// the IoT Greengrass Core software uses the default Windows user that you
	// configure on the Greengrass nucleus component. For more information, see
	// Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)
	// .
	WindowsUser *string
	// contains filtered or unexported fields
}

Contains information system user and group that the IoT Greengrass Core software uses to run component processes on the core device. For more information, see Configure the user and group that run components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the IoT Greengrass V2 Developer Guide.

type ComponentVersionListItem

type ComponentVersionListItem struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	Arn *string

	// The name of the component.
	ComponentName *string

	// The version of the component.
	ComponentVersion *string
	// contains filtered or unexported fields
}

Contains information about a component version in a list.

type ComponentVisibilityScope

type ComponentVisibilityScope string
const (
	ComponentVisibilityScopePrivate ComponentVisibilityScope = "PRIVATE"
	ComponentVisibilityScopePublic  ComponentVisibilityScope = "PUBLIC"
)

Enum values for ComponentVisibilityScope

func (ComponentVisibilityScope) Values

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

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

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 ConnectivityInfo added in v1.11.0

type ConnectivityInfo struct {

	// The IP address or DNS address where client devices can connect to an MQTT
	// broker on the Greengrass core device.
	HostAddress *string

	// An ID for the connectivity information.
	Id *string

	// Additional metadata to provide to client devices that connect to this core
	// device.
	Metadata *string

	// The port where the MQTT broker operates on the core device. This port is
	// typically 8883, which is the default port for the MQTT broker component that
	// runs on core devices.
	PortNumber int32
	// contains filtered or unexported fields
}

Contains information about an endpoint and port where client devices can connect to an MQTT broker on a Greengrass core device.

type CoreDevice

type CoreDevice struct {

	// The name of the core device. This is also the name of the IoT thing.
	CoreDeviceThingName *string

	// The time at which the core device's status last updated, expressed in ISO 8601
	// format.
	LastStatusUpdateTimestamp *time.Time

	// The status of the core device. Core devices can have the following statuses:
	//   - HEALTHY – The IoT Greengrass Core software and all components run on the
	//   core device without issue.
	//   - UNHEALTHY – The IoT Greengrass Core software or a component is in a failed
	//   state on the core device.
	Status CoreDeviceStatus
	// contains filtered or unexported fields
}

Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.

type CoreDeviceStatus

type CoreDeviceStatus string
const (
	CoreDeviceStatusHealthy   CoreDeviceStatus = "HEALTHY"
	CoreDeviceStatusUnhealthy CoreDeviceStatus = "UNHEALTHY"
)

Enum values for CoreDeviceStatus

func (CoreDeviceStatus) Values

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

type Deployment struct {

	// The time at which the deployment was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time

	// The ID of the deployment.
	DeploymentId *string

	// The name of the deployment.
	DeploymentName *string

	// The status of the deployment.
	DeploymentStatus DeploymentStatus

	// Whether or not the deployment is the latest revision for its target.
	IsLatestForTarget bool

	// The parent deployment's target ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// within a subdeployment.
	ParentTargetArn *string

	// The revision number of the deployment.
	RevisionId *string

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the target IoT thing or thing group. When creating a subdeployment, the
	// targetARN can only be a thing group.
	TargetArn *string
	// contains filtered or unexported fields
}

Contains information about a deployment.

type DeploymentComponentUpdatePolicy

type DeploymentComponentUpdatePolicy struct {

	// Whether or not to notify components and wait for components to become safe to
	// update. Choose from the following options:
	//   - NOTIFY_COMPONENTS – The deployment notifies each component before it stops
	//   and updates that component. Components can use the SubscribeToComponentUpdates (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates)
	//   IPC operation to receive these notifications. Then, components can respond with
	//   the DeferComponentUpdate (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate)
	//   IPC operation. For more information, see Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html)
	//   in the IoT Greengrass V2 Developer Guide.
	//   - SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait
	//   for them to be safe to update.
	// Default: NOTIFY_COMPONENTS
	Action DeploymentComponentUpdatePolicyAction

	// The amount of time in seconds that each component on a device has to report
	// that it's safe to update. If the component waits for longer than this timeout,
	// then the deployment proceeds on the device. Default: 60
	TimeoutInSeconds *int32
	// contains filtered or unexported fields
}

Contains information about a deployment's policy that defines when components are safe to update. Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.

type DeploymentComponentUpdatePolicyAction

type DeploymentComponentUpdatePolicyAction string
const (
	DeploymentComponentUpdatePolicyActionNotifyComponents     DeploymentComponentUpdatePolicyAction = "NOTIFY_COMPONENTS"
	DeploymentComponentUpdatePolicyActionSkipNotifyComponents DeploymentComponentUpdatePolicyAction = "SKIP_NOTIFY_COMPONENTS"
)

Enum values for DeploymentComponentUpdatePolicyAction

func (DeploymentComponentUpdatePolicyAction) Values

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

type DeploymentConfigurationValidationPolicy struct {

	// The amount of time in seconds that a component can validate its configuration
	// updates. If the validation time exceeds this timeout, then the deployment
	// proceeds for the device. Default: 30
	TimeoutInSeconds *int32
	// contains filtered or unexported fields
}

Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates) IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport (https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport) IPC operation. For more information, see Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the IoT Greengrass V2 Developer Guide.

type DeploymentFailureHandlingPolicy

type DeploymentFailureHandlingPolicy string
const (
	DeploymentFailureHandlingPolicyRollback  DeploymentFailureHandlingPolicy = "ROLLBACK"
	DeploymentFailureHandlingPolicyDoNothing DeploymentFailureHandlingPolicy = "DO_NOTHING"
)

Enum values for DeploymentFailureHandlingPolicy

func (DeploymentFailureHandlingPolicy) Values

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

type DeploymentHistoryFilter string
const (
	DeploymentHistoryFilterAll        DeploymentHistoryFilter = "ALL"
	DeploymentHistoryFilterLatestOnly DeploymentHistoryFilter = "LATEST_ONLY"
)

Enum values for DeploymentHistoryFilter

func (DeploymentHistoryFilter) Values

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

type DeploymentIoTJobConfiguration struct {

	// The stop configuration for the job. This configuration defines when and how to
	// stop a job rollout.
	AbortConfig *IoTJobAbortConfig

	// The rollout configuration for the job. This configuration defines the rate at
	// which the job rolls out to the fleet of target devices.
	JobExecutionsRolloutConfig *IoTJobExecutionsRolloutConfig

	// The timeout configuration for the job. This configuration defines the amount of
	// time each device has to complete the job.
	TimeoutConfig *IoTJobTimeoutConfig
	// contains filtered or unexported fields
}

Contains information about an IoT job configuration.

type DeploymentPolicies

type DeploymentPolicies struct {

	// The component update policy for the configuration deployment. This policy
	// defines when it's safe to deploy the configuration to devices.
	ComponentUpdatePolicy *DeploymentComponentUpdatePolicy

	// The configuration validation policy for the configuration deployment. This
	// policy defines how long each component has to validate its configure updates.
	ConfigurationValidationPolicy *DeploymentConfigurationValidationPolicy

	// The failure handling policy for the configuration deployment. This policy
	// defines what to do if the deployment fails. Default: ROLLBACK
	FailureHandlingPolicy DeploymentFailureHandlingPolicy
	// contains filtered or unexported fields
}

Contains information about policies that define how a deployment updates components and handles failure.

type DeploymentStatus

type DeploymentStatus string
const (
	DeploymentStatusActive    DeploymentStatus = "ACTIVE"
	DeploymentStatusCompleted DeploymentStatus = "COMPLETED"
	DeploymentStatusCanceled  DeploymentStatus = "CANCELED"
	DeploymentStatusFailed    DeploymentStatus = "FAILED"
	DeploymentStatusInactive  DeploymentStatus = "INACTIVE"
)

Enum values for DeploymentStatus

func (DeploymentStatus) Values

Values returns all known values for DeploymentStatus. 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 DisassociateClientDeviceFromCoreDeviceEntry added in v1.4.0

type DisassociateClientDeviceFromCoreDeviceEntry struct {

	// The name of the IoT thing that represents the client device to disassociate.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) operation consumes a list of these requests.

type DisassociateClientDeviceFromCoreDeviceErrorEntry added in v1.4.0

type DisassociateClientDeviceFromCoreDeviceErrorEntry struct {

	// The error code for the request.
	Code *string

	// A message that provides additional information about the error.
	Message *string

	// The name of the IoT thing whose disassociate request failed.
	ThingName *string
	// contains filtered or unexported fields
}

Contains an error that occurs from a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html) operation returns a list of these errors.

type EffectiveDeployment

type EffectiveDeployment struct {

	// The status of the deployment job on the Greengrass core device.
	//   - IN_PROGRESS – The deployment job is running.
	//   - QUEUED – The deployment job is in the job queue and waiting to run.
	//   - FAILED – The deployment failed. For more information, see the statusDetails
	//   field.
	//   - COMPLETED – The deployment to an IoT thing was completed successfully.
	//   - TIMED_OUT – The deployment didn't complete in the allotted time.
	//   - CANCELED – The deployment was canceled by the user.
	//   - REJECTED – The deployment was rejected. For more information, see the
	//   statusDetails field.
	//   - SUCCEEDED – The deployment to an IoT thing group was completed successfully.
	//
	// This member is required.
	CoreDeviceExecutionStatus EffectiveDeploymentExecutionStatus

	// The time at which the deployment was created, expressed in ISO 8601 format.
	//
	// This member is required.
	CreationTimestamp *time.Time

	// The ID of the deployment.
	//
	// This member is required.
	DeploymentId *string

	// The name of the deployment.
	//
	// This member is required.
	DeploymentName *string

	// The time at which the deployment job was last modified, expressed in ISO 8601
	// format.
	//
	// This member is required.
	ModifiedTimestamp *time.Time

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the target IoT thing or thing group.
	//
	// This member is required.
	TargetArn *string

	// The description of the deployment job.
	Description *string

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the IoT job that applies the deployment to target devices.
	IotJobArn *string

	// The ID of the IoT job that applies the deployment to target devices.
	IotJobId *string

	// The reason code for the update, if the job was updated.
	Reason *string

	// The status details that explain why a deployment has an error. This response
	// will be null if the deployment is in a success state.
	StatusDetails *EffectiveDeploymentStatusDetails
	// contains filtered or unexported fields
}

Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

type EffectiveDeploymentExecutionStatus

type EffectiveDeploymentExecutionStatus string
const (
	EffectiveDeploymentExecutionStatusInProgress EffectiveDeploymentExecutionStatus = "IN_PROGRESS"
	EffectiveDeploymentExecutionStatusQueued     EffectiveDeploymentExecutionStatus = "QUEUED"
	EffectiveDeploymentExecutionStatusFailed     EffectiveDeploymentExecutionStatus = "FAILED"
	EffectiveDeploymentExecutionStatusCompleted  EffectiveDeploymentExecutionStatus = "COMPLETED"
	EffectiveDeploymentExecutionStatusTimedOut   EffectiveDeploymentExecutionStatus = "TIMED_OUT"
	EffectiveDeploymentExecutionStatusCanceled   EffectiveDeploymentExecutionStatus = "CANCELED"
	EffectiveDeploymentExecutionStatusRejected   EffectiveDeploymentExecutionStatus = "REJECTED"
	EffectiveDeploymentExecutionStatusSucceeded  EffectiveDeploymentExecutionStatus = "SUCCEEDED"
)

Enum values for EffectiveDeploymentExecutionStatus

func (EffectiveDeploymentExecutionStatus) Values

Values returns all known values for EffectiveDeploymentExecutionStatus. 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 EffectiveDeploymentStatusDetails added in v1.19.0

type EffectiveDeploymentStatusDetails struct {

	// Contains an ordered list of short error codes that range from the most generic
	// error to the most specific one. The error codes describe the reason for failure
	// whenever the coreDeviceExecutionStatus is in a failed state. The response will
	// be an empty list if there is no error.
	ErrorStack []string

	// Contains tags which describe the error. You can use the error types to classify
	// errors to assist with remediating the failure. The response will be an empty
	// list if there is no error.
	ErrorTypes []string
	// contains filtered or unexported fields
}

Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state. Greengrass nucleus v2.8.0 or later is required to get an accurate errorStack and errorTypes response. This field will not be returned for earlier Greengrass nucleus versions.

type InstalledComponent

type InstalledComponent struct {

	// The name of the component.
	ComponentName *string

	// The version of the component.
	ComponentVersion *string

	// Whether or not the component is a root component.
	IsRoot bool

	// The most recent deployment source that brought the component to the Greengrass
	// core device. For a thing group deployment or thing deployment, the source will
	// be the The ID of the deployment. and for local deployments it will be LOCAL .
	// Any deployment will attempt to reinstall currently broken components on the
	// device, which will update the last installation source.
	LastInstallationSource *string

	// The last time the Greengrass core device sent a message containing a
	// component's state to the Amazon Web Services Cloud. A component does not need to
	// see a state change for this field to update.
	LastReportedTimestamp *time.Time

	// The status of how current the data is. This response is based off of component
	// state changes. The status reflects component disruptions and deployments. If a
	// component only sees a configuration update during a deployment, it might not
	// undergo a state change and this status would not be updated.
	LastStatusChangeTimestamp *time.Time

	// The lifecycle state of the component.
	LifecycleState InstalledComponentLifecycleState

	// A detailed response about the lifecycle state of the component that explains
	// the reason why a component has an error or is broken.
	LifecycleStateDetails *string

	// The status codes that indicate the reason for failure whenever the
	// lifecycleState has an error or is in a broken state. Greengrass nucleus v2.8.0
	// or later is required to get an accurate lifecycleStatusCodes response. This
	// response can be inaccurate in earlier Greengrass nucleus versions.
	LifecycleStatusCodes []string
	// contains filtered or unexported fields
}

Contains information about a component on a Greengrass core device.

type InstalledComponentLifecycleState

type InstalledComponentLifecycleState string
const (
	InstalledComponentLifecycleStateNew       InstalledComponentLifecycleState = "NEW"
	InstalledComponentLifecycleStateInstalled InstalledComponentLifecycleState = "INSTALLED"
	InstalledComponentLifecycleStateStarting  InstalledComponentLifecycleState = "STARTING"
	InstalledComponentLifecycleStateRunning   InstalledComponentLifecycleState = "RUNNING"
	InstalledComponentLifecycleStateStopping  InstalledComponentLifecycleState = "STOPPING"
	InstalledComponentLifecycleStateErrored   InstalledComponentLifecycleState = "ERRORED"
	InstalledComponentLifecycleStateBroken    InstalledComponentLifecycleState = "BROKEN"
	InstalledComponentLifecycleStateFinished  InstalledComponentLifecycleState = "FINISHED"
)

Enum values for InstalledComponentLifecycleState

func (InstalledComponentLifecycleState) Values

Values returns all known values for InstalledComponentLifecycleState. 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 InstalledComponentTopologyFilter added in v1.17.0

type InstalledComponentTopologyFilter string
const (
	InstalledComponentTopologyFilterAll  InstalledComponentTopologyFilter = "ALL"
	InstalledComponentTopologyFilterRoot InstalledComponentTopologyFilter = "ROOT"
)

Enum values for InstalledComponentTopologyFilter

func (InstalledComponentTopologyFilter) Values added in v1.17.0

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

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

IoT Greengrass can't process your request right now. Try again later.

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 IoTJobAbortAction

type IoTJobAbortAction string
const (
	IoTJobAbortActionCancel IoTJobAbortAction = "CANCEL"
)

Enum values for IoTJobAbortAction

func (IoTJobAbortAction) Values

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

type IoTJobAbortConfig struct {

	// The list of criteria that define when and how to cancel the configuration
	// deployment.
	//
	// This member is required.
	CriteriaList []IoTJobAbortCriteria
	// contains filtered or unexported fields
}

Contains a list of criteria that define when and how to cancel a configuration deployment.

type IoTJobAbortCriteria

type IoTJobAbortCriteria struct {

	// The action to perform when the criteria are met.
	//
	// This member is required.
	Action IoTJobAbortAction

	// The type of job deployment failure that can cancel a job.
	//
	// This member is required.
	FailureType IoTJobExecutionFailureType

	// The minimum number of things that receive the configuration before the job can
	// cancel.
	//
	// This member is required.
	MinNumberOfExecutedThings *int32

	// The minimum percentage of failureType failures that occur before the job can
	// cancel. This parameter supports up to two digits after the decimal (for example,
	// you can specify 10.9 or 10.99 , but not 10.999 ).
	//
	// This member is required.
	ThresholdPercentage float64
	// contains filtered or unexported fields
}

Contains criteria that define when and how to cancel a job. The deployment stops if the following conditions are true:

  • The number of things that receive the deployment exceeds the minNumberOfExecutedThings .
  • The percentage of failures with type failureType exceeds the thresholdPercentage .

type IoTJobExecutionFailureType

type IoTJobExecutionFailureType string
const (
	IoTJobExecutionFailureTypeFailed   IoTJobExecutionFailureType = "FAILED"
	IoTJobExecutionFailureTypeRejected IoTJobExecutionFailureType = "REJECTED"
	IoTJobExecutionFailureTypeTimedOut IoTJobExecutionFailureType = "TIMED_OUT"
	IoTJobExecutionFailureTypeAll      IoTJobExecutionFailureType = "ALL"
)

Enum values for IoTJobExecutionFailureType

func (IoTJobExecutionFailureType) Values

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

type IoTJobExecutionsRolloutConfig struct {

	// The exponential rate to increase the job rollout rate.
	ExponentialRate *IoTJobExponentialRolloutRate

	// The maximum number of devices that receive a pending job notification, per
	// minute.
	MaximumPerMinute *int32
	// contains filtered or unexported fields
}

Contains information about the rollout configuration for a job. This configuration defines the rate at which the job deploys a configuration to a fleet of target devices.

type IoTJobExponentialRolloutRate

type IoTJobExponentialRolloutRate struct {

	// The minimum number of devices that receive a pending job notification, per
	// minute, when the job starts. This parameter defines the initial rollout rate of
	// the job.
	//
	// This member is required.
	BaseRatePerMinute *int32

	// The exponential factor to increase the rollout rate for the job. This parameter
	// supports up to one digit after the decimal (for example, you can specify 1.5 ,
	// but not 1.55 ).
	//
	// This member is required.
	IncrementFactor *float64

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

Contains information about an exponential rollout rate for a configuration deployment job.

type IoTJobRateIncreaseCriteria

type IoTJobRateIncreaseCriteria struct {

	// The number of devices to receive the job notification before the rollout rate
	// increases.
	NumberOfNotifiedThings *int32

	// The number of devices to successfully run the configuration job before the
	// rollout rate increases.
	NumberOfSucceededThings *int32
	// contains filtered or unexported fields
}

Contains information about criteria to meet before a job increases its rollout rate. Specify either numberOfNotifiedThings or numberOfSucceededThings .

type IoTJobTimeoutConfig

type IoTJobTimeoutConfig struct {

	// The amount of time, in minutes, that devices have to complete the job. The
	// timer starts when the job status is set to IN_PROGRESS . If the job status
	// doesn't change to a terminal state before the time expires, then the job status
	// is set to TIMED_OUT . The timeout interval must be between 1 minute and 7 days
	// (10080 minutes).
	InProgressTimeoutInMinutes *int64
	// contains filtered or unexported fields
}

Contains information about the timeout configuration for a job.

type LambdaContainerParams

type LambdaContainerParams struct {

	// The list of system devices that the container can access.
	Devices []LambdaDeviceMount

	// The memory size of the container, expressed in kilobytes. Default: 16384 (16 MB)
	MemorySizeInKB *int32

	// Whether or not the container can read information from the device's /sys
	// folder. Default: false
	MountROSysfs *bool

	// The list of volumes that the container can access.
	Volumes []LambdaVolumeMount
	// contains filtered or unexported fields
}

Contains information about a container in which Lambda functions run on Greengrass core devices.

type LambdaDeviceMount

type LambdaDeviceMount struct {

	// The mount path for the device in the file system.
	//
	// This member is required.
	Path *string

	// Whether or not to add the component's system user as an owner of the device.
	// Default: false
	AddGroupOwner *bool

	// The permission to access the device: read/only ( ro ) or read/write ( rw ).
	// Default: ro
	Permission LambdaFilesystemPermission
	// contains filtered or unexported fields
}

Contains information about a device that Linux processes in a container can access.

type LambdaEventSource

type LambdaEventSource struct {

	// The topic to which to subscribe to receive event messages.
	//
	// This member is required.
	Topic *string

	// The type of event source. Choose from the following options:
	//   - PUB_SUB – Subscribe to local publish/subscribe messages. This event source
	//   type doesn't support MQTT wildcards ( + and # ) in the event source topic.
	//   - IOT_CORE – Subscribe to Amazon Web Services IoT Core MQTT messages. This
	//   event source type supports MQTT wildcards ( + and # ) in the event source
	//   topic.
	//
	// This member is required.
	Type LambdaEventSourceType
	// contains filtered or unexported fields
}

Contains information about an event source for an Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.

type LambdaEventSourceType

type LambdaEventSourceType string
const (
	LambdaEventSourceTypePubSub  LambdaEventSourceType = "PUB_SUB"
	LambdaEventSourceTypeIotCore LambdaEventSourceType = "IOT_CORE"
)

Enum values for LambdaEventSourceType

func (LambdaEventSourceType) Values

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

type LambdaExecutionParameters struct {

	// The map of environment variables that are available to the Lambda function when
	// it runs.
	EnvironmentVariables map[string]string

	// The list of event sources to which to subscribe to receive work messages. The
	// Lambda function runs when it receives a message from an event source. You can
	// subscribe this function to local publish/subscribe messages and Amazon Web
	// Services IoT Core MQTT messages.
	EventSources []LambdaEventSource

	// The list of arguments to pass to the Lambda function when it runs.
	ExecArgs []string

	// The encoding type that the Lambda function supports. Default: json
	InputPayloadEncodingType LambdaInputPayloadEncodingType

	// The parameters for the Linux process that contains the Lambda function.
	LinuxProcessParams *LambdaLinuxProcessParams

	// The maximum amount of time in seconds that a non-pinned Lambda function can
	// idle before the IoT Greengrass Core software stops its process.
	MaxIdleTimeInSeconds *int32

	// The maximum number of instances that a non-pinned Lambda function can run at
	// the same time.
	MaxInstancesCount *int32

	// The maximum size of the message queue for the Lambda function component. The
	// IoT Greengrass core stores messages in a FIFO (first-in-first-out) queue until
	// it can run the Lambda function to consume each message.
	MaxQueueSize *int32

	// Whether or not the Lambda function is pinned, or long-lived.
	//   - A pinned Lambda function starts when IoT Greengrass starts and keeps
	//   running in its own container.
	//   - A non-pinned Lambda function starts only when it receives a work item and
	//   exists after it idles for maxIdleTimeInSeconds . If the function has multiple
	//   work items, the IoT Greengrass Core software creates multiple instances of the
	//   function.
	// Default: true
	Pinned *bool

	// The interval in seconds at which a pinned (also known as long-lived) Lambda
	// function component sends status updates to the Lambda manager component.
	StatusTimeoutInSeconds *int32

	// The maximum amount of time in seconds that the Lambda function can process a
	// work item.
	TimeoutInSeconds *int32
	// contains filtered or unexported fields
}

Contains parameters for a Lambda function that runs on IoT Greengrass.

type LambdaFilesystemPermission

type LambdaFilesystemPermission string
const (
	LambdaFilesystemPermissionRo LambdaFilesystemPermission = "ro"
	LambdaFilesystemPermissionRw LambdaFilesystemPermission = "rw"
)

Enum values for LambdaFilesystemPermission

func (LambdaFilesystemPermission) Values

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

type LambdaFunctionRecipeSource struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Lambda function. The ARN must include the version of the function to
	// import. You can't use version aliases like $LATEST .
	//
	// This member is required.
	LambdaArn *string

	// The component versions on which this Lambda function component depends.
	ComponentDependencies map[string]ComponentDependencyRequirement

	// The system and runtime parameters for the Lambda function as it runs on the
	// Greengrass core device.
	ComponentLambdaParameters *LambdaExecutionParameters

	// The name of the component. Defaults to the name of the Lambda function.
	ComponentName *string

	// The platforms that the component version supports.
	ComponentPlatforms []ComponentPlatform

	// The version of the component. Defaults to the version of the Lambda function as
	// a semantic version. For example, if your function version is 3 , the component
	// version becomes 3.0.0 .
	ComponentVersion *string
	// contains filtered or unexported fields
}

Contains information about an Lambda function to import to create a component.

type LambdaInputPayloadEncodingType

type LambdaInputPayloadEncodingType string
const (
	LambdaInputPayloadEncodingTypeJson   LambdaInputPayloadEncodingType = "json"
	LambdaInputPayloadEncodingTypeBinary LambdaInputPayloadEncodingType = "binary"
)

Enum values for LambdaInputPayloadEncodingType

func (LambdaInputPayloadEncodingType) Values

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

type LambdaIsolationMode string
const (
	LambdaIsolationModeGreengrassContainer LambdaIsolationMode = "GreengrassContainer"
	LambdaIsolationModeNoContainer         LambdaIsolationMode = "NoContainer"
)

Enum values for LambdaIsolationMode

func (LambdaIsolationMode) Values

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

type LambdaLinuxProcessParams struct {

	// The parameters for the container in which the Lambda function runs.
	ContainerParams *LambdaContainerParams

	// The isolation mode for the process that contains the Lambda function. The
	// process can run in an isolated runtime environment inside the IoT Greengrass
	// container, or as a regular process outside any container. Default:
	// GreengrassContainer
	IsolationMode LambdaIsolationMode
	// contains filtered or unexported fields
}

Contains parameters for a Linux process that contains an Lambda function.

type LambdaVolumeMount

type LambdaVolumeMount struct {

	// The path to the logical volume in the file system.
	//
	// This member is required.
	DestinationPath *string

	// The path to the physical volume in the file system.
	//
	// This member is required.
	SourcePath *string

	// Whether or not to add the IoT Greengrass user group as an owner of the volume.
	// Default: false
	AddGroupOwner *bool

	// The permission to access the volume: read/only ( ro ) or read/write ( rw ).
	// Default: ro
	Permission LambdaFilesystemPermission
	// contains filtered or unexported fields
}

Contains information about a volume that Linux processes in a container can access. When you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the container.

type RecipeOutputFormat

type RecipeOutputFormat string
const (
	RecipeOutputFormatJson RecipeOutputFormat = "JSON"
	RecipeOutputFormatYaml RecipeOutputFormat = "YAML"
)

Enum values for RecipeOutputFormat

func (RecipeOutputFormat) Values

Values returns all known values for RecipeOutputFormat. 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 RequestAlreadyInProgressException added in v1.5.0

type RequestAlreadyInProgressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request is already in progress. This exception occurs when you use a client token for multiple requests while IoT Greengrass is still processing an earlier request that uses the same client token.

func (*RequestAlreadyInProgressException) Error added in v1.5.0

func (*RequestAlreadyInProgressException) ErrorCode added in v1.5.0

func (*RequestAlreadyInProgressException) ErrorFault added in v1.5.0

func (*RequestAlreadyInProgressException) ErrorMessage added in v1.5.0

func (e *RequestAlreadyInProgressException) ErrorMessage() string

type ResolvedComponentVersion

type ResolvedComponentVersion struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	Arn *string

	// The name of the component.
	ComponentName *string

	// The version of the component.
	ComponentVersion *string

	// A message that communicates details about the vendor guidance state of the
	// component version. This message communicates why a component version is
	// discontinued or deleted.
	Message *string

	// The recipe of the component version.
	Recipe []byte

	// The vendor guidance state for the component version. This state indicates
	// whether the component version has any issues that you should consider before you
	// deploy it. The vendor guidance state can be:
	//   - ACTIVE – This component version is available and recommended for use.
	//   - DISCONTINUED – This component version has been discontinued by its
	//   publisher. You can deploy this component version, but we recommend that you use
	//   a different version of this component.
	//   - DELETED – This component version has been deleted by its publisher, so you
	//   can't deploy it. If you have any existing deployments that specify this
	//   component version, those deployments will fail.
	VendorGuidance VendorGuidance
	// contains filtered or unexported fields
}

Contains information about a component version that is compatible to run on a Greengrass core device.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested resource can't be found.

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 ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	QuotaCode    *string
	ServiceCode  *string
	// contains filtered or unexported fields
}

Your request exceeds a service quota. For example, you might have the maximum number of components that you can create.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SystemResourceLimits added in v1.5.0

type SystemResourceLimits struct {

	// The maximum amount of CPU time that a component's processes can use on the core
	// device. A core device's total CPU time is equivalent to the device's number of
	// CPU cores. For example, on a core device with 4 CPU cores, you can set this
	// value to 2 to limit the component's processes to 50 percent usage of each CPU
	// core. On a device with 1 CPU core, you can set this value to 0.25 to limit the
	// component's processes to 25 percent usage of the CPU. If you set this value to a
	// number greater than the number of CPU cores, the IoT Greengrass Core software
	// doesn't limit the component's CPU usage.
	Cpus float64

	// The maximum amount of RAM, expressed in kilobytes, that a component's processes
	// can use on the core device.
	Memory int64
	// contains filtered or unexported fields
}

Contains information about system resource limits that the IoT Greengrass Core software applies to a component's processes. For more information, see Configure system resource limits for components (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits) .

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaCode         *string
	ServiceCode       *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

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 ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

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

type ValidationExceptionField

type ValidationExceptionField struct {

	// The message of the exception field.
	//
	// This member is required.
	Message *string

	// The name of the exception field.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a validation exception field.

type ValidationExceptionReason

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

Values returns all known values for ValidationExceptionReason. 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 VendorGuidance added in v1.16.0

type VendorGuidance string
const (
	VendorGuidanceActive       VendorGuidance = "ACTIVE"
	VendorGuidanceDiscontinued VendorGuidance = "DISCONTINUED"
	VendorGuidanceDeleted      VendorGuidance = "DELETED"
)

Enum values for VendorGuidance

func (VendorGuidance) Values added in v1.16.0

func (VendorGuidance) Values() []VendorGuidance

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

Jump to

Keyboard shortcuts

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