greengrassv2

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 13

Documentation

Overview

Package greengrassv2 provides the client and types for making API requests to AWS IoT Greengrass V2.

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.

For more information, see What is IoT Greengrass? (https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html) in the IoT Greengrass V2 Developer Guide.

See https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30 for more information on this service.

See greengrassv2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/greengrassv2/

Using the Client

To contact AWS IoT Greengrass V2 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Greengrass V2 client GreengrassV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/greengrassv2/#New

Index

Constants

View Source 
const (
	// CloudComponentStateRequested is a CloudComponentState enum value
	CloudComponentStateRequested = "REQUESTED"

	// CloudComponentStateInitiated is a CloudComponentState enum value
	CloudComponentStateInitiated = "INITIATED"

	// CloudComponentStateDeployable is a CloudComponentState enum value
	CloudComponentStateDeployable = "DEPLOYABLE"

	// CloudComponentStateFailed is a CloudComponentState enum value
	CloudComponentStateFailed = "FAILED"

	// CloudComponentStateDeprecated is a CloudComponentState enum value
	CloudComponentStateDeprecated = "DEPRECATED"
)
View Source 
const (
	// ComponentDependencyTypeHard is a ComponentDependencyType enum value
	ComponentDependencyTypeHard = "HARD"

	// ComponentDependencyTypeSoft is a ComponentDependencyType enum value
	ComponentDependencyTypeSoft = "SOFT"
)
View Source 
const (
	// ComponentVisibilityScopePrivate is a ComponentVisibilityScope enum value
	ComponentVisibilityScopePrivate = "PRIVATE"

	// ComponentVisibilityScopePublic is a ComponentVisibilityScope enum value
	ComponentVisibilityScopePublic = "PUBLIC"
)
View Source 
const (
	// CoreDeviceStatusHealthy is a CoreDeviceStatus enum value
	CoreDeviceStatusHealthy = "HEALTHY"

	// CoreDeviceStatusUnhealthy is a CoreDeviceStatus enum value
	CoreDeviceStatusUnhealthy = "UNHEALTHY"
)
View Source 
const (
	// DeploymentComponentUpdatePolicyActionNotifyComponents is a DeploymentComponentUpdatePolicyAction enum value
	DeploymentComponentUpdatePolicyActionNotifyComponents = "NOTIFY_COMPONENTS"

	// DeploymentComponentUpdatePolicyActionSkipNotifyComponents is a DeploymentComponentUpdatePolicyAction enum value
	DeploymentComponentUpdatePolicyActionSkipNotifyComponents = "SKIP_NOTIFY_COMPONENTS"
)
View Source 
const (
	// DeploymentFailureHandlingPolicyRollback is a DeploymentFailureHandlingPolicy enum value
	DeploymentFailureHandlingPolicyRollback = "ROLLBACK"

	// DeploymentFailureHandlingPolicyDoNothing is a DeploymentFailureHandlingPolicy enum value
	DeploymentFailureHandlingPolicyDoNothing = "DO_NOTHING"
)
View Source 
const (
	// DeploymentHistoryFilterAll is a DeploymentHistoryFilter enum value
	DeploymentHistoryFilterAll = "ALL"

	// DeploymentHistoryFilterLatestOnly is a DeploymentHistoryFilter enum value
	DeploymentHistoryFilterLatestOnly = "LATEST_ONLY"
)
View Source 
const (
	// DeploymentStatusActive is a DeploymentStatus enum value
	DeploymentStatusActive = "ACTIVE"

	// DeploymentStatusCompleted is a DeploymentStatus enum value
	DeploymentStatusCompleted = "COMPLETED"

	// DeploymentStatusCanceled is a DeploymentStatus enum value
	DeploymentStatusCanceled = "CANCELED"

	// DeploymentStatusFailed is a DeploymentStatus enum value
	DeploymentStatusFailed = "FAILED"

	// DeploymentStatusInactive is a DeploymentStatus enum value
	DeploymentStatusInactive = "INACTIVE"
)
View Source 
const (
	// EffectiveDeploymentExecutionStatusInProgress is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusInProgress = "IN_PROGRESS"

	// EffectiveDeploymentExecutionStatusQueued is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusQueued = "QUEUED"

	// EffectiveDeploymentExecutionStatusFailed is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusFailed = "FAILED"

	// EffectiveDeploymentExecutionStatusCompleted is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusCompleted = "COMPLETED"

	// EffectiveDeploymentExecutionStatusTimedOut is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusTimedOut = "TIMED_OUT"

	// EffectiveDeploymentExecutionStatusCanceled is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusCanceled = "CANCELED"

	// EffectiveDeploymentExecutionStatusRejected is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusRejected = "REJECTED"

	// EffectiveDeploymentExecutionStatusSucceeded is a EffectiveDeploymentExecutionStatus enum value
	EffectiveDeploymentExecutionStatusSucceeded = "SUCCEEDED"
)
View Source 
const (
	// InstalledComponentLifecycleStateNew is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateNew = "NEW"

	// InstalledComponentLifecycleStateInstalled is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateInstalled = "INSTALLED"

	// InstalledComponentLifecycleStateStarting is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateStarting = "STARTING"

	// InstalledComponentLifecycleStateRunning is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateRunning = "RUNNING"

	// InstalledComponentLifecycleStateStopping is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateStopping = "STOPPING"

	// InstalledComponentLifecycleStateErrored is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateErrored = "ERRORED"

	// InstalledComponentLifecycleStateBroken is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateBroken = "BROKEN"

	// InstalledComponentLifecycleStateFinished is a InstalledComponentLifecycleState enum value
	InstalledComponentLifecycleStateFinished = "FINISHED"
)
View Source 
const (
	// InstalledComponentTopologyFilterAll is a InstalledComponentTopologyFilter enum value
	InstalledComponentTopologyFilterAll = "ALL"

	// InstalledComponentTopologyFilterRoot is a InstalledComponentTopologyFilter enum value
	InstalledComponentTopologyFilterRoot = "ROOT"
)
View Source 
const (
	// IoTJobExecutionFailureTypeFailed is a IoTJobExecutionFailureType enum value
	IoTJobExecutionFailureTypeFailed = "FAILED"

	// IoTJobExecutionFailureTypeRejected is a IoTJobExecutionFailureType enum value
	IoTJobExecutionFailureTypeRejected = "REJECTED"

	// IoTJobExecutionFailureTypeTimedOut is a IoTJobExecutionFailureType enum value
	IoTJobExecutionFailureTypeTimedOut = "TIMED_OUT"

	// IoTJobExecutionFailureTypeAll is a IoTJobExecutionFailureType enum value
	IoTJobExecutionFailureTypeAll = "ALL"
)
View Source 
const (
	// IotEndpointTypeFips is a IotEndpointType enum value
	IotEndpointTypeFips = "fips"

	// IotEndpointTypeStandard is a IotEndpointType enum value
	IotEndpointTypeStandard = "standard"
)
View Source 
const (
	// LambdaEventSourceTypePubSub is a LambdaEventSourceType enum value
	LambdaEventSourceTypePubSub = "PUB_SUB"

	// LambdaEventSourceTypeIotCore is a LambdaEventSourceType enum value
	LambdaEventSourceTypeIotCore = "IOT_CORE"
)
View Source 
const (
	// LambdaFilesystemPermissionRo is a LambdaFilesystemPermission enum value
	LambdaFilesystemPermissionRo = "ro"

	// LambdaFilesystemPermissionRw is a LambdaFilesystemPermission enum value
	LambdaFilesystemPermissionRw = "rw"
)
View Source 
const (
	// LambdaInputPayloadEncodingTypeJson is a LambdaInputPayloadEncodingType enum value
	LambdaInputPayloadEncodingTypeJson = "json"

	// LambdaInputPayloadEncodingTypeBinary is a LambdaInputPayloadEncodingType enum value
	LambdaInputPayloadEncodingTypeBinary = "binary"
)
View Source 
const (
	// LambdaIsolationModeGreengrassContainer is a LambdaIsolationMode enum value
	LambdaIsolationModeGreengrassContainer = "GreengrassContainer"

	// LambdaIsolationModeNoContainer is a LambdaIsolationMode enum value
	LambdaIsolationModeNoContainer = "NoContainer"
)
View Source 
const (
	// RecipeOutputFormatJson is a RecipeOutputFormat enum value
	RecipeOutputFormatJson = "JSON"

	// RecipeOutputFormatYaml is a RecipeOutputFormat enum value
	RecipeOutputFormatYaml = "YAML"
)
View Source 
const (
	// S3EndpointTypeRegional is a S3EndpointType enum value
	S3EndpointTypeRegional = "REGIONAL"

	// S3EndpointTypeGlobal is a S3EndpointType enum value
	S3EndpointTypeGlobal = "GLOBAL"
)
View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
View Source 
const (
	// VendorGuidanceActive is a VendorGuidance enum value
	VendorGuidanceActive = "ACTIVE"

	// VendorGuidanceDiscontinued is a VendorGuidance enum value
	VendorGuidanceDiscontinued = "DISCONTINUED"

	// VendorGuidanceDeleted is a VendorGuidance enum value
	VendorGuidanceDeleted = "DELETED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have permission to perform the action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// 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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// IoT Greengrass can't process your request right now. Try again later.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeRequestAlreadyInProgressException for service response error code
	// "RequestAlreadyInProgressException".
	//
	// 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.
	ErrCodeRequestAlreadyInProgressException = "RequestAlreadyInProgressException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Your request exceeds a service quota. For example, you might have the maximum
	// number of components that you can create.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// 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.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request isn't valid. This can occur if your request contains malformed
	// JSON or unsupported characters.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "GreengrassV2" // Name of service.
	EndpointsID = "greengrass"   // ID to lookup a service endpoint with.
	ServiceID   = "GreengrassV2" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// IoTJobAbortActionCancel is a IoTJobAbortAction enum value
	IoTJobAbortActionCancel = "CANCEL"
)

Variables

This section is empty.

Functions

func CloudComponentState_Values 

func CloudComponentState_Values() []string

CloudComponentState_Values returns all elements of the CloudComponentState enum

func ComponentDependencyType_Values 

func ComponentDependencyType_Values() []string

ComponentDependencyType_Values returns all elements of the ComponentDependencyType enum

func ComponentVisibilityScope_Values 

func ComponentVisibilityScope_Values() []string

ComponentVisibilityScope_Values returns all elements of the ComponentVisibilityScope enum

func CoreDeviceStatus_Values 

func CoreDeviceStatus_Values() []string

CoreDeviceStatus_Values returns all elements of the CoreDeviceStatus enum

func DeploymentComponentUpdatePolicyAction_Values 

func DeploymentComponentUpdatePolicyAction_Values() []string

DeploymentComponentUpdatePolicyAction_Values returns all elements of the DeploymentComponentUpdatePolicyAction enum

func DeploymentFailureHandlingPolicy_Values 

func DeploymentFailureHandlingPolicy_Values() []string

DeploymentFailureHandlingPolicy_Values returns all elements of the DeploymentFailureHandlingPolicy enum

func DeploymentHistoryFilter_Values 

func DeploymentHistoryFilter_Values() []string

DeploymentHistoryFilter_Values returns all elements of the DeploymentHistoryFilter enum

func DeploymentStatus_Values 

func DeploymentStatus_Values() []string

DeploymentStatus_Values returns all elements of the DeploymentStatus enum

func EffectiveDeploymentExecutionStatus_Values 

func EffectiveDeploymentExecutionStatus_Values() []string

EffectiveDeploymentExecutionStatus_Values returns all elements of the EffectiveDeploymentExecutionStatus enum

func InstalledComponentLifecycleState_Values 

func InstalledComponentLifecycleState_Values() []string

InstalledComponentLifecycleState_Values returns all elements of the InstalledComponentLifecycleState enum

func InstalledComponentTopologyFilter_Values added in v1.44.88 

func InstalledComponentTopologyFilter_Values() []string

InstalledComponentTopologyFilter_Values returns all elements of the InstalledComponentTopologyFilter enum

func IoTJobAbortAction_Values 

func IoTJobAbortAction_Values() []string

IoTJobAbortAction_Values returns all elements of the IoTJobAbortAction enum

func IoTJobExecutionFailureType_Values 

func IoTJobExecutionFailureType_Values() []string

IoTJobExecutionFailureType_Values returns all elements of the IoTJobExecutionFailureType enum

func IotEndpointType_Values added in v1.53.0 

func IotEndpointType_Values() []string

IotEndpointType_Values returns all elements of the IotEndpointType enum

func LambdaEventSourceType_Values 

func LambdaEventSourceType_Values() []string

LambdaEventSourceType_Values returns all elements of the LambdaEventSourceType enum

func LambdaFilesystemPermission_Values 

func LambdaFilesystemPermission_Values() []string

LambdaFilesystemPermission_Values returns all elements of the LambdaFilesystemPermission enum

func LambdaInputPayloadEncodingType_Values 

func LambdaInputPayloadEncodingType_Values() []string

LambdaInputPayloadEncodingType_Values returns all elements of the LambdaInputPayloadEncodingType enum

func LambdaIsolationMode_Values 

func LambdaIsolationMode_Values() []string

LambdaIsolationMode_Values returns all elements of the LambdaIsolationMode enum

func RecipeOutputFormat_Values 

func RecipeOutputFormat_Values() []string

RecipeOutputFormat_Values returns all elements of the RecipeOutputFormat enum

func S3EndpointType_Values added in v1.53.0 

func S3EndpointType_Values() []string

S3EndpointType_Values returns all elements of the S3EndpointType enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func VendorGuidance_Values added in v1.44.17 

func VendorGuidance_Values() []string

VendorGuidance_Values returns all elements of the VendorGuidance enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You don't have permission to perform the action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateClientDeviceWithCoreDeviceEntry added in v1.38.61 

type AssociateClientDeviceWithCoreDeviceEntry struct {

	// The name of the IoT thing that represents the client device to associate.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// 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.

func (AssociateClientDeviceWithCoreDeviceEntry) GoString added in v1.38.61 

func (s AssociateClientDeviceWithCoreDeviceEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateClientDeviceWithCoreDeviceEntry) SetThingName added in v1.38.61 

func (s *AssociateClientDeviceWithCoreDeviceEntry) SetThingName(v string) *AssociateClientDeviceWithCoreDeviceEntry

SetThingName sets the ThingName field's value.

func (AssociateClientDeviceWithCoreDeviceEntry) String added in v1.38.61 

func (s AssociateClientDeviceWithCoreDeviceEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateClientDeviceWithCoreDeviceEntry) Validate added in v1.38.61 

func (s *AssociateClientDeviceWithCoreDeviceEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateClientDeviceWithCoreDeviceErrorEntry added in v1.38.61 

type AssociateClientDeviceWithCoreDeviceErrorEntry struct {

	// The error code for the request.
	Code *string `locationName:"code" min:"1" type:"string"`

	// A message that provides additional information about the error.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The name of the IoT thing whose associate request failed.
	ThingName *string `locationName:"thingName" min:"1" type:"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.

func (AssociateClientDeviceWithCoreDeviceErrorEntry) GoString added in v1.38.61 

func (s AssociateClientDeviceWithCoreDeviceErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateClientDeviceWithCoreDeviceErrorEntry) SetCode added in v1.38.61 

func (s *AssociateClientDeviceWithCoreDeviceErrorEntry) SetCode(v string) *AssociateClientDeviceWithCoreDeviceErrorEntry

SetCode sets the Code field's value.

func (*AssociateClientDeviceWithCoreDeviceErrorEntry) SetMessage added in v1.38.61 

func (s *AssociateClientDeviceWithCoreDeviceErrorEntry) SetMessage(v string) *AssociateClientDeviceWithCoreDeviceErrorEntry

SetMessage sets the Message field's value.

func (*AssociateClientDeviceWithCoreDeviceErrorEntry) SetThingName added in v1.38.61 

func (s *AssociateClientDeviceWithCoreDeviceErrorEntry) SetThingName(v string) *AssociateClientDeviceWithCoreDeviceErrorEntry

SetThingName sets the ThingName field's value.

func (AssociateClientDeviceWithCoreDeviceErrorEntry) String added in v1.38.61 

func (s AssociateClientDeviceWithCoreDeviceErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateServiceRoleToAccountInput added in v1.42.26 

type AssociateServiceRoleToAccountInput struct {

	// The Amazon Resource Name (ARN) of the service role to associate with IoT
	// Greengrass for your Amazon Web Services account in this Amazon Web Services
	// Region.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"RoleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateServiceRoleToAccountInput) GoString added in v1.42.26 

func (s AssociateServiceRoleToAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateServiceRoleToAccountInput) SetRoleArn added in v1.42.26 

func (s *AssociateServiceRoleToAccountInput) SetRoleArn(v string) *AssociateServiceRoleToAccountInput

SetRoleArn sets the RoleArn field's value.

func (AssociateServiceRoleToAccountInput) String added in v1.42.26 

func (s AssociateServiceRoleToAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateServiceRoleToAccountInput) Validate added in v1.42.26 

func (s *AssociateServiceRoleToAccountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateServiceRoleToAccountOutput added in v1.42.26 

type AssociateServiceRoleToAccountOutput struct {

	// The time when the service role was associated with IoT Greengrass for your
	// Amazon Web Services account in this Amazon Web Services Region.
	AssociatedAt *string `locationName:"AssociatedAt" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateServiceRoleToAccountOutput) GoString added in v1.42.26 

func (s AssociateServiceRoleToAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateServiceRoleToAccountOutput) SetAssociatedAt added in v1.42.26 

func (s *AssociateServiceRoleToAccountOutput) SetAssociatedAt(v string) *AssociateServiceRoleToAccountOutput

SetAssociatedAt sets the AssociatedAt field's value.

func (AssociateServiceRoleToAccountOutput) String added in v1.42.26 

func (s AssociateServiceRoleToAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatedClientDevice added in v1.38.61 

type AssociatedClientDevice struct {

	// The time that the client device was associated, expressed in ISO 8601 format.
	AssociationTimestamp *time.Time `locationName:"associationTimestamp" type:"timestamp"`

	// The name of the IoT thing that represents the associated client device.
	ThingName *string `locationName:"thingName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (AssociatedClientDevice) GoString added in v1.38.61 

func (s AssociatedClientDevice) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatedClientDevice) SetAssociationTimestamp added in v1.38.61 

func (s *AssociatedClientDevice) SetAssociationTimestamp(v time.Time) *AssociatedClientDevice

SetAssociationTimestamp sets the AssociationTimestamp field's value.

func (*AssociatedClientDevice) SetThingName added in v1.38.61 

func (s *AssociatedClientDevice) SetThingName(v string) *AssociatedClientDevice

SetThingName sets the ThingName field's value.

func (AssociatedClientDevice) String added in v1.38.61 

func (s AssociatedClientDevice) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchAssociateClientDeviceWithCoreDeviceInput added in v1.38.61 

type BatchAssociateClientDeviceWithCoreDeviceInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`

	// The list of client devices to associate.
	Entries []*AssociateClientDeviceWithCoreDeviceEntry `locationName:"entries" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (BatchAssociateClientDeviceWithCoreDeviceInput) GoString added in v1.38.61 

func (s BatchAssociateClientDeviceWithCoreDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateClientDeviceWithCoreDeviceInput) SetCoreDeviceThingName added in v1.38.61 

func (s *BatchAssociateClientDeviceWithCoreDeviceInput) SetCoreDeviceThingName(v string) *BatchAssociateClientDeviceWithCoreDeviceInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*BatchAssociateClientDeviceWithCoreDeviceInput) SetEntries added in v1.38.61 

func (s *BatchAssociateClientDeviceWithCoreDeviceInput) SetEntries(v []*AssociateClientDeviceWithCoreDeviceEntry) *BatchAssociateClientDeviceWithCoreDeviceInput

SetEntries sets the Entries field's value.

func (BatchAssociateClientDeviceWithCoreDeviceInput) String added in v1.38.61 

func (s BatchAssociateClientDeviceWithCoreDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateClientDeviceWithCoreDeviceInput) Validate added in v1.38.61 

func (s *BatchAssociateClientDeviceWithCoreDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAssociateClientDeviceWithCoreDeviceOutput added in v1.38.61 

type BatchAssociateClientDeviceWithCoreDeviceOutput struct {

	// The list of any errors for the entries in the request. Each error entry contains
	// the name of the IoT thing that failed to associate.
	ErrorEntries []*AssociateClientDeviceWithCoreDeviceErrorEntry `locationName:"errorEntries" type:"list"`
	// contains filtered or unexported fields
}

func (BatchAssociateClientDeviceWithCoreDeviceOutput) GoString added in v1.38.61 

func (s BatchAssociateClientDeviceWithCoreDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateClientDeviceWithCoreDeviceOutput) SetErrorEntries added in v1.38.61 

func (s *BatchAssociateClientDeviceWithCoreDeviceOutput) SetErrorEntries(v []*AssociateClientDeviceWithCoreDeviceErrorEntry) *BatchAssociateClientDeviceWithCoreDeviceOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchAssociateClientDeviceWithCoreDeviceOutput) String added in v1.38.61 

func (s BatchAssociateClientDeviceWithCoreDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDisassociateClientDeviceFromCoreDeviceInput added in v1.38.61 

type BatchDisassociateClientDeviceFromCoreDeviceInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`

	// The list of client devices to disassociate.
	Entries []*DisassociateClientDeviceFromCoreDeviceEntry `locationName:"entries" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (BatchDisassociateClientDeviceFromCoreDeviceInput) GoString added in v1.38.61 

func (s BatchDisassociateClientDeviceFromCoreDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateClientDeviceFromCoreDeviceInput) SetCoreDeviceThingName added in v1.38.61 

func (s *BatchDisassociateClientDeviceFromCoreDeviceInput) SetCoreDeviceThingName(v string) *BatchDisassociateClientDeviceFromCoreDeviceInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*BatchDisassociateClientDeviceFromCoreDeviceInput) SetEntries added in v1.38.61 

func (s *BatchDisassociateClientDeviceFromCoreDeviceInput) SetEntries(v []*DisassociateClientDeviceFromCoreDeviceEntry) *BatchDisassociateClientDeviceFromCoreDeviceInput

SetEntries sets the Entries field's value.

func (BatchDisassociateClientDeviceFromCoreDeviceInput) String added in v1.38.61 

func (s BatchDisassociateClientDeviceFromCoreDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateClientDeviceFromCoreDeviceInput) Validate added in v1.38.61 

func (s *BatchDisassociateClientDeviceFromCoreDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDisassociateClientDeviceFromCoreDeviceOutput added in v1.38.61 

type BatchDisassociateClientDeviceFromCoreDeviceOutput struct {

	// The list of any errors for the entries in the request. Each error entry contains
	// the name of the IoT thing that failed to disassociate.
	ErrorEntries []*DisassociateClientDeviceFromCoreDeviceErrorEntry `locationName:"errorEntries" type:"list"`
	// contains filtered or unexported fields
}

func (BatchDisassociateClientDeviceFromCoreDeviceOutput) GoString added in v1.38.61 

func (s BatchDisassociateClientDeviceFromCoreDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateClientDeviceFromCoreDeviceOutput) SetErrorEntries added in v1.38.61 

func (s *BatchDisassociateClientDeviceFromCoreDeviceOutput) SetErrorEntries(v []*DisassociateClientDeviceFromCoreDeviceErrorEntry) *BatchDisassociateClientDeviceFromCoreDeviceOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchDisassociateClientDeviceFromCoreDeviceOutput) String added in v1.38.61 

func (s BatchDisassociateClientDeviceFromCoreDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelDeploymentInput 

type CancelDeploymentInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deploymentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelDeploymentInput) GoString 

func (s CancelDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDeploymentInput) SetDeploymentId 

func (s *CancelDeploymentInput) SetDeploymentId(v string) *CancelDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (CancelDeploymentInput) String 

func (s CancelDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDeploymentInput) Validate 

func (s *CancelDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelDeploymentOutput 

type CancelDeploymentOutput struct {

	// A message that communicates if the cancel was successful.
	Message *string `locationName:"message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CancelDeploymentOutput) GoString 

func (s CancelDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDeploymentOutput) SetMessage 

func (s *CancelDeploymentOutput) SetMessage(v string) *CancelDeploymentOutput

SetMessage sets the Message field's value.

func (CancelDeploymentOutput) String 

func (s CancelDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudComponentStatus 

type CloudComponentStatus struct {

	// The state of the component version.
	ComponentState *string `locationName:"componentState" type:"string" enum:"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 `locationName:"errors" type:"map"`

	// A message that communicates details, such as errors, about the status of
	// the component version.
	Message *string `locationName:"message" min:"1" type:"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 *string `locationName:"vendorGuidance" type:"string" enum:"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 `locationName:"vendorGuidanceMessage" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (CloudComponentStatus) GoString 

func (s CloudComponentStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudComponentStatus) SetComponentState 

func (s *CloudComponentStatus) SetComponentState(v string) *CloudComponentStatus

SetComponentState sets the ComponentState field's value.

func (*CloudComponentStatus) SetErrors 

func (s *CloudComponentStatus) SetErrors(v map[string]*string) *CloudComponentStatus

SetErrors sets the Errors field's value.

func (*CloudComponentStatus) SetMessage 

func (s *CloudComponentStatus) SetMessage(v string) *CloudComponentStatus

SetMessage sets the Message field's value.

func (*CloudComponentStatus) SetVendorGuidance added in v1.44.17 

func (s *CloudComponentStatus) SetVendorGuidance(v string) *CloudComponentStatus

SetVendorGuidance sets the VendorGuidance field's value.

func (*CloudComponentStatus) SetVendorGuidanceMessage added in v1.44.17 

func (s *CloudComponentStatus) SetVendorGuidanceMessage(v string) *CloudComponentStatus

SetVendorGuidanceMessage sets the VendorGuidanceMessage field's value.

func (CloudComponentStatus) String 

func (s CloudComponentStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"arn" type:"string"`

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The latest version of the component and its details.
	LatestVersion *ComponentLatestVersion `locationName:"latestVersion" type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a component.

func (Component) GoString 

func (s Component) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Component) SetArn 

func (s *Component) SetArn(v string) *Component

SetArn sets the Arn field's value.

func (*Component) SetComponentName 

func (s *Component) SetComponentName(v string) *Component

SetComponentName sets the ComponentName field's value.

func (*Component) SetLatestVersion 

func (s *Component) SetLatestVersion(v *ComponentLatestVersion) *Component

SetLatestVersion sets the LatestVersion field's value.

func (Component) String 

func (s Component) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComponentCandidate 

type ComponentCandidate struct {

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"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 `locationName:"versionRequirements" type:"map"`
	// contains filtered or unexported fields
}

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

func (ComponentCandidate) GoString 

func (s ComponentCandidate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentCandidate) SetComponentName 

func (s *ComponentCandidate) SetComponentName(v string) *ComponentCandidate

SetComponentName sets the ComponentName field's value.

func (*ComponentCandidate) SetComponentVersion 

func (s *ComponentCandidate) SetComponentVersion(v string) *ComponentCandidate

SetComponentVersion sets the ComponentVersion field's value.

func (*ComponentCandidate) SetVersionRequirements 

func (s *ComponentCandidate) SetVersionRequirements(v map[string]*string) *ComponentCandidate

SetVersionRequirements sets the VersionRequirements field's value.

func (ComponentCandidate) String 

func (s ComponentCandidate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentCandidate) Validate 

func (s *ComponentCandidate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"merge" min:"1" type:"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 `locationName:"reset" type:"list"`
	// 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.

func (ComponentConfigurationUpdate) GoString 

func (s ComponentConfigurationUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentConfigurationUpdate) SetMerge 

func (s *ComponentConfigurationUpdate) SetMerge(v string) *ComponentConfigurationUpdate

SetMerge sets the Merge field's value.

func (*ComponentConfigurationUpdate) SetReset 

func (s *ComponentConfigurationUpdate) SetReset(v []*string) *ComponentConfigurationUpdate

SetReset sets the Reset field's value.

func (ComponentConfigurationUpdate) String 

func (s ComponentConfigurationUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentConfigurationUpdate) Validate 

func (s *ComponentConfigurationUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 *string `locationName:"dependencyType" type:"string" enum:"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 `locationName:"versionRequirement" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ComponentDependencyRequirement) GoString 

func (s ComponentDependencyRequirement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDependencyRequirement) SetDependencyType 

func (s *ComponentDependencyRequirement) SetDependencyType(v string) *ComponentDependencyRequirement

SetDependencyType sets the DependencyType field's value.

func (*ComponentDependencyRequirement) SetVersionRequirement 

func (s *ComponentDependencyRequirement) SetVersionRequirement(v string) *ComponentDependencyRequirement

SetVersionRequirement sets the VersionRequirement field's value.

func (ComponentDependencyRequirement) String 

func (s ComponentDependencyRequirement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDependencyRequirement) Validate 

func (s *ComponentDependencyRequirement) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComponentDeploymentSpecification 

type ComponentDeploymentSpecification struct {

	// The version of the component.
	//
	// ComponentVersion is a required field
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string" required:"true"`

	// 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 `locationName:"configurationUpdate" type:"structure"`

	// 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 `locationName:"runWith" type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a component to deploy.

func (ComponentDeploymentSpecification) GoString 

func (s ComponentDeploymentSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDeploymentSpecification) SetComponentVersion 

func (s *ComponentDeploymentSpecification) SetComponentVersion(v string) *ComponentDeploymentSpecification

SetComponentVersion sets the ComponentVersion field's value.

func (*ComponentDeploymentSpecification) SetConfigurationUpdate 

func (s *ComponentDeploymentSpecification) SetConfigurationUpdate(v *ComponentConfigurationUpdate) *ComponentDeploymentSpecification

SetConfigurationUpdate sets the ConfigurationUpdate field's value.

func (*ComponentDeploymentSpecification) SetRunWith 

func (s *ComponentDeploymentSpecification) SetRunWith(v *ComponentRunWith) *ComponentDeploymentSpecification

SetRunWith sets the RunWith field's value.

func (ComponentDeploymentSpecification) String 

func (s ComponentDeploymentSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentDeploymentSpecification) Validate 

func (s *ComponentDeploymentSpecification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"arn" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string"`

	// The time at which the component was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// The description of the component version.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The platforms that the component version supports.
	Platforms []*ComponentPlatform `locationName:"platforms" type:"list"`

	// The publisher of the component version.
	Publisher *string `locationName:"publisher" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the latest version of a component.

func (ComponentLatestVersion) GoString 

func (s ComponentLatestVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentLatestVersion) SetArn 

func (s *ComponentLatestVersion) SetArn(v string) *ComponentLatestVersion

SetArn sets the Arn field's value.

func (*ComponentLatestVersion) SetComponentVersion 

func (s *ComponentLatestVersion) SetComponentVersion(v string) *ComponentLatestVersion

SetComponentVersion sets the ComponentVersion field's value.

func (*ComponentLatestVersion) SetCreationTimestamp 

func (s *ComponentLatestVersion) SetCreationTimestamp(v time.Time) *ComponentLatestVersion

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*ComponentLatestVersion) SetDescription 

func (s *ComponentLatestVersion) SetDescription(v string) *ComponentLatestVersion

SetDescription sets the Description field's value.

func (*ComponentLatestVersion) SetPlatforms 

func (s *ComponentLatestVersion) SetPlatforms(v []*ComponentPlatform) *ComponentLatestVersion

SetPlatforms sets the Platforms field's value.

func (*ComponentLatestVersion) SetPublisher 

func (s *ComponentLatestVersion) SetPublisher(v string) *ComponentLatestVersion

SetPublisher sets the Publisher field's value.

func (ComponentLatestVersion) String 

func (s ComponentLatestVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"attributes" type:"map"`

	// 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 `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a platform that a component supports.

func (ComponentPlatform) GoString 

func (s ComponentPlatform) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPlatform) SetAttributes 

func (s *ComponentPlatform) SetAttributes(v map[string]*string) *ComponentPlatform

SetAttributes sets the Attributes field's value.

func (*ComponentPlatform) SetName 

func (s *ComponentPlatform) SetName(v string) *ComponentPlatform

SetName sets the Name field's value.

func (ComponentPlatform) String 

func (s ComponentPlatform) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentPlatform) Validate 

func (s *ComponentPlatform) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"posixUser" min:"1" type:"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 `locationName:"systemResourceLimits" type:"structure"`

	// 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 `locationName:"windowsUser" min:"1" type:"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.

func (ComponentRunWith) GoString 

func (s ComponentRunWith) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentRunWith) SetPosixUser 

func (s *ComponentRunWith) SetPosixUser(v string) *ComponentRunWith

SetPosixUser sets the PosixUser field's value.

func (*ComponentRunWith) SetSystemResourceLimits added in v1.40.13 

func (s *ComponentRunWith) SetSystemResourceLimits(v *SystemResourceLimits) *ComponentRunWith

SetSystemResourceLimits sets the SystemResourceLimits field's value.

func (*ComponentRunWith) SetWindowsUser added in v1.42.1 

func (s *ComponentRunWith) SetWindowsUser(v string) *ComponentRunWith

SetWindowsUser sets the WindowsUser field's value.

func (ComponentRunWith) String 

func (s ComponentRunWith) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentRunWith) Validate 

func (s *ComponentRunWith) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"arn" min:"1" type:"string"`

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a component version in a list.

func (ComponentVersionListItem) GoString 

func (s ComponentVersionListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComponentVersionListItem) SetArn 

func (s *ComponentVersionListItem) SetArn(v string) *ComponentVersionListItem

SetArn sets the Arn field's value.

func (*ComponentVersionListItem) SetComponentName 

func (s *ComponentVersionListItem) SetComponentName(v string) *ComponentVersionListItem

SetComponentName sets the ComponentName field's value.

func (*ComponentVersionListItem) SetComponentVersion 

func (s *ComponentVersionListItem) SetComponentVersion(v string) *ComponentVersionListItem

SetComponentVersion sets the ComponentVersion field's value.

func (ComponentVersionListItem) String 

func (s ComponentVersionListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that conflicts with the request.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that conflicts with the request.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// 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) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectivityInfo added in v1.42.26 

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 `locationName:"HostAddress" type:"string"`

	// An ID for the connectivity information.
	Id *string `locationName:"Id" type:"string"`

	// Additional metadata to provide to client devices that connect to this core
	// device.
	Metadata *string `locationName:"Metadata" type:"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 *int64 `locationName:"PortNumber" type:"integer"`
	// 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.

func (ConnectivityInfo) GoString added in v1.42.26 

func (s ConnectivityInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectivityInfo) SetHostAddress added in v1.42.26 

func (s *ConnectivityInfo) SetHostAddress(v string) *ConnectivityInfo

SetHostAddress sets the HostAddress field's value.

func (*ConnectivityInfo) SetId added in v1.42.26 

func (s *ConnectivityInfo) SetId(v string) *ConnectivityInfo

SetId sets the Id field's value.

func (*ConnectivityInfo) SetMetadata added in v1.42.26 

func (s *ConnectivityInfo) SetMetadata(v string) *ConnectivityInfo

SetMetadata sets the Metadata field's value.

func (*ConnectivityInfo) SetPortNumber added in v1.42.26 

func (s *ConnectivityInfo) SetPortNumber(v int64) *ConnectivityInfo

SetPortNumber sets the PortNumber field's value.

func (ConnectivityInfo) String added in v1.42.26 

func (s ConnectivityInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CoreDevice 

type CoreDevice struct {

	// The name of the core device. This is also the name of the IoT thing.
	CoreDeviceThingName *string `locationName:"coreDeviceThingName" min:"1" type:"string"`

	// The time at which the core device's status last updated, expressed in ISO
	// 8601 format.
	LastStatusUpdateTimestamp *time.Time `locationName:"lastStatusUpdateTimestamp" type:"timestamp"`

	// 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 *string `locationName:"status" type:"string" enum:"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.

func (CoreDevice) GoString 

func (s CoreDevice) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CoreDevice) SetCoreDeviceThingName 

func (s *CoreDevice) SetCoreDeviceThingName(v string) *CoreDevice

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*CoreDevice) SetLastStatusUpdateTimestamp 

func (s *CoreDevice) SetLastStatusUpdateTimestamp(v time.Time) *CoreDevice

SetLastStatusUpdateTimestamp sets the LastStatusUpdateTimestamp field's value.

func (*CoreDevice) SetStatus 

func (s *CoreDevice) SetStatus(v string) *CoreDevice

SetStatus sets the Status field's value.

func (CoreDevice) String 

func (s CoreDevice) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateComponentVersionInput 

type CreateComponentVersionInput struct {

	// A unique, case-sensitive identifier that you can provide to ensure that the
	// request is idempotent. Idempotency means that the request is successfully
	// processed only once, even if you send the request multiple times. When a
	// request succeeds, and you specify the same client token for subsequent successful
	// requests, the IoT Greengrass V2 service returns the successful response that
	// it caches from the previous request. IoT Greengrass V2 caches successful
	// responses for idempotent requests for up to 8 hours.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The recipe to use to create the component. The recipe defines the component's
	// metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.
	//
	// You must specify either inlineRecipe or lambdaFunction.
	// InlineRecipe is automatically base64 encoded/decoded by the SDK.
	InlineRecipe []byte `locationName:"inlineRecipe" type:"blob"`

	// The parameters to create a component from a Lambda function.
	//
	// You must specify either inlineRecipe or lambdaFunction.
	LambdaFunction *LambdaFunctionRecipeSource `locationName:"lambdaFunction" type:"structure"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateComponentVersionInput) GoString 

func (s CreateComponentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentVersionInput) SetClientToken added in v1.40.13 

func (s *CreateComponentVersionInput) SetClientToken(v string) *CreateComponentVersionInput

SetClientToken sets the ClientToken field's value.

func (*CreateComponentVersionInput) SetInlineRecipe 

func (s *CreateComponentVersionInput) SetInlineRecipe(v []byte) *CreateComponentVersionInput

SetInlineRecipe sets the InlineRecipe field's value.

func (*CreateComponentVersionInput) SetLambdaFunction 

func (s *CreateComponentVersionInput) SetLambdaFunction(v *LambdaFunctionRecipeSource) *CreateComponentVersionInput

SetLambdaFunction sets the LambdaFunction field's value.

func (*CreateComponentVersionInput) SetTags 

func (s *CreateComponentVersionInput) SetTags(v map[string]*string) *CreateComponentVersionInput

SetTags sets the Tags field's value.

func (CreateComponentVersionInput) String 

func (s CreateComponentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentVersionInput) Validate 

func (s *CreateComponentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateComponentVersionOutput 

type CreateComponentVersionOutput struct {

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

	// The name of the component.
	//
	// ComponentName is a required field
	ComponentName *string `locationName:"componentName" min:"1" type:"string" required:"true"`

	// The version of the component.
	//
	// ComponentVersion is a required field
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string" required:"true"`

	// The time at which the component was created, expressed in ISO 8601 format.
	//
	// CreationTimestamp is a required field
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp" required:"true"`

	// The status of the component version in IoT Greengrass V2. This status is
	// different from the status of the component on a core device.
	//
	// Status is a required field
	Status *CloudComponentStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateComponentVersionOutput) GoString 

func (s CreateComponentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateComponentVersionOutput) SetArn 

func (s *CreateComponentVersionOutput) SetArn(v string) *CreateComponentVersionOutput

SetArn sets the Arn field's value.

func (*CreateComponentVersionOutput) SetComponentName 

func (s *CreateComponentVersionOutput) SetComponentName(v string) *CreateComponentVersionOutput

SetComponentName sets the ComponentName field's value.

func (*CreateComponentVersionOutput) SetComponentVersion 

func (s *CreateComponentVersionOutput) SetComponentVersion(v string) *CreateComponentVersionOutput

SetComponentVersion sets the ComponentVersion field's value.

func (*CreateComponentVersionOutput) SetCreationTimestamp 

func (s *CreateComponentVersionOutput) SetCreationTimestamp(v time.Time) *CreateComponentVersionOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*CreateComponentVersionOutput) SetStatus 

func (s *CreateComponentVersionOutput) SetStatus(v *CloudComponentStatus) *CreateComponentVersionOutput

SetStatus sets the Status field's value.

func (CreateComponentVersionOutput) String 

func (s CreateComponentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDeploymentInput 

type CreateDeploymentInput struct {

	// A unique, case-sensitive identifier that you can provide to ensure that the
	// request is idempotent. Idempotency means that the request is successfully
	// processed only once, even if you send the request multiple times. When a
	// request succeeds, and you specify the same client token for subsequent successful
	// requests, the IoT Greengrass V2 service returns the successful response that
	// it caches from the previous request. IoT Greengrass V2 caches successful
	// responses for idempotent requests for up to 8 hours.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The components to deploy. This is a dictionary, where each key is the name
	// of a component, and each key's value is the version and configuration to
	// deploy for that component.
	Components map[string]*ComponentDeploymentSpecification `locationName:"components" type:"map"`

	// The name of the deployment.
	DeploymentName *string `locationName:"deploymentName" min:"1" type:"string"`

	// The deployment policies for the deployment. These policies define how the
	// deployment updates components and handles failure.
	DeploymentPolicies *DeploymentPolicies `locationName:"deploymentPolicies" type:"structure"`

	// The job configuration for the deployment configuration. The job configuration
	// specifies the rollout, timeout, and stop configurations for the deployment
	// configuration.
	IotJobConfiguration *DeploymentIoTJobConfiguration `locationName:"iotJobConfiguration" type:"structure"`

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

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// 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 is a required field
	TargetArn *string `locationName:"targetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDeploymentInput) GoString 

func (s CreateDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) SetClientToken added in v1.40.13 

func (s *CreateDeploymentInput) SetClientToken(v string) *CreateDeploymentInput

SetClientToken sets the ClientToken field's value.

func (*CreateDeploymentInput) SetComponents 

func (s *CreateDeploymentInput) SetComponents(v map[string]*ComponentDeploymentSpecification) *CreateDeploymentInput

SetComponents sets the Components field's value.

func (*CreateDeploymentInput) SetDeploymentName 

func (s *CreateDeploymentInput) SetDeploymentName(v string) *CreateDeploymentInput

SetDeploymentName sets the DeploymentName field's value.

func (*CreateDeploymentInput) SetDeploymentPolicies 

func (s *CreateDeploymentInput) SetDeploymentPolicies(v *DeploymentPolicies) *CreateDeploymentInput

SetDeploymentPolicies sets the DeploymentPolicies field's value.

func (*CreateDeploymentInput) SetIotJobConfiguration 

func (s *CreateDeploymentInput) SetIotJobConfiguration(v *DeploymentIoTJobConfiguration) *CreateDeploymentInput

SetIotJobConfiguration sets the IotJobConfiguration field's value.

func (*CreateDeploymentInput) SetParentTargetArn added in v1.44.138 

func (s *CreateDeploymentInput) SetParentTargetArn(v string) *CreateDeploymentInput

SetParentTargetArn sets the ParentTargetArn field's value.

func (*CreateDeploymentInput) SetTags 

func (s *CreateDeploymentInput) SetTags(v map[string]*string) *CreateDeploymentInput

SetTags sets the Tags field's value.

func (*CreateDeploymentInput) SetTargetArn 

func (s *CreateDeploymentInput) SetTargetArn(v string) *CreateDeploymentInput

SetTargetArn sets the TargetArn field's value.

func (CreateDeploymentInput) String 

func (s CreateDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentInput) Validate 

func (s *CreateDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDeploymentOutput 

type CreateDeploymentOutput struct {

	// The ID of the deployment.
	DeploymentId *string `locationName:"deploymentId" min:"1" type:"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 `locationName:"iotJobArn" type:"string"`

	// The ID of the IoT job that applies the deployment to target devices.
	IotJobId *string `locationName:"iotJobId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDeploymentOutput) GoString 

func (s CreateDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeploymentOutput) SetDeploymentId 

func (s *CreateDeploymentOutput) SetDeploymentId(v string) *CreateDeploymentOutput

SetDeploymentId sets the DeploymentId field's value.

func (*CreateDeploymentOutput) SetIotJobArn 

func (s *CreateDeploymentOutput) SetIotJobArn(v string) *CreateDeploymentOutput

SetIotJobArn sets the IotJobArn field's value.

func (*CreateDeploymentOutput) SetIotJobId 

func (s *CreateDeploymentOutput) SetIotJobId(v string) *CreateDeploymentOutput

SetIotJobId sets the IotJobId field's value.

func (CreateDeploymentOutput) String 

func (s CreateDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteComponentInput 

type DeleteComponentInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteComponentInput) GoString 

func (s DeleteComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentInput) SetArn 

func (s *DeleteComponentInput) SetArn(v string) *DeleteComponentInput

SetArn sets the Arn field's value.

func (DeleteComponentInput) String 

func (s DeleteComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteComponentInput) Validate 

func (s *DeleteComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteComponentOutput 

type DeleteComponentOutput struct {
	// contains filtered or unexported fields
}

func (DeleteComponentOutput) GoString 

func (s DeleteComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteComponentOutput) String 

func (s DeleteComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCoreDeviceInput 

type DeleteCoreDeviceInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCoreDeviceInput) GoString 

func (s DeleteCoreDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCoreDeviceInput) SetCoreDeviceThingName 

func (s *DeleteCoreDeviceInput) SetCoreDeviceThingName(v string) *DeleteCoreDeviceInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (DeleteCoreDeviceInput) String 

func (s DeleteCoreDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCoreDeviceInput) Validate 

func (s *DeleteCoreDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCoreDeviceOutput 

type DeleteCoreDeviceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCoreDeviceOutput) GoString 

func (s DeleteCoreDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteCoreDeviceOutput) String 

func (s DeleteCoreDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeploymentInput added in v1.44.17 

type DeleteDeploymentInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deploymentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeploymentInput) GoString added in v1.44.17 

func (s DeleteDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeploymentInput) SetDeploymentId added in v1.44.17 

func (s *DeleteDeploymentInput) SetDeploymentId(v string) *DeleteDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (DeleteDeploymentInput) String added in v1.44.17 

func (s DeleteDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeploymentInput) Validate added in v1.44.17 

func (s *DeleteDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeploymentOutput added in v1.44.17 

type DeleteDeploymentOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeploymentOutput) GoString added in v1.44.17 

func (s DeleteDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDeploymentOutput) String added in v1.44.17 

func (s DeleteDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Deployment 

type Deployment struct {

	// The time at which the deployment was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// The ID of the deployment.
	DeploymentId *string `locationName:"deploymentId" min:"1" type:"string"`

	// The name of the deployment.
	DeploymentName *string `locationName:"deploymentName" min:"1" type:"string"`

	// The status of the deployment.
	DeploymentStatus *string `locationName:"deploymentStatus" type:"string" enum:"DeploymentStatus"`

	// Whether or not the deployment is the latest revision for its target.
	IsLatestForTarget *bool `locationName:"isLatestForTarget" type:"boolean"`

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

	// The revision number of the deployment.
	RevisionId *string `locationName:"revisionId" min:"1" type:"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 `locationName:"targetArn" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a deployment.

func (Deployment) GoString 

func (s Deployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Deployment) SetCreationTimestamp 

func (s *Deployment) SetCreationTimestamp(v time.Time) *Deployment

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*Deployment) SetDeploymentId 

func (s *Deployment) SetDeploymentId(v string) *Deployment

SetDeploymentId sets the DeploymentId field's value.

func (*Deployment) SetDeploymentName 

func (s *Deployment) SetDeploymentName(v string) *Deployment

SetDeploymentName sets the DeploymentName field's value.

func (*Deployment) SetDeploymentStatus 

func (s *Deployment) SetDeploymentStatus(v string) *Deployment

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*Deployment) SetIsLatestForTarget 

func (s *Deployment) SetIsLatestForTarget(v bool) *Deployment

SetIsLatestForTarget sets the IsLatestForTarget field's value.

func (*Deployment) SetParentTargetArn added in v1.44.138 

func (s *Deployment) SetParentTargetArn(v string) *Deployment

SetParentTargetArn sets the ParentTargetArn field's value.

func (*Deployment) SetRevisionId 

func (s *Deployment) SetRevisionId(v string) *Deployment

SetRevisionId sets the RevisionId field's value.

func (*Deployment) SetTargetArn 

func (s *Deployment) SetTargetArn(v string) *Deployment

SetTargetArn sets the TargetArn field's value.

func (Deployment) String 

func (s Deployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"action" type:"string" enum:"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 *int64 `locationName:"timeoutInSeconds" type:"integer"`
	// 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.

func (DeploymentComponentUpdatePolicy) GoString 

func (s DeploymentComponentUpdatePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentComponentUpdatePolicy) SetAction 

func (s *DeploymentComponentUpdatePolicy) SetAction(v string) *DeploymentComponentUpdatePolicy

SetAction sets the Action field's value.

func (*DeploymentComponentUpdatePolicy) SetTimeoutInSeconds 

func (s *DeploymentComponentUpdatePolicy) SetTimeoutInSeconds(v int64) *DeploymentComponentUpdatePolicy

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (DeploymentComponentUpdatePolicy) String 

func (s DeploymentComponentUpdatePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `locationName:"timeoutInSeconds" type:"integer"`
	// 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.

func (DeploymentConfigurationValidationPolicy) GoString 

func (s DeploymentConfigurationValidationPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentConfigurationValidationPolicy) SetTimeoutInSeconds 

func (s *DeploymentConfigurationValidationPolicy) SetTimeoutInSeconds(v int64) *DeploymentConfigurationValidationPolicy

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (DeploymentConfigurationValidationPolicy) String 

func (s DeploymentConfigurationValidationPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentIoTJobConfiguration 

type DeploymentIoTJobConfiguration struct {

	// The stop configuration for the job. This configuration defines when and how
	// to stop a job rollout.
	AbortConfig *IoTJobAbortConfig `locationName:"abortConfig" type:"structure"`

	// 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 `locationName:"jobExecutionsRolloutConfig" type:"structure"`

	// The timeout configuration for the job. This configuration defines the amount
	// of time each device has to complete the job.
	TimeoutConfig *IoTJobTimeoutConfig `locationName:"timeoutConfig" type:"structure"`
	// contains filtered or unexported fields
}

Contains information about an IoT job configuration.

func (DeploymentIoTJobConfiguration) GoString 

func (s DeploymentIoTJobConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentIoTJobConfiguration) SetAbortConfig 

func (s *DeploymentIoTJobConfiguration) SetAbortConfig(v *IoTJobAbortConfig) *DeploymentIoTJobConfiguration

SetAbortConfig sets the AbortConfig field's value.

func (*DeploymentIoTJobConfiguration) SetJobExecutionsRolloutConfig 

func (s *DeploymentIoTJobConfiguration) SetJobExecutionsRolloutConfig(v *IoTJobExecutionsRolloutConfig) *DeploymentIoTJobConfiguration

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

func (*DeploymentIoTJobConfiguration) SetTimeoutConfig 

func (s *DeploymentIoTJobConfiguration) SetTimeoutConfig(v *IoTJobTimeoutConfig) *DeploymentIoTJobConfiguration

SetTimeoutConfig sets the TimeoutConfig field's value.

func (DeploymentIoTJobConfiguration) String 

func (s DeploymentIoTJobConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentIoTJobConfiguration) Validate 

func (s *DeploymentIoTJobConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"componentUpdatePolicy" type:"structure"`

	// The configuration validation policy for the configuration deployment. This
	// policy defines how long each component has to validate its configure updates.
	ConfigurationValidationPolicy *DeploymentConfigurationValidationPolicy `locationName:"configurationValidationPolicy" type:"structure"`

	// The failure handling policy for the configuration deployment. This policy
	// defines what to do if the deployment fails.
	//
	// Default: ROLLBACK
	FailureHandlingPolicy *string `locationName:"failureHandlingPolicy" type:"string" enum:"DeploymentFailureHandlingPolicy"`
	// contains filtered or unexported fields
}

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

func (DeploymentPolicies) GoString 

func (s DeploymentPolicies) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentPolicies) SetComponentUpdatePolicy 

func (s *DeploymentPolicies) SetComponentUpdatePolicy(v *DeploymentComponentUpdatePolicy) *DeploymentPolicies

SetComponentUpdatePolicy sets the ComponentUpdatePolicy field's value.

func (*DeploymentPolicies) SetConfigurationValidationPolicy 

func (s *DeploymentPolicies) SetConfigurationValidationPolicy(v *DeploymentConfigurationValidationPolicy) *DeploymentPolicies

SetConfigurationValidationPolicy sets the ConfigurationValidationPolicy field's value.

func (*DeploymentPolicies) SetFailureHandlingPolicy 

func (s *DeploymentPolicies) SetFailureHandlingPolicy(v string) *DeploymentPolicies

SetFailureHandlingPolicy sets the FailureHandlingPolicy field's value.

func (DeploymentPolicies) String 

func (s DeploymentPolicies) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeComponentInput 

type DescribeComponentInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeComponentInput) GoString 

func (s DescribeComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComponentInput) SetArn 

func (s *DescribeComponentInput) SetArn(v string) *DescribeComponentInput

SetArn sets the Arn field's value.

func (DescribeComponentInput) String 

func (s DescribeComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComponentInput) Validate 

func (s *DescribeComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeComponentOutput 

type DescribeComponentOutput struct {

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

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string"`

	// The time at which the component was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// The description of the component version.
	Description *string `locationName:"description" type:"string"`

	// The platforms that the component version supports.
	Platforms []*ComponentPlatform `locationName:"platforms" type:"list"`

	// The publisher of the component version.
	Publisher *string `locationName:"publisher" type:"string"`

	// The status of the component version in IoT Greengrass V2. This status is
	// different from the status of the component on a core device.
	Status *CloudComponentStatus `locationName:"status" type:"structure"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (DescribeComponentOutput) GoString 

func (s DescribeComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeComponentOutput) SetArn 

func (s *DescribeComponentOutput) SetArn(v string) *DescribeComponentOutput

SetArn sets the Arn field's value.

func (*DescribeComponentOutput) SetComponentName 

func (s *DescribeComponentOutput) SetComponentName(v string) *DescribeComponentOutput

SetComponentName sets the ComponentName field's value.

func (*DescribeComponentOutput) SetComponentVersion 

func (s *DescribeComponentOutput) SetComponentVersion(v string) *DescribeComponentOutput

SetComponentVersion sets the ComponentVersion field's value.

func (*DescribeComponentOutput) SetCreationTimestamp 

func (s *DescribeComponentOutput) SetCreationTimestamp(v time.Time) *DescribeComponentOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeComponentOutput) SetDescription 

func (s *DescribeComponentOutput) SetDescription(v string) *DescribeComponentOutput

SetDescription sets the Description field's value.

func (*DescribeComponentOutput) SetPlatforms 

func (s *DescribeComponentOutput) SetPlatforms(v []*ComponentPlatform) *DescribeComponentOutput

SetPlatforms sets the Platforms field's value.

func (*DescribeComponentOutput) SetPublisher 

func (s *DescribeComponentOutput) SetPublisher(v string) *DescribeComponentOutput

SetPublisher sets the Publisher field's value.

func (*DescribeComponentOutput) SetStatus 

func (s *DescribeComponentOutput) SetStatus(v *CloudComponentStatus) *DescribeComponentOutput

SetStatus sets the Status field's value.

func (*DescribeComponentOutput) SetTags 

func (s *DescribeComponentOutput) SetTags(v map[string]*string) *DescribeComponentOutput

SetTags sets the Tags field's value.

func (DescribeComponentOutput) String 

func (s DescribeComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateClientDeviceFromCoreDeviceEntry added in v1.38.61 

type DisassociateClientDeviceFromCoreDeviceEntry struct {

	// The name of the IoT thing that represents the client device to disassociate.
	//
	// ThingName is a required field
	ThingName *string `locationName:"thingName" min:"1" type:"string" required:"true"`
	// 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.

func (DisassociateClientDeviceFromCoreDeviceEntry) GoString added in v1.38.61 

func (s DisassociateClientDeviceFromCoreDeviceEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateClientDeviceFromCoreDeviceEntry) SetThingName added in v1.38.61 

func (s *DisassociateClientDeviceFromCoreDeviceEntry) SetThingName(v string) *DisassociateClientDeviceFromCoreDeviceEntry

SetThingName sets the ThingName field's value.

func (DisassociateClientDeviceFromCoreDeviceEntry) String added in v1.38.61 

func (s DisassociateClientDeviceFromCoreDeviceEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateClientDeviceFromCoreDeviceEntry) Validate added in v1.38.61 

func (s *DisassociateClientDeviceFromCoreDeviceEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateClientDeviceFromCoreDeviceErrorEntry added in v1.38.61 

type DisassociateClientDeviceFromCoreDeviceErrorEntry struct {

	// The error code for the request.
	Code *string `locationName:"code" min:"1" type:"string"`

	// A message that provides additional information about the error.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The name of the IoT thing whose disassociate request failed.
	ThingName *string `locationName:"thingName" min:"1" type:"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.

func (DisassociateClientDeviceFromCoreDeviceErrorEntry) GoString added in v1.38.61 

func (s DisassociateClientDeviceFromCoreDeviceErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateClientDeviceFromCoreDeviceErrorEntry) SetCode added in v1.38.61 

func (s *DisassociateClientDeviceFromCoreDeviceErrorEntry) SetCode(v string) *DisassociateClientDeviceFromCoreDeviceErrorEntry

SetCode sets the Code field's value.

func (*DisassociateClientDeviceFromCoreDeviceErrorEntry) SetMessage added in v1.38.61 

func (s *DisassociateClientDeviceFromCoreDeviceErrorEntry) SetMessage(v string) *DisassociateClientDeviceFromCoreDeviceErrorEntry

SetMessage sets the Message field's value.

func (*DisassociateClientDeviceFromCoreDeviceErrorEntry) SetThingName added in v1.38.61 

func (s *DisassociateClientDeviceFromCoreDeviceErrorEntry) SetThingName(v string) *DisassociateClientDeviceFromCoreDeviceErrorEntry

SetThingName sets the ThingName field's value.

func (DisassociateClientDeviceFromCoreDeviceErrorEntry) String added in v1.38.61 

func (s DisassociateClientDeviceFromCoreDeviceErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateServiceRoleFromAccountInput added in v1.42.26 

type DisassociateServiceRoleFromAccountInput struct {
	// contains filtered or unexported fields
}

func (DisassociateServiceRoleFromAccountInput) GoString added in v1.42.26 

func (s DisassociateServiceRoleFromAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateServiceRoleFromAccountInput) String added in v1.42.26 

func (s DisassociateServiceRoleFromAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateServiceRoleFromAccountOutput added in v1.42.26 

type DisassociateServiceRoleFromAccountOutput struct {

	// The time when the service role was disassociated from IoT Greengrass for
	// your Amazon Web Services account in this Amazon Web Services Region.
	DisassociatedAt *string `locationName:"DisassociatedAt" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateServiceRoleFromAccountOutput) GoString added in v1.42.26 

func (s DisassociateServiceRoleFromAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateServiceRoleFromAccountOutput) SetDisassociatedAt added in v1.42.26 

func (s *DisassociateServiceRoleFromAccountOutput) SetDisassociatedAt(v string) *DisassociateServiceRoleFromAccountOutput

SetDisassociatedAt sets the DisassociatedAt field's value.

func (DisassociateServiceRoleFromAccountOutput) String added in v1.42.26 

func (s DisassociateServiceRoleFromAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// CoreDeviceExecutionStatus is a required field
	CoreDeviceExecutionStatus *string `locationName:"coreDeviceExecutionStatus" type:"string" required:"true" enum:"EffectiveDeploymentExecutionStatus"`

	// The time at which the deployment was created, expressed in ISO 8601 format.
	//
	// CreationTimestamp is a required field
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp" required:"true"`

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `locationName:"deploymentId" type:"string" required:"true"`

	// The name of the deployment.
	//
	// DeploymentName is a required field
	DeploymentName *string `locationName:"deploymentName" type:"string" required:"true"`

	// The description of the deployment job.
	Description *string `locationName:"description" min:"1" type:"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 `locationName:"iotJobArn" type:"string"`

	// The ID of the IoT job that applies the deployment to target devices.
	IotJobId *string `locationName:"iotJobId" min:"1" type:"string"`

	// The time at which the deployment job was last modified, expressed in ISO
	// 8601 format.
	//
	// ModifiedTimestamp is a required field
	ModifiedTimestamp *time.Time `locationName:"modifiedTimestamp" type:"timestamp" required:"true"`

	// The reason code for the update, if the job was updated.
	Reason *string `locationName:"reason" type:"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 `locationName:"statusDetails" type:"structure"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the target IoT thing or thing group.
	//
	// TargetArn is a required field
	TargetArn *string `locationName:"targetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (EffectiveDeployment) GoString 

func (s EffectiveDeployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EffectiveDeployment) SetCoreDeviceExecutionStatus 

func (s *EffectiveDeployment) SetCoreDeviceExecutionStatus(v string) *EffectiveDeployment

SetCoreDeviceExecutionStatus sets the CoreDeviceExecutionStatus field's value.

func (*EffectiveDeployment) SetCreationTimestamp 

func (s *EffectiveDeployment) SetCreationTimestamp(v time.Time) *EffectiveDeployment

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*EffectiveDeployment) SetDeploymentId 

func (s *EffectiveDeployment) SetDeploymentId(v string) *EffectiveDeployment

SetDeploymentId sets the DeploymentId field's value.

func (*EffectiveDeployment) SetDeploymentName 

func (s *EffectiveDeployment) SetDeploymentName(v string) *EffectiveDeployment

SetDeploymentName sets the DeploymentName field's value.

func (*EffectiveDeployment) SetDescription 

func (s *EffectiveDeployment) SetDescription(v string) *EffectiveDeployment

SetDescription sets the Description field's value.

func (*EffectiveDeployment) SetIotJobArn 

func (s *EffectiveDeployment) SetIotJobArn(v string) *EffectiveDeployment

SetIotJobArn sets the IotJobArn field's value.

func (*EffectiveDeployment) SetIotJobId 

func (s *EffectiveDeployment) SetIotJobId(v string) *EffectiveDeployment

SetIotJobId sets the IotJobId field's value.

func (*EffectiveDeployment) SetModifiedTimestamp 

func (s *EffectiveDeployment) SetModifiedTimestamp(v time.Time) *EffectiveDeployment

SetModifiedTimestamp sets the ModifiedTimestamp field's value.

func (*EffectiveDeployment) SetReason 

func (s *EffectiveDeployment) SetReason(v string) *EffectiveDeployment

SetReason sets the Reason field's value.

func (*EffectiveDeployment) SetStatusDetails added in v1.44.114 

func (s *EffectiveDeployment) SetStatusDetails(v *EffectiveDeploymentStatusDetails) *EffectiveDeployment

SetStatusDetails sets the StatusDetails field's value.

func (*EffectiveDeployment) SetTargetArn 

func (s *EffectiveDeployment) SetTargetArn(v string) *EffectiveDeployment

SetTargetArn sets the TargetArn field's value.

func (EffectiveDeployment) String 

func (s EffectiveDeployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EffectiveDeploymentStatusDetails added in v1.44.114 

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 `locationName:"errorStack" type:"list"`

	// 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 `locationName:"errorTypes" type:"list"`
	// 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.

func (EffectiveDeploymentStatusDetails) GoString added in v1.44.114 

func (s EffectiveDeploymentStatusDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EffectiveDeploymentStatusDetails) SetErrorStack added in v1.44.114 

func (s *EffectiveDeploymentStatusDetails) SetErrorStack(v []*string) *EffectiveDeploymentStatusDetails

SetErrorStack sets the ErrorStack field's value.

func (*EffectiveDeploymentStatusDetails) SetErrorTypes added in v1.44.114 

func (s *EffectiveDeploymentStatusDetails) SetErrorTypes(v []*string) *EffectiveDeploymentStatusDetails

SetErrorTypes sets the ErrorTypes field's value.

func (EffectiveDeploymentStatusDetails) String added in v1.44.114 

func (s EffectiveDeploymentStatusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetComponentInput 

type GetComponentInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`

	// The format of the recipe.
	RecipeOutputFormat *string `location:"querystring" locationName:"recipeOutputFormat" type:"string" enum:"RecipeOutputFormat"`
	// contains filtered or unexported fields
}

func (GetComponentInput) GoString 

func (s GetComponentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentInput) SetArn 

func (s *GetComponentInput) SetArn(v string) *GetComponentInput

SetArn sets the Arn field's value.

func (*GetComponentInput) SetRecipeOutputFormat 

func (s *GetComponentInput) SetRecipeOutputFormat(v string) *GetComponentInput

SetRecipeOutputFormat sets the RecipeOutputFormat field's value.

func (GetComponentInput) String 

func (s GetComponentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentInput) Validate 

func (s *GetComponentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComponentOutput 

type GetComponentOutput struct {

	// The recipe of the component version.
	// Recipe is automatically base64 encoded/decoded by the SDK.
	//
	// Recipe is a required field
	Recipe []byte `locationName:"recipe" type:"blob" required:"true"`

	// The format of the recipe.
	//
	// RecipeOutputFormat is a required field
	RecipeOutputFormat *string `locationName:"recipeOutputFormat" type:"string" required:"true" enum:"RecipeOutputFormat"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (GetComponentOutput) GoString 

func (s GetComponentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentOutput) SetRecipe 

func (s *GetComponentOutput) SetRecipe(v []byte) *GetComponentOutput

SetRecipe sets the Recipe field's value.

func (*GetComponentOutput) SetRecipeOutputFormat 

func (s *GetComponentOutput) SetRecipeOutputFormat(v string) *GetComponentOutput

SetRecipeOutputFormat sets the RecipeOutputFormat field's value.

func (*GetComponentOutput) SetTags 

func (s *GetComponentOutput) SetTags(v map[string]*string) *GetComponentOutput

SetTags sets the Tags field's value.

func (GetComponentOutput) String 

func (s GetComponentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetComponentVersionArtifactInput 

type GetComponentVersionArtifactInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component version. Specify the ARN of a public or a Lambda component
	// version.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`

	// The name of the artifact.
	//
	// You can use the GetComponent (https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html)
	// operation to download the component recipe, which includes the URI of the
	// artifact. The artifact name is the section of the URI after the scheme. For
	// example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name
	// is SomeArtifact.zip.
	//
	// ArtifactName is a required field
	ArtifactName *string `location:"uri" locationName:"artifactName" min:"1" type:"string" required:"true"`

	// Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint.
	// Specify fips if you want the returned Amazon S3 pre-signed URL to point to
	// an Amazon S3 FIPS endpoint. If you don't specify a value, the default is
	// standard.
	IotEndpointType *string `location:"header" locationName:"x-amz-iot-endpoint-type" type:"string" enum:"IotEndpointType"`

	// Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.
	//
	// All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL
	// in all cases. In the US East (N. Virginia) Region the default is GLOBAL,
	// but you can change it to REGIONAL with this parameter.
	S3EndpointType *string `location:"querystring" locationName:"s3EndpointType" type:"string" enum:"S3EndpointType"`
	// contains filtered or unexported fields
}

func (GetComponentVersionArtifactInput) GoString 

func (s GetComponentVersionArtifactInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentVersionArtifactInput) SetArn 

func (s *GetComponentVersionArtifactInput) SetArn(v string) *GetComponentVersionArtifactInput

SetArn sets the Arn field's value.

func (*GetComponentVersionArtifactInput) SetArtifactName 

func (s *GetComponentVersionArtifactInput) SetArtifactName(v string) *GetComponentVersionArtifactInput

SetArtifactName sets the ArtifactName field's value.

func (*GetComponentVersionArtifactInput) SetIotEndpointType added in v1.53.0 

func (s *GetComponentVersionArtifactInput) SetIotEndpointType(v string) *GetComponentVersionArtifactInput

SetIotEndpointType sets the IotEndpointType field's value.

func (*GetComponentVersionArtifactInput) SetS3EndpointType added in v1.53.0 

func (s *GetComponentVersionArtifactInput) SetS3EndpointType(v string) *GetComponentVersionArtifactInput

SetS3EndpointType sets the S3EndpointType field's value.

func (GetComponentVersionArtifactInput) String 

func (s GetComponentVersionArtifactInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentVersionArtifactInput) Validate 

func (s *GetComponentVersionArtifactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComponentVersionArtifactOutput 

type GetComponentVersionArtifactOutput struct {

	// The URL of the artifact.
	//
	// PreSignedUrl is a required field
	PreSignedUrl *string `locationName:"preSignedUrl" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComponentVersionArtifactOutput) GoString 

func (s GetComponentVersionArtifactOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetComponentVersionArtifactOutput) SetPreSignedUrl 

func (s *GetComponentVersionArtifactOutput) SetPreSignedUrl(v string) *GetComponentVersionArtifactOutput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (GetComponentVersionArtifactOutput) String 

func (s GetComponentVersionArtifactOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetConnectivityInfoInput added in v1.42.26 

type GetConnectivityInfoInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConnectivityInfoInput) GoString added in v1.42.26 

func (s GetConnectivityInfoInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConnectivityInfoInput) SetThingName added in v1.42.26 

func (s *GetConnectivityInfoInput) SetThingName(v string) *GetConnectivityInfoInput

SetThingName sets the ThingName field's value.

func (GetConnectivityInfoInput) String added in v1.42.26 

func (s GetConnectivityInfoInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConnectivityInfoInput) Validate added in v1.42.26 

func (s *GetConnectivityInfoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConnectivityInfoOutput added in v1.42.26 

type GetConnectivityInfoOutput struct {

	// The connectivity information for the core device.
	ConnectivityInfo []*ConnectivityInfo `locationName:"ConnectivityInfo" type:"list"`

	// A message about the connectivity information request.
	Message *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

func (GetConnectivityInfoOutput) GoString added in v1.42.26 

func (s GetConnectivityInfoOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConnectivityInfoOutput) SetConnectivityInfo added in v1.42.26 

func (s *GetConnectivityInfoOutput) SetConnectivityInfo(v []*ConnectivityInfo) *GetConnectivityInfoOutput

SetConnectivityInfo sets the ConnectivityInfo field's value.

func (*GetConnectivityInfoOutput) SetMessage added in v1.42.26 

func (s *GetConnectivityInfoOutput) SetMessage(v string) *GetConnectivityInfoOutput

SetMessage sets the Message field's value.

func (GetConnectivityInfoOutput) String added in v1.42.26 

func (s GetConnectivityInfoOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCoreDeviceInput 

type GetCoreDeviceInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCoreDeviceInput) GoString 

func (s GetCoreDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCoreDeviceInput) SetCoreDeviceThingName 

func (s *GetCoreDeviceInput) SetCoreDeviceThingName(v string) *GetCoreDeviceInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (GetCoreDeviceInput) String 

func (s GetCoreDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCoreDeviceInput) Validate 

func (s *GetCoreDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCoreDeviceOutput 

type GetCoreDeviceOutput struct {

	// The computer architecture of the core device.
	Architecture *string `locationName:"architecture" min:"1" type:"string"`

	// The name of the core device. This is also the name of the IoT thing.
	CoreDeviceThingName *string `locationName:"coreDeviceThingName" min:"1" type:"string"`

	// The version of the IoT Greengrass Core software that the core device runs.
	// This version is equivalent to the version of the Greengrass nucleus component
	// that runs on the core device. 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.
	CoreVersion *string `locationName:"coreVersion" min:"1" type:"string"`

	// The time at which the core device's status last updated, expressed in ISO
	// 8601 format.
	LastStatusUpdateTimestamp *time.Time `locationName:"lastStatusUpdateTimestamp" type:"timestamp"`

	// The operating system platform that the core device runs.
	Platform *string `locationName:"platform" min:"1" type:"string"`

	// The status of the core device. The core device status can be:
	//
	//    * 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 *string `locationName:"status" type:"string" enum:"CoreDeviceStatus"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (GetCoreDeviceOutput) GoString 

func (s GetCoreDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCoreDeviceOutput) SetArchitecture 

func (s *GetCoreDeviceOutput) SetArchitecture(v string) *GetCoreDeviceOutput

SetArchitecture sets the Architecture field's value.

func (*GetCoreDeviceOutput) SetCoreDeviceThingName 

func (s *GetCoreDeviceOutput) SetCoreDeviceThingName(v string) *GetCoreDeviceOutput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*GetCoreDeviceOutput) SetCoreVersion 

func (s *GetCoreDeviceOutput) SetCoreVersion(v string) *GetCoreDeviceOutput

SetCoreVersion sets the CoreVersion field's value.

func (*GetCoreDeviceOutput) SetLastStatusUpdateTimestamp 

func (s *GetCoreDeviceOutput) SetLastStatusUpdateTimestamp(v time.Time) *GetCoreDeviceOutput

SetLastStatusUpdateTimestamp sets the LastStatusUpdateTimestamp field's value.

func (*GetCoreDeviceOutput) SetPlatform 

func (s *GetCoreDeviceOutput) SetPlatform(v string) *GetCoreDeviceOutput

SetPlatform sets the Platform field's value.

func (*GetCoreDeviceOutput) SetStatus 

func (s *GetCoreDeviceOutput) SetStatus(v string) *GetCoreDeviceOutput

SetStatus sets the Status field's value.

func (*GetCoreDeviceOutput) SetTags 

func (s *GetCoreDeviceOutput) SetTags(v map[string]*string) *GetCoreDeviceOutput

SetTags sets the Tags field's value.

func (GetCoreDeviceOutput) String 

func (s GetCoreDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeploymentInput 

type GetDeploymentInput struct {

	// The ID of the deployment.
	//
	// DeploymentId is a required field
	DeploymentId *string `location:"uri" locationName:"deploymentId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeploymentInput) GoString 

func (s GetDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentInput) SetDeploymentId 

func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

func (GetDeploymentInput) String 

func (s GetDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentInput) Validate 

func (s *GetDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeploymentOutput 

type GetDeploymentOutput struct {

	// The components to deploy. This is a dictionary, where each key is the name
	// of a component, and each key's value is the version and configuration to
	// deploy for that component.
	Components map[string]*ComponentDeploymentSpecification `locationName:"components" type:"map"`

	// The time at which the deployment was created, expressed in ISO 8601 format.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// The ID of the deployment.
	DeploymentId *string `locationName:"deploymentId" min:"1" type:"string"`

	// The name of the deployment.
	DeploymentName *string `locationName:"deploymentName" type:"string"`

	// The deployment policies for the deployment. These policies define how the
	// deployment updates components and handles failure.
	DeploymentPolicies *DeploymentPolicies `locationName:"deploymentPolicies" type:"structure"`

	// The status of the deployment.
	DeploymentStatus *string `locationName:"deploymentStatus" type:"string" enum:"DeploymentStatus"`

	// 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 `locationName:"iotJobArn" type:"string"`

	// The job configuration for the deployment configuration. The job configuration
	// specifies the rollout, timeout, and stop configurations for the deployment
	// configuration.
	IotJobConfiguration *DeploymentIoTJobConfiguration `locationName:"iotJobConfiguration" type:"structure"`

	// The ID of the IoT job that applies the deployment to target devices.
	IotJobId *string `locationName:"iotJobId" type:"string"`

	// Whether or not the deployment is the latest revision for its target.
	IsLatestForTarget *bool `locationName:"isLatestForTarget" type:"boolean"`

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

	// The revision number of the deployment.
	RevisionId *string `locationName:"revisionId" min:"1" type:"string"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the target IoT thing or thing group.
	TargetArn *string `locationName:"targetArn" type:"string"`
	// contains filtered or unexported fields
}

func (GetDeploymentOutput) GoString 

func (s GetDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeploymentOutput) SetComponents 

func (s *GetDeploymentOutput) SetComponents(v map[string]*ComponentDeploymentSpecification) *GetDeploymentOutput

SetComponents sets the Components field's value.

func (*GetDeploymentOutput) SetCreationTimestamp 

func (s *GetDeploymentOutput) SetCreationTimestamp(v time.Time) *GetDeploymentOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*GetDeploymentOutput) SetDeploymentId 

func (s *GetDeploymentOutput) SetDeploymentId(v string) *GetDeploymentOutput

SetDeploymentId sets the DeploymentId field's value.

func (*GetDeploymentOutput) SetDeploymentName 

func (s *GetDeploymentOutput) SetDeploymentName(v string) *GetDeploymentOutput

SetDeploymentName sets the DeploymentName field's value.

func (*GetDeploymentOutput) SetDeploymentPolicies 

func (s *GetDeploymentOutput) SetDeploymentPolicies(v *DeploymentPolicies) *GetDeploymentOutput

SetDeploymentPolicies sets the DeploymentPolicies field's value.

func (*GetDeploymentOutput) SetDeploymentStatus 

func (s *GetDeploymentOutput) SetDeploymentStatus(v string) *GetDeploymentOutput

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*GetDeploymentOutput) SetIotJobArn 

func (s *GetDeploymentOutput) SetIotJobArn(v string) *GetDeploymentOutput

SetIotJobArn sets the IotJobArn field's value.

func (*GetDeploymentOutput) SetIotJobConfiguration 

func (s *GetDeploymentOutput) SetIotJobConfiguration(v *DeploymentIoTJobConfiguration) *GetDeploymentOutput

SetIotJobConfiguration sets the IotJobConfiguration field's value.

func (*GetDeploymentOutput) SetIotJobId 

func (s *GetDeploymentOutput) SetIotJobId(v string) *GetDeploymentOutput

SetIotJobId sets the IotJobId field's value.

func (*GetDeploymentOutput) SetIsLatestForTarget 

func (s *GetDeploymentOutput) SetIsLatestForTarget(v bool) *GetDeploymentOutput

SetIsLatestForTarget sets the IsLatestForTarget field's value.

func (*GetDeploymentOutput) SetParentTargetArn added in v1.44.138 

func (s *GetDeploymentOutput) SetParentTargetArn(v string) *GetDeploymentOutput

SetParentTargetArn sets the ParentTargetArn field's value.

func (*GetDeploymentOutput) SetRevisionId 

func (s *GetDeploymentOutput) SetRevisionId(v string) *GetDeploymentOutput

SetRevisionId sets the RevisionId field's value.

func (*GetDeploymentOutput) SetTags 

func (s *GetDeploymentOutput) SetTags(v map[string]*string) *GetDeploymentOutput

SetTags sets the Tags field's value.

func (*GetDeploymentOutput) SetTargetArn 

func (s *GetDeploymentOutput) SetTargetArn(v string) *GetDeploymentOutput

SetTargetArn sets the TargetArn field's value.

func (GetDeploymentOutput) String 

func (s GetDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetServiceRoleForAccountInput added in v1.42.26 

type GetServiceRoleForAccountInput struct {
	// contains filtered or unexported fields
}

func (GetServiceRoleForAccountInput) GoString added in v1.42.26 

func (s GetServiceRoleForAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetServiceRoleForAccountInput) String added in v1.42.26 

func (s GetServiceRoleForAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetServiceRoleForAccountOutput added in v1.42.26 

type GetServiceRoleForAccountOutput struct {

	// The time when the service role was associated with IoT Greengrass for your
	// Amazon Web Services account in this Amazon Web Services Region.
	AssociatedAt *string `locationName:"AssociatedAt" type:"string"`

	// The ARN of the service role that is associated with IoT Greengrass for your
	// Amazon Web Services account in this Amazon Web Services Region.
	RoleArn *string `locationName:"RoleArn" type:"string"`
	// contains filtered or unexported fields
}

func (GetServiceRoleForAccountOutput) GoString added in v1.42.26 

func (s GetServiceRoleForAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetServiceRoleForAccountOutput) SetAssociatedAt added in v1.42.26 

func (s *GetServiceRoleForAccountOutput) SetAssociatedAt(v string) *GetServiceRoleForAccountOutput

SetAssociatedAt sets the AssociatedAt field's value.

func (*GetServiceRoleForAccountOutput) SetRoleArn added in v1.42.26 

func (s *GetServiceRoleForAccountOutput) SetRoleArn(v string) *GetServiceRoleForAccountOutput

SetRoleArn sets the RoleArn field's value.

func (GetServiceRoleForAccountOutput) String added in v1.42.26 

func (s GetServiceRoleForAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GreengrassV2 

type GreengrassV2 struct {
	*client.Client
}

GreengrassV2 provides the API operation methods for making requests to AWS IoT Greengrass V2. See this package's package overview docs for details on the service.

GreengrassV2 methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *GreengrassV2

New creates a new instance of the GreengrassV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a GreengrassV2 client from just a session.
svc := greengrassv2.New(mySession)

// Create a GreengrassV2 client with additional configuration
svc := greengrassv2.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*GreengrassV2) AssociateServiceRoleToAccount added in v1.42.26 

func (c *GreengrassV2) AssociateServiceRoleToAccount(input *AssociateServiceRoleToAccountInput) (*AssociateServiceRoleToAccountOutput, error)

AssociateServiceRoleToAccount API operation for AWS IoT Greengrass V2.

Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy (https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy) managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) in the IoT Greengrass Version 2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation AssociateServiceRoleToAccount for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/AssociateServiceRoleToAccount

func (*GreengrassV2) AssociateServiceRoleToAccountRequest added in v1.42.26 

func (c *GreengrassV2) AssociateServiceRoleToAccountRequest(input *AssociateServiceRoleToAccountInput) (req *request.Request, output *AssociateServiceRoleToAccountOutput)

AssociateServiceRoleToAccountRequest generates a "aws/request.Request" representing the client's request for the AssociateServiceRoleToAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateServiceRoleToAccount for more information on using the AssociateServiceRoleToAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateServiceRoleToAccountRequest method.
req, resp := client.AssociateServiceRoleToAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/AssociateServiceRoleToAccount

func (*GreengrassV2) AssociateServiceRoleToAccountWithContext added in v1.42.26 

func (c *GreengrassV2) AssociateServiceRoleToAccountWithContext(ctx aws.Context, input *AssociateServiceRoleToAccountInput, opts ...request.Option) (*AssociateServiceRoleToAccountOutput, error)

AssociateServiceRoleToAccountWithContext is the same as AssociateServiceRoleToAccount with the addition of the ability to pass a context and additional request options.

See AssociateServiceRoleToAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) BatchAssociateClientDeviceWithCoreDevice added in v1.38.61 

func (c *GreengrassV2) BatchAssociateClientDeviceWithCoreDevice(input *BatchAssociateClientDeviceWithCoreDeviceInput) (*BatchAssociateClientDeviceWithCoreDeviceOutput, error)

BatchAssociateClientDeviceWithCoreDevice API operation for AWS IoT Greengrass V2.

Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery (https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html) in the IoT Greengrass V2 Developer Guide.

Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html) in the IoT Greengrass V2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation BatchAssociateClientDeviceWithCoreDevice for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchAssociateClientDeviceWithCoreDevice

func (*GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceRequest added in v1.38.61 

func (c *GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceRequest(input *BatchAssociateClientDeviceWithCoreDeviceInput) (req *request.Request, output *BatchAssociateClientDeviceWithCoreDeviceOutput)

BatchAssociateClientDeviceWithCoreDeviceRequest generates a "aws/request.Request" representing the client's request for the BatchAssociateClientDeviceWithCoreDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchAssociateClientDeviceWithCoreDevice for more information on using the BatchAssociateClientDeviceWithCoreDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchAssociateClientDeviceWithCoreDeviceRequest method.
req, resp := client.BatchAssociateClientDeviceWithCoreDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchAssociateClientDeviceWithCoreDevice

func (*GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceWithContext added in v1.38.61 

func (c *GreengrassV2) BatchAssociateClientDeviceWithCoreDeviceWithContext(ctx aws.Context, input *BatchAssociateClientDeviceWithCoreDeviceInput, opts ...request.Option) (*BatchAssociateClientDeviceWithCoreDeviceOutput, error)

BatchAssociateClientDeviceWithCoreDeviceWithContext is the same as BatchAssociateClientDeviceWithCoreDevice with the addition of the ability to pass a context and additional request options.

See BatchAssociateClientDeviceWithCoreDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) BatchDisassociateClientDeviceFromCoreDevice added in v1.38.61 

func (c *GreengrassV2) BatchDisassociateClientDeviceFromCoreDevice(input *BatchDisassociateClientDeviceFromCoreDeviceInput) (*BatchDisassociateClientDeviceFromCoreDeviceOutput, error)

BatchDisassociateClientDeviceFromCoreDevice API operation for AWS IoT Greengrass V2.

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation BatchDisassociateClientDeviceFromCoreDevice for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchDisassociateClientDeviceFromCoreDevice

func (*GreengrassV2) BatchDisassociateClientDeviceFromCoreDeviceRequest added in v1.38.61 

func (c *GreengrassV2) BatchDisassociateClientDeviceFromCoreDeviceRequest(input *BatchDisassociateClientDeviceFromCoreDeviceInput) (req *request.Request, output *BatchDisassociateClientDeviceFromCoreDeviceOutput)

BatchDisassociateClientDeviceFromCoreDeviceRequest generates a "aws/request.Request" representing the client's request for the BatchDisassociateClientDeviceFromCoreDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDisassociateClientDeviceFromCoreDevice for more information on using the BatchDisassociateClientDeviceFromCoreDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDisassociateClientDeviceFromCoreDeviceRequest method.
req, resp := client.BatchDisassociateClientDeviceFromCoreDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/BatchDisassociateClientDeviceFromCoreDevice

func (*GreengrassV2) BatchDisassociateClientDeviceFromCoreDeviceWithContext added in v1.38.61 

func (c *GreengrassV2) BatchDisassociateClientDeviceFromCoreDeviceWithContext(ctx aws.Context, input *BatchDisassociateClientDeviceFromCoreDeviceInput, opts ...request.Option) (*BatchDisassociateClientDeviceFromCoreDeviceOutput, error)

BatchDisassociateClientDeviceFromCoreDeviceWithContext is the same as BatchDisassociateClientDeviceFromCoreDevice with the addition of the ability to pass a context and additional request options.

See BatchDisassociateClientDeviceFromCoreDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) CancelDeployment 

func (c *GreengrassV2) CancelDeployment(input *CancelDeploymentInput) (*CancelDeploymentOutput, error)

CancelDeployment API operation for AWS IoT Greengrass V2.

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation CancelDeployment for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource can't be found.

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

  • AccessDeniedException You don't have permission to perform the action.

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

  • ConflictException 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.

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CancelDeployment

func (*GreengrassV2) CancelDeploymentRequest 

func (c *GreengrassV2) CancelDeploymentRequest(input *CancelDeploymentInput) (req *request.Request, output *CancelDeploymentOutput)

CancelDeploymentRequest generates a "aws/request.Request" representing the client's request for the CancelDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelDeployment for more information on using the CancelDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelDeploymentRequest method.
req, resp := client.CancelDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CancelDeployment

func (*GreengrassV2) CancelDeploymentWithContext 

func (c *GreengrassV2) CancelDeploymentWithContext(ctx aws.Context, input *CancelDeploymentInput, opts ...request.Option) (*CancelDeploymentOutput, error)

CancelDeploymentWithContext is the same as CancelDeployment with the addition of the ability to pass a context and additional request options.

See CancelDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) CreateComponentVersion 

func (c *GreengrassV2) CreateComponentVersion(input *CreateComponentVersionInput) (*CreateComponentVersionOutput, error)

CreateComponentVersion API operation for AWS IoT Greengrass V2.

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:

  • Create components from recipes Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference (https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html) in the IoT Greengrass V2 Developer Guide. To create a component from a recipe, specify inlineRecipe when you call this operation.

  • Create components from Lambda functions Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2. This function accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions. To create a component from a Lambda function, specify lambdaFunction when you call this operation. IoT Greengrass currently supports Lambda functions on only Linux core devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation CreateComponentVersion for usage and error information.

Returned Error Types:

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

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

  • AccessDeniedException You don't have permission to perform the action.

  • ConflictException 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.

  • ThrottlingException 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.

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

  • RequestAlreadyInProgressException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateComponentVersion

func (*GreengrassV2) CreateComponentVersionRequest 

func (c *GreengrassV2) CreateComponentVersionRequest(input *CreateComponentVersionInput) (req *request.Request, output *CreateComponentVersionOutput)

CreateComponentVersionRequest generates a "aws/request.Request" representing the client's request for the CreateComponentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateComponentVersion for more information on using the CreateComponentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateComponentVersionRequest method.
req, resp := client.CreateComponentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateComponentVersion

func (*GreengrassV2) CreateComponentVersionWithContext 

func (c *GreengrassV2) CreateComponentVersionWithContext(ctx aws.Context, input *CreateComponentVersionInput, opts ...request.Option) (*CreateComponentVersionOutput, error)

CreateComponentVersionWithContext is the same as CreateComponentVersion with the addition of the ability to pass a context and additional request options.

See CreateComponentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) CreateDeployment 

func (c *GreengrassV2) CreateDeployment(input *CreateDeploymentInput) (*CreateDeploymentOutput, error)

CreateDeployment API operation for AWS IoT Greengrass V2.

Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.

For more information, see the Create deployments (https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the IoT Greengrass V2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation CreateDeployment for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource can't be found.

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

  • AccessDeniedException You don't have permission to perform the action.

  • ThrottlingException 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.

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

  • ConflictException 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.

  • RequestAlreadyInProgressException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateDeployment

func (*GreengrassV2) CreateDeploymentRequest 

func (c *GreengrassV2) CreateDeploymentRequest(input *CreateDeploymentInput) (req *request.Request, output *CreateDeploymentOutput)

CreateDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDeployment for more information on using the CreateDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDeploymentRequest method.
req, resp := client.CreateDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CreateDeployment

func (*GreengrassV2) CreateDeploymentWithContext 

func (c *GreengrassV2) CreateDeploymentWithContext(ctx aws.Context, input *CreateDeploymentInput, opts ...request.Option) (*CreateDeploymentOutput, error)

CreateDeploymentWithContext is the same as CreateDeployment with the addition of the ability to pass a context and additional request options.

See CreateDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) DeleteComponent 

func (c *GreengrassV2) DeleteComponent(input *DeleteComponentInput) (*DeleteComponentOutput, error)

DeleteComponent API operation for AWS IoT Greengrass V2.

Deletes a version of a component from IoT Greengrass.

This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation DeleteComponent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ConflictException 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.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteComponent

func (*GreengrassV2) DeleteComponentRequest 

func (c *GreengrassV2) DeleteComponentRequest(input *DeleteComponentInput) (req *request.Request, output *DeleteComponentOutput)

DeleteComponentRequest generates a "aws/request.Request" representing the client's request for the DeleteComponent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteComponent for more information on using the DeleteComponent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteComponentRequest method.
req, resp := client.DeleteComponentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteComponent

func (*GreengrassV2) DeleteComponentWithContext 

func (c *GreengrassV2) DeleteComponentWithContext(ctx aws.Context, input *DeleteComponentInput, opts ...request.Option) (*DeleteComponentOutput, error)

DeleteComponentWithContext is the same as DeleteComponent with the addition of the ability to pass a context and additional request options.

See DeleteComponent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) DeleteCoreDevice 

func (c *GreengrassV2) DeleteCoreDevice(input *DeleteCoreDeviceInput) (*DeleteCoreDeviceOutput, error)

DeleteCoreDevice API operation for AWS IoT Greengrass V2.

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing (https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html) in the IoT API Reference.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation DeleteCoreDevice for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

  • ConflictException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteCoreDevice

func (*GreengrassV2) DeleteCoreDeviceRequest 

func (c *GreengrassV2) DeleteCoreDeviceRequest(input *DeleteCoreDeviceInput) (req *request.Request, output *DeleteCoreDeviceOutput)

DeleteCoreDeviceRequest generates a "aws/request.Request" representing the client's request for the DeleteCoreDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCoreDevice for more information on using the DeleteCoreDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteCoreDeviceRequest method.
req, resp := client.DeleteCoreDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteCoreDevice

func (*GreengrassV2) DeleteCoreDeviceWithContext 

func (c *GreengrassV2) DeleteCoreDeviceWithContext(ctx aws.Context, input *DeleteCoreDeviceInput, opts ...request.Option) (*DeleteCoreDeviceOutput, error)

DeleteCoreDeviceWithContext is the same as DeleteCoreDevice with the addition of the ability to pass a context and additional request options.

See DeleteCoreDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) DeleteDeployment added in v1.44.17 

func (c *GreengrassV2) DeleteDeployment(input *DeleteDeploymentInput) (*DeleteDeploymentOutput, error)

DeleteDeployment API operation for AWS IoT Greengrass V2.

Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment (https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html).

Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation DeleteDeployment for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource can't be found.

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

  • AccessDeniedException You don't have permission to perform the action.

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

  • ConflictException 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.

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteDeployment

func (*GreengrassV2) DeleteDeploymentRequest added in v1.44.17 

func (c *GreengrassV2) DeleteDeploymentRequest(input *DeleteDeploymentInput) (req *request.Request, output *DeleteDeploymentOutput)

DeleteDeploymentRequest generates a "aws/request.Request" representing the client's request for the DeleteDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDeployment for more information on using the DeleteDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDeploymentRequest method.
req, resp := client.DeleteDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeleteDeployment

func (*GreengrassV2) DeleteDeploymentWithContext added in v1.44.17 

func (c *GreengrassV2) DeleteDeploymentWithContext(ctx aws.Context, input *DeleteDeploymentInput, opts ...request.Option) (*DeleteDeploymentOutput, error)

DeleteDeploymentWithContext is the same as DeleteDeployment with the addition of the ability to pass a context and additional request options.

See DeleteDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) DescribeComponent 

func (c *GreengrassV2) DescribeComponent(input *DescribeComponentInput) (*DescribeComponentOutput, error)

DescribeComponent API operation for AWS IoT Greengrass V2.

Retrieves metadata for a version of a component.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation DescribeComponent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DescribeComponent

func (*GreengrassV2) DescribeComponentRequest 

func (c *GreengrassV2) DescribeComponentRequest(input *DescribeComponentInput) (req *request.Request, output *DescribeComponentOutput)

DescribeComponentRequest generates a "aws/request.Request" representing the client's request for the DescribeComponent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeComponent for more information on using the DescribeComponent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeComponentRequest method.
req, resp := client.DescribeComponentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DescribeComponent

func (*GreengrassV2) DescribeComponentWithContext 

func (c *GreengrassV2) DescribeComponentWithContext(ctx aws.Context, input *DescribeComponentInput, opts ...request.Option) (*DescribeComponentOutput, error)

DescribeComponentWithContext is the same as DescribeComponent with the addition of the ability to pass a context and additional request options.

See DescribeComponent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) DisassociateServiceRoleFromAccount added in v1.42.26 

func (c *GreengrassV2) DisassociateServiceRoleFromAccount(input *DisassociateServiceRoleFromAccountInput) (*DisassociateServiceRoleFromAccountOutput, error)

DisassociateServiceRoleFromAccount API operation for AWS IoT Greengrass V2.

Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) in the IoT Greengrass Version 2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation DisassociateServiceRoleFromAccount for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DisassociateServiceRoleFromAccount

func (*GreengrassV2) DisassociateServiceRoleFromAccountRequest added in v1.42.26 

func (c *GreengrassV2) DisassociateServiceRoleFromAccountRequest(input *DisassociateServiceRoleFromAccountInput) (req *request.Request, output *DisassociateServiceRoleFromAccountOutput)

DisassociateServiceRoleFromAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateServiceRoleFromAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateServiceRoleFromAccount for more information on using the DisassociateServiceRoleFromAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateServiceRoleFromAccountRequest method.
req, resp := client.DisassociateServiceRoleFromAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DisassociateServiceRoleFromAccount

func (*GreengrassV2) DisassociateServiceRoleFromAccountWithContext added in v1.42.26 

func (c *GreengrassV2) DisassociateServiceRoleFromAccountWithContext(ctx aws.Context, input *DisassociateServiceRoleFromAccountInput, opts ...request.Option) (*DisassociateServiceRoleFromAccountOutput, error)

DisassociateServiceRoleFromAccountWithContext is the same as DisassociateServiceRoleFromAccount with the addition of the ability to pass a context and additional request options.

See DisassociateServiceRoleFromAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetComponent 

func (c *GreengrassV2) GetComponent(input *GetComponentInput) (*GetComponentOutput, error)

GetComponent API operation for AWS IoT Greengrass V2.

Gets the recipe for a version of a component.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetComponent for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponent

func (*GreengrassV2) GetComponentRequest 

func (c *GreengrassV2) GetComponentRequest(input *GetComponentInput) (req *request.Request, output *GetComponentOutput)

GetComponentRequest generates a "aws/request.Request" representing the client's request for the GetComponent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComponent for more information on using the GetComponent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetComponentRequest method.
req, resp := client.GetComponentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponent

func (*GreengrassV2) GetComponentVersionArtifact 

func (c *GreengrassV2) GetComponentVersionArtifact(input *GetComponentVersionArtifactInput) (*GetComponentVersionArtifactOutput, error)

GetComponentVersionArtifact API operation for AWS IoT Greengrass V2.

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetComponentVersionArtifact for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponentVersionArtifact

func (*GreengrassV2) GetComponentVersionArtifactRequest 

func (c *GreengrassV2) GetComponentVersionArtifactRequest(input *GetComponentVersionArtifactInput) (req *request.Request, output *GetComponentVersionArtifactOutput)

GetComponentVersionArtifactRequest generates a "aws/request.Request" representing the client's request for the GetComponentVersionArtifact operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComponentVersionArtifact for more information on using the GetComponentVersionArtifact API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetComponentVersionArtifactRequest method.
req, resp := client.GetComponentVersionArtifactRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetComponentVersionArtifact

func (*GreengrassV2) GetComponentVersionArtifactWithContext 

func (c *GreengrassV2) GetComponentVersionArtifactWithContext(ctx aws.Context, input *GetComponentVersionArtifactInput, opts ...request.Option) (*GetComponentVersionArtifactOutput, error)

GetComponentVersionArtifactWithContext is the same as GetComponentVersionArtifact with the addition of the ability to pass a context and additional request options.

See GetComponentVersionArtifact for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetComponentWithContext 

func (c *GreengrassV2) GetComponentWithContext(ctx aws.Context, input *GetComponentInput, opts ...request.Option) (*GetComponentOutput, error)

GetComponentWithContext is the same as GetComponent with the addition of the ability to pass a context and additional request options.

See GetComponent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetConnectivityInfo added in v1.42.26 

func (c *GreengrassV2) GetConnectivityInfo(input *GetConnectivityInfoInput) (*GetConnectivityInfoOutput, error)

GetConnectivityInfo API operation for AWS IoT Greengrass V2.

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html), IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) in the IoT Greengrass Version 2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetConnectivityInfo for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetConnectivityInfo

func (*GreengrassV2) GetConnectivityInfoRequest added in v1.42.26 

func (c *GreengrassV2) GetConnectivityInfoRequest(input *GetConnectivityInfoInput) (req *request.Request, output *GetConnectivityInfoOutput)

GetConnectivityInfoRequest generates a "aws/request.Request" representing the client's request for the GetConnectivityInfo operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConnectivityInfo for more information on using the GetConnectivityInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetConnectivityInfoRequest method.
req, resp := client.GetConnectivityInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetConnectivityInfo

func (*GreengrassV2) GetConnectivityInfoWithContext added in v1.42.26 

func (c *GreengrassV2) GetConnectivityInfoWithContext(ctx aws.Context, input *GetConnectivityInfoInput, opts ...request.Option) (*GetConnectivityInfoOutput, error)

GetConnectivityInfoWithContext is the same as GetConnectivityInfo with the addition of the ability to pass a context and additional request options.

See GetConnectivityInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetCoreDevice 

func (c *GreengrassV2) GetCoreDevice(input *GetCoreDeviceInput) (*GetCoreDeviceOutput, error)

GetCoreDevice API operation for AWS IoT Greengrass V2.

Retrieves metadata for a Greengrass core device.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetCoreDevice for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetCoreDevice

func (*GreengrassV2) GetCoreDeviceRequest 

func (c *GreengrassV2) GetCoreDeviceRequest(input *GetCoreDeviceInput) (req *request.Request, output *GetCoreDeviceOutput)

GetCoreDeviceRequest generates a "aws/request.Request" representing the client's request for the GetCoreDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCoreDevice for more information on using the GetCoreDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetCoreDeviceRequest method.
req, resp := client.GetCoreDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetCoreDevice

func (*GreengrassV2) GetCoreDeviceWithContext 

func (c *GreengrassV2) GetCoreDeviceWithContext(ctx aws.Context, input *GetCoreDeviceInput, opts ...request.Option) (*GetCoreDeviceOutput, error)

GetCoreDeviceWithContext is the same as GetCoreDevice with the addition of the ability to pass a context and additional request options.

See GetCoreDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetDeployment 

func (c *GreengrassV2) GetDeployment(input *GetDeploymentInput) (*GetDeploymentOutput, error)

GetDeployment API operation for AWS IoT Greengrass V2.

Gets a deployment. Deployments define the components that run on Greengrass core devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetDeployment for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetDeployment

func (*GreengrassV2) GetDeploymentRequest 

func (c *GreengrassV2) GetDeploymentRequest(input *GetDeploymentInput) (req *request.Request, output *GetDeploymentOutput)

GetDeploymentRequest generates a "aws/request.Request" representing the client's request for the GetDeployment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeployment for more information on using the GetDeployment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDeploymentRequest method.
req, resp := client.GetDeploymentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetDeployment

func (*GreengrassV2) GetDeploymentWithContext 

func (c *GreengrassV2) GetDeploymentWithContext(ctx aws.Context, input *GetDeploymentInput, opts ...request.Option) (*GetDeploymentOutput, error)

GetDeploymentWithContext is the same as GetDeployment with the addition of the ability to pass a context and additional request options.

See GetDeployment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) GetServiceRoleForAccount added in v1.42.26 

func (c *GreengrassV2) GetServiceRoleForAccount(input *GetServiceRoleForAccountInput) (*GetServiceRoleForAccountOutput, error)

GetServiceRoleForAccount API operation for AWS IoT Greengrass V2.

Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html) in the IoT Greengrass Version 2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation GetServiceRoleForAccount for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetServiceRoleForAccount

func (*GreengrassV2) GetServiceRoleForAccountRequest added in v1.42.26 

func (c *GreengrassV2) GetServiceRoleForAccountRequest(input *GetServiceRoleForAccountInput) (req *request.Request, output *GetServiceRoleForAccountOutput)

GetServiceRoleForAccountRequest generates a "aws/request.Request" representing the client's request for the GetServiceRoleForAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetServiceRoleForAccount for more information on using the GetServiceRoleForAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetServiceRoleForAccountRequest method.
req, resp := client.GetServiceRoleForAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/GetServiceRoleForAccount

func (*GreengrassV2) GetServiceRoleForAccountWithContext added in v1.42.26 

func (c *GreengrassV2) GetServiceRoleForAccountWithContext(ctx aws.Context, input *GetServiceRoleForAccountInput, opts ...request.Option) (*GetServiceRoleForAccountOutput, error)

GetServiceRoleForAccountWithContext is the same as GetServiceRoleForAccount with the addition of the ability to pass a context and additional request options.

See GetServiceRoleForAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListClientDevicesAssociatedWithCoreDevice added in v1.38.61 

func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDevice(input *ListClientDevicesAssociatedWithCoreDeviceInput) (*ListClientDevicesAssociatedWithCoreDeviceOutput, error)

ListClientDevicesAssociatedWithCoreDevice API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of client devices that are associated with a core device.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListClientDevicesAssociatedWithCoreDevice for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListClientDevicesAssociatedWithCoreDevice

func (*GreengrassV2) ListClientDevicesAssociatedWithCoreDevicePages added in v1.38.61 

func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDevicePages(input *ListClientDevicesAssociatedWithCoreDeviceInput, fn func(*ListClientDevicesAssociatedWithCoreDeviceOutput, bool) bool) error

ListClientDevicesAssociatedWithCoreDevicePages iterates over the pages of a ListClientDevicesAssociatedWithCoreDevice operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClientDevicesAssociatedWithCoreDevice method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListClientDevicesAssociatedWithCoreDevice operation.
pageNum := 0
err := client.ListClientDevicesAssociatedWithCoreDevicePages(params,
    func(page *greengrassv2.ListClientDevicesAssociatedWithCoreDeviceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListClientDevicesAssociatedWithCoreDevicePagesWithContext added in v1.38.61 

func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDevicePagesWithContext(ctx aws.Context, input *ListClientDevicesAssociatedWithCoreDeviceInput, fn func(*ListClientDevicesAssociatedWithCoreDeviceOutput, bool) bool, opts ...request.Option) error

ListClientDevicesAssociatedWithCoreDevicePagesWithContext same as ListClientDevicesAssociatedWithCoreDevicePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListClientDevicesAssociatedWithCoreDeviceRequest added in v1.38.61 

func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDeviceRequest(input *ListClientDevicesAssociatedWithCoreDeviceInput) (req *request.Request, output *ListClientDevicesAssociatedWithCoreDeviceOutput)

ListClientDevicesAssociatedWithCoreDeviceRequest generates a "aws/request.Request" representing the client's request for the ListClientDevicesAssociatedWithCoreDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClientDevicesAssociatedWithCoreDevice for more information on using the ListClientDevicesAssociatedWithCoreDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListClientDevicesAssociatedWithCoreDeviceRequest method.
req, resp := client.ListClientDevicesAssociatedWithCoreDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListClientDevicesAssociatedWithCoreDevice

func (*GreengrassV2) ListClientDevicesAssociatedWithCoreDeviceWithContext added in v1.38.61 

func (c *GreengrassV2) ListClientDevicesAssociatedWithCoreDeviceWithContext(ctx aws.Context, input *ListClientDevicesAssociatedWithCoreDeviceInput, opts ...request.Option) (*ListClientDevicesAssociatedWithCoreDeviceOutput, error)

ListClientDevicesAssociatedWithCoreDeviceWithContext is the same as ListClientDevicesAssociatedWithCoreDevice with the addition of the ability to pass a context and additional request options.

See ListClientDevicesAssociatedWithCoreDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListComponentVersions 

func (c *GreengrassV2) ListComponentVersions(input *ListComponentVersionsInput) (*ListComponentVersionsOutput, error)

ListComponentVersions API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of all versions for a component. Greater versions are listed first.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListComponentVersions for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponentVersions

func (*GreengrassV2) ListComponentVersionsPages 

func (c *GreengrassV2) ListComponentVersionsPages(input *ListComponentVersionsInput, fn func(*ListComponentVersionsOutput, bool) bool) error

ListComponentVersionsPages iterates over the pages of a ListComponentVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListComponentVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListComponentVersions operation.
pageNum := 0
err := client.ListComponentVersionsPages(params,
    func(page *greengrassv2.ListComponentVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListComponentVersionsPagesWithContext 

func (c *GreengrassV2) ListComponentVersionsPagesWithContext(ctx aws.Context, input *ListComponentVersionsInput, fn func(*ListComponentVersionsOutput, bool) bool, opts ...request.Option) error

ListComponentVersionsPagesWithContext same as ListComponentVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListComponentVersionsRequest 

func (c *GreengrassV2) ListComponentVersionsRequest(input *ListComponentVersionsInput) (req *request.Request, output *ListComponentVersionsOutput)

ListComponentVersionsRequest generates a "aws/request.Request" representing the client's request for the ListComponentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComponentVersions for more information on using the ListComponentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListComponentVersionsRequest method.
req, resp := client.ListComponentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponentVersions

func (*GreengrassV2) ListComponentVersionsWithContext 

func (c *GreengrassV2) ListComponentVersionsWithContext(ctx aws.Context, input *ListComponentVersionsInput, opts ...request.Option) (*ListComponentVersionsOutput, error)

ListComponentVersionsWithContext is the same as ListComponentVersions with the addition of the ability to pass a context and additional request options.

See ListComponentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListComponents 

func (c *GreengrassV2) ListComponents(input *ListComponentsInput) (*ListComponentsOutput, error)

ListComponents API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of component summaries. This list includes components that you have permission to view.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListComponents for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponents

func (*GreengrassV2) ListComponentsPages 

func (c *GreengrassV2) ListComponentsPages(input *ListComponentsInput, fn func(*ListComponentsOutput, bool) bool) error

ListComponentsPages iterates over the pages of a ListComponents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListComponents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListComponents operation.
pageNum := 0
err := client.ListComponentsPages(params,
    func(page *greengrassv2.ListComponentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListComponentsPagesWithContext 

func (c *GreengrassV2) ListComponentsPagesWithContext(ctx aws.Context, input *ListComponentsInput, fn func(*ListComponentsOutput, bool) bool, opts ...request.Option) error

ListComponentsPagesWithContext same as ListComponentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListComponentsRequest 

func (c *GreengrassV2) ListComponentsRequest(input *ListComponentsInput) (req *request.Request, output *ListComponentsOutput)

ListComponentsRequest generates a "aws/request.Request" representing the client's request for the ListComponents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComponents for more information on using the ListComponents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListComponentsRequest method.
req, resp := client.ListComponentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponents

func (*GreengrassV2) ListComponentsWithContext 

func (c *GreengrassV2) ListComponentsWithContext(ctx aws.Context, input *ListComponentsInput, opts ...request.Option) (*ListComponentsOutput, error)

ListComponentsWithContext is the same as ListComponents with the addition of the ability to pass a context and additional request options.

See ListComponents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListCoreDevices 

func (c *GreengrassV2) ListCoreDevices(input *ListCoreDevicesInput) (*ListCoreDevicesOutput, error)

ListCoreDevices API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of Greengrass core devices.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListCoreDevices for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListCoreDevices

func (*GreengrassV2) ListCoreDevicesPages 

func (c *GreengrassV2) ListCoreDevicesPages(input *ListCoreDevicesInput, fn func(*ListCoreDevicesOutput, bool) bool) error

ListCoreDevicesPages iterates over the pages of a ListCoreDevices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCoreDevices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListCoreDevices operation.
pageNum := 0
err := client.ListCoreDevicesPages(params,
    func(page *greengrassv2.ListCoreDevicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListCoreDevicesPagesWithContext 

func (c *GreengrassV2) ListCoreDevicesPagesWithContext(ctx aws.Context, input *ListCoreDevicesInput, fn func(*ListCoreDevicesOutput, bool) bool, opts ...request.Option) error

ListCoreDevicesPagesWithContext same as ListCoreDevicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListCoreDevicesRequest 

func (c *GreengrassV2) ListCoreDevicesRequest(input *ListCoreDevicesInput) (req *request.Request, output *ListCoreDevicesOutput)

ListCoreDevicesRequest generates a "aws/request.Request" representing the client's request for the ListCoreDevices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCoreDevices for more information on using the ListCoreDevices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListCoreDevicesRequest method.
req, resp := client.ListCoreDevicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListCoreDevices

func (*GreengrassV2) ListCoreDevicesWithContext 

func (c *GreengrassV2) ListCoreDevicesWithContext(ctx aws.Context, input *ListCoreDevicesInput, opts ...request.Option) (*ListCoreDevicesOutput, error)

ListCoreDevicesWithContext is the same as ListCoreDevices with the addition of the ability to pass a context and additional request options.

See ListCoreDevices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListDeployments 

func (c *GreengrassV2) ListDeployments(input *ListDeploymentsInput) (*ListDeploymentsOutput, error)

ListDeployments API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of deployments.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListDeployments for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListDeployments

func (*GreengrassV2) ListDeploymentsPages 

func (c *GreengrassV2) ListDeploymentsPages(input *ListDeploymentsInput, fn func(*ListDeploymentsOutput, bool) bool) error

ListDeploymentsPages iterates over the pages of a ListDeployments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDeployments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDeployments operation.
pageNum := 0
err := client.ListDeploymentsPages(params,
    func(page *greengrassv2.ListDeploymentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListDeploymentsPagesWithContext 

func (c *GreengrassV2) ListDeploymentsPagesWithContext(ctx aws.Context, input *ListDeploymentsInput, fn func(*ListDeploymentsOutput, bool) bool, opts ...request.Option) error

ListDeploymentsPagesWithContext same as ListDeploymentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListDeploymentsRequest 

func (c *GreengrassV2) ListDeploymentsRequest(input *ListDeploymentsInput) (req *request.Request, output *ListDeploymentsOutput)

ListDeploymentsRequest generates a "aws/request.Request" representing the client's request for the ListDeployments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDeployments for more information on using the ListDeployments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDeploymentsRequest method.
req, resp := client.ListDeploymentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListDeployments

func (*GreengrassV2) ListDeploymentsWithContext 

func (c *GreengrassV2) ListDeploymentsWithContext(ctx aws.Context, input *ListDeploymentsInput, opts ...request.Option) (*ListDeploymentsOutput, error)

ListDeploymentsWithContext is the same as ListDeployments with the addition of the ability to pass a context and additional request options.

See ListDeployments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListEffectiveDeployments 

func (c *GreengrassV2) ListEffectiveDeployments(input *ListEffectiveDeploymentsInput) (*ListEffectiveDeploymentsOutput, error)

ListEffectiveDeployments API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListEffectiveDeployments for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListEffectiveDeployments

func (*GreengrassV2) ListEffectiveDeploymentsPages 

func (c *GreengrassV2) ListEffectiveDeploymentsPages(input *ListEffectiveDeploymentsInput, fn func(*ListEffectiveDeploymentsOutput, bool) bool) error

ListEffectiveDeploymentsPages iterates over the pages of a ListEffectiveDeployments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEffectiveDeployments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEffectiveDeployments operation.
pageNum := 0
err := client.ListEffectiveDeploymentsPages(params,
    func(page *greengrassv2.ListEffectiveDeploymentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListEffectiveDeploymentsPagesWithContext 

func (c *GreengrassV2) ListEffectiveDeploymentsPagesWithContext(ctx aws.Context, input *ListEffectiveDeploymentsInput, fn func(*ListEffectiveDeploymentsOutput, bool) bool, opts ...request.Option) error

ListEffectiveDeploymentsPagesWithContext same as ListEffectiveDeploymentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListEffectiveDeploymentsRequest 

func (c *GreengrassV2) ListEffectiveDeploymentsRequest(input *ListEffectiveDeploymentsInput) (req *request.Request, output *ListEffectiveDeploymentsOutput)

ListEffectiveDeploymentsRequest generates a "aws/request.Request" representing the client's request for the ListEffectiveDeployments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEffectiveDeployments for more information on using the ListEffectiveDeployments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEffectiveDeploymentsRequest method.
req, resp := client.ListEffectiveDeploymentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListEffectiveDeployments

func (*GreengrassV2) ListEffectiveDeploymentsWithContext 

func (c *GreengrassV2) ListEffectiveDeploymentsWithContext(ctx aws.Context, input *ListEffectiveDeploymentsInput, opts ...request.Option) (*ListEffectiveDeploymentsOutput, error)

ListEffectiveDeploymentsWithContext is the same as ListEffectiveDeployments with the addition of the ability to pass a context and additional request options.

See ListEffectiveDeployments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListInstalledComponents 

func (c *GreengrassV2) ListInstalledComponents(input *ListInstalledComponentsInput) (*ListInstalledComponentsOutput, error)

ListInstalledComponents API operation for AWS IoT Greengrass V2.

Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListInstalledComponents for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource can't be found.

  • AccessDeniedException You don't have permission to perform the action.

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

  • ThrottlingException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListInstalledComponents

func (*GreengrassV2) ListInstalledComponentsPages 

func (c *GreengrassV2) ListInstalledComponentsPages(input *ListInstalledComponentsInput, fn func(*ListInstalledComponentsOutput, bool) bool) error

ListInstalledComponentsPages iterates over the pages of a ListInstalledComponents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListInstalledComponents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListInstalledComponents operation.
pageNum := 0
err := client.ListInstalledComponentsPages(params,
    func(page *greengrassv2.ListInstalledComponentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*GreengrassV2) ListInstalledComponentsPagesWithContext 

func (c *GreengrassV2) ListInstalledComponentsPagesWithContext(ctx aws.Context, input *ListInstalledComponentsInput, fn func(*ListInstalledComponentsOutput, bool) bool, opts ...request.Option) error

ListInstalledComponentsPagesWithContext same as ListInstalledComponentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListInstalledComponentsRequest 

func (c *GreengrassV2) ListInstalledComponentsRequest(input *ListInstalledComponentsInput) (req *request.Request, output *ListInstalledComponentsOutput)

ListInstalledComponentsRequest generates a "aws/request.Request" representing the client's request for the ListInstalledComponents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListInstalledComponents for more information on using the ListInstalledComponents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListInstalledComponentsRequest method.
req, resp := client.ListInstalledComponentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListInstalledComponents

func (*GreengrassV2) ListInstalledComponentsWithContext 

func (c *GreengrassV2) ListInstalledComponentsWithContext(ctx aws.Context, input *ListInstalledComponentsInput, opts ...request.Option) (*ListInstalledComponentsOutput, error)

ListInstalledComponentsWithContext is the same as ListInstalledComponents with the addition of the ability to pass a context and additional request options.

See ListInstalledComponents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ListTagsForResource 

func (c *GreengrassV2) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT Greengrass V2.

Retrieves the list of tags for an IoT Greengrass resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

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

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListTagsForResource

func (*GreengrassV2) ListTagsForResourceRequest 

func (c *GreengrassV2) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListTagsForResource

func (*GreengrassV2) ListTagsForResourceWithContext 

func (c *GreengrassV2) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) ResolveComponentCandidates 

func (c *GreengrassV2) ResolveComponentCandidates(input *ResolveComponentCandidatesInput) (*ResolveComponentCandidatesOutput, error)

ResolveComponentCandidates API operation for AWS IoT Greengrass V2.

Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.

This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.

When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.

To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see IoT Greengrass endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/greengrass.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation ResolveComponentCandidates for usage and error information.

Returned Error Types:

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

  • AccessDeniedException You don't have permission to perform the action.

  • ResourceNotFoundException The requested resource can't be found.

  • ConflictException 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.

  • ThrottlingException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ResolveComponentCandidates

func (*GreengrassV2) ResolveComponentCandidatesRequest 

func (c *GreengrassV2) ResolveComponentCandidatesRequest(input *ResolveComponentCandidatesInput) (req *request.Request, output *ResolveComponentCandidatesOutput)

ResolveComponentCandidatesRequest generates a "aws/request.Request" representing the client's request for the ResolveComponentCandidates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResolveComponentCandidates for more information on using the ResolveComponentCandidates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ResolveComponentCandidatesRequest method.
req, resp := client.ResolveComponentCandidatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ResolveComponentCandidates

func (*GreengrassV2) ResolveComponentCandidatesWithContext 

func (c *GreengrassV2) ResolveComponentCandidatesWithContext(ctx aws.Context, input *ResolveComponentCandidatesInput, opts ...request.Option) (*ResolveComponentCandidatesOutput, error)

ResolveComponentCandidatesWithContext is the same as ResolveComponentCandidates with the addition of the ability to pass a context and additional request options.

See ResolveComponentCandidates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) TagResource 

func (c *GreengrassV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT Greengrass V2.

Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation TagResource for usage and error information.

Returned Error Types:

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

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

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/TagResource

func (*GreengrassV2) TagResourceRequest 

func (c *GreengrassV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/TagResource

func (*GreengrassV2) TagResourceWithContext 

func (c *GreengrassV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) UntagResource 

func (c *GreengrassV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT Greengrass V2.

Removes a tag from an IoT Greengrass resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation UntagResource for usage and error information.

Returned Error Types:

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

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

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/UntagResource

func (*GreengrassV2) UntagResourceRequest 

func (c *GreengrassV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/UntagResource

func (*GreengrassV2) UntagResourceWithContext 

func (c *GreengrassV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GreengrassV2) UpdateConnectivityInfo added in v1.42.26 

func (c *GreengrassV2) UpdateConnectivityInfo(input *UpdateConnectivityInfoInput) (*UpdateConnectivityInfoOutput, error)

UpdateConnectivityInfo API operation for AWS IoT Greengrass V2.

Updates connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API (https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html), IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices (https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html) in the IoT Greengrass Version 2 Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Greengrass V2's API operation UpdateConnectivityInfo for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/UpdateConnectivityInfo

func (*GreengrassV2) UpdateConnectivityInfoRequest added in v1.42.26 

func (c *GreengrassV2) UpdateConnectivityInfoRequest(input *UpdateConnectivityInfoInput) (req *request.Request, output *UpdateConnectivityInfoOutput)

UpdateConnectivityInfoRequest generates a "aws/request.Request" representing the client's request for the UpdateConnectivityInfo operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConnectivityInfo for more information on using the UpdateConnectivityInfo API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateConnectivityInfoRequest method.
req, resp := client.UpdateConnectivityInfoRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/UpdateConnectivityInfo

func (*GreengrassV2) UpdateConnectivityInfoWithContext added in v1.42.26 

func (c *GreengrassV2) UpdateConnectivityInfoWithContext(ctx aws.Context, input *UpdateConnectivityInfoInput, opts ...request.Option) (*UpdateConnectivityInfoOutput, error)

UpdateConnectivityInfoWithContext is the same as UpdateConnectivityInfo with the addition of the ability to pass a context and additional request options.

See UpdateConnectivityInfo for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type InstalledComponent 

type InstalledComponent struct {

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"string"`

	// Whether or not the component is a root component.
	IsRoot *bool `locationName:"isRoot" type:"boolean"`

	// 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 ID of the last deployment that contained the component. 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 `locationName:"lastInstallationSource" min:"1" type:"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 `locationName:"lastReportedTimestamp" type:"timestamp"`

	// 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 `locationName:"lastStatusChangeTimestamp" type:"timestamp"`

	// The lifecycle state of the component.
	LifecycleState *string `locationName:"lifecycleState" type:"string" enum:"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 `locationName:"lifecycleStateDetails" min:"1" type:"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 `locationName:"lifecycleStatusCodes" type:"list"`
	// contains filtered or unexported fields
}

Contains information about a component on a Greengrass core device.

func (InstalledComponent) GoString 

func (s InstalledComponent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstalledComponent) SetComponentName 

func (s *InstalledComponent) SetComponentName(v string) *InstalledComponent

SetComponentName sets the ComponentName field's value.

func (*InstalledComponent) SetComponentVersion 

func (s *InstalledComponent) SetComponentVersion(v string) *InstalledComponent

SetComponentVersion sets the ComponentVersion field's value.

func (*InstalledComponent) SetIsRoot 

func (s *InstalledComponent) SetIsRoot(v bool) *InstalledComponent

SetIsRoot sets the IsRoot field's value.

func (*InstalledComponent) SetLastInstallationSource added in v1.44.114 

func (s *InstalledComponent) SetLastInstallationSource(v string) *InstalledComponent

SetLastInstallationSource sets the LastInstallationSource field's value.

func (*InstalledComponent) SetLastReportedTimestamp added in v1.44.114 

func (s *InstalledComponent) SetLastReportedTimestamp(v time.Time) *InstalledComponent

SetLastReportedTimestamp sets the LastReportedTimestamp field's value.

func (*InstalledComponent) SetLastStatusChangeTimestamp added in v1.44.88 

func (s *InstalledComponent) SetLastStatusChangeTimestamp(v time.Time) *InstalledComponent

SetLastStatusChangeTimestamp sets the LastStatusChangeTimestamp field's value.

func (*InstalledComponent) SetLifecycleState 

func (s *InstalledComponent) SetLifecycleState(v string) *InstalledComponent

SetLifecycleState sets the LifecycleState field's value.

func (*InstalledComponent) SetLifecycleStateDetails 

func (s *InstalledComponent) SetLifecycleStateDetails(v string) *InstalledComponent

SetLifecycleStateDetails sets the LifecycleStateDetails field's value.

func (*InstalledComponent) SetLifecycleStatusCodes added in v1.44.114 

func (s *InstalledComponent) SetLifecycleStatusCodes(v []*string) *InstalledComponent

SetLifecycleStatusCodes sets the LifecycleStatusCodes field's value.

func (InstalledComponent) String 

func (s InstalledComponent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The amount of time to wait before you retry the request.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTJobAbortConfig 

type IoTJobAbortConfig struct {

	// The list of criteria that define when and how to cancel the configuration
	// deployment.
	//
	// CriteriaList is a required field
	CriteriaList []*IoTJobAbortCriteria `locationName:"criteriaList" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (IoTJobAbortConfig) GoString 

func (s IoTJobAbortConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobAbortConfig) SetCriteriaList 

func (s *IoTJobAbortConfig) SetCriteriaList(v []*IoTJobAbortCriteria) *IoTJobAbortConfig

SetCriteriaList sets the CriteriaList field's value.

func (IoTJobAbortConfig) String 

func (s IoTJobAbortConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobAbortConfig) Validate 

func (s *IoTJobAbortConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IoTJobAbortCriteria 

type IoTJobAbortCriteria struct {

	// The action to perform when the criteria are met.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"IoTJobAbortAction"`

	// The type of job deployment failure that can cancel a job.
	//
	// FailureType is a required field
	FailureType *string `locationName:"failureType" type:"string" required:"true" enum:"IoTJobExecutionFailureType"`

	// The minimum number of things that receive the configuration before the job
	// can cancel.
	//
	// MinNumberOfExecutedThings is a required field
	MinNumberOfExecutedThings *int64 `locationName:"minNumberOfExecutedThings" min:"1" type:"integer" required:"true"`

	// 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).
	//
	// ThresholdPercentage is a required field
	ThresholdPercentage *float64 `locationName:"thresholdPercentage" type:"double" required:"true"`
	// 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.

func (IoTJobAbortCriteria) GoString 

func (s IoTJobAbortCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobAbortCriteria) SetAction 

func (s *IoTJobAbortCriteria) SetAction(v string) *IoTJobAbortCriteria

SetAction sets the Action field's value.

func (*IoTJobAbortCriteria) SetFailureType 

func (s *IoTJobAbortCriteria) SetFailureType(v string) *IoTJobAbortCriteria

SetFailureType sets the FailureType field's value.

func (*IoTJobAbortCriteria) SetMinNumberOfExecutedThings 

func (s *IoTJobAbortCriteria) SetMinNumberOfExecutedThings(v int64) *IoTJobAbortCriteria

SetMinNumberOfExecutedThings sets the MinNumberOfExecutedThings field's value.

func (*IoTJobAbortCriteria) SetThresholdPercentage 

func (s *IoTJobAbortCriteria) SetThresholdPercentage(v float64) *IoTJobAbortCriteria

SetThresholdPercentage sets the ThresholdPercentage field's value.

func (IoTJobAbortCriteria) String 

func (s IoTJobAbortCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobAbortCriteria) Validate 

func (s *IoTJobAbortCriteria) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IoTJobExecutionsRolloutConfig 

type IoTJobExecutionsRolloutConfig struct {

	// The exponential rate to increase the job rollout rate.
	ExponentialRate *IoTJobExponentialRolloutRate `locationName:"exponentialRate" type:"structure"`

	// The maximum number of devices that receive a pending job notification, per
	// minute.
	MaximumPerMinute *int64 `locationName:"maximumPerMinute" min:"1" type:"integer"`
	// 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.

func (IoTJobExecutionsRolloutConfig) GoString 

func (s IoTJobExecutionsRolloutConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobExecutionsRolloutConfig) SetExponentialRate 

func (s *IoTJobExecutionsRolloutConfig) SetExponentialRate(v *IoTJobExponentialRolloutRate) *IoTJobExecutionsRolloutConfig

SetExponentialRate sets the ExponentialRate field's value.

func (*IoTJobExecutionsRolloutConfig) SetMaximumPerMinute 

func (s *IoTJobExecutionsRolloutConfig) SetMaximumPerMinute(v int64) *IoTJobExecutionsRolloutConfig

SetMaximumPerMinute sets the MaximumPerMinute field's value.

func (IoTJobExecutionsRolloutConfig) String 

func (s IoTJobExecutionsRolloutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobExecutionsRolloutConfig) Validate 

func (s *IoTJobExecutionsRolloutConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// BaseRatePerMinute is a required field
	BaseRatePerMinute *int64 `locationName:"baseRatePerMinute" min:"1" type:"integer" required:"true"`

	// 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).
	//
	// IncrementFactor is a required field
	IncrementFactor *float64 `locationName:"incrementFactor" min:"1" type:"double" required:"true"`

	// The criteria to increase the rollout rate for the job.
	//
	// RateIncreaseCriteria is a required field
	RateIncreaseCriteria *IoTJobRateIncreaseCriteria `locationName:"rateIncreaseCriteria" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (IoTJobExponentialRolloutRate) GoString 

func (s IoTJobExponentialRolloutRate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobExponentialRolloutRate) SetBaseRatePerMinute 

func (s *IoTJobExponentialRolloutRate) SetBaseRatePerMinute(v int64) *IoTJobExponentialRolloutRate

SetBaseRatePerMinute sets the BaseRatePerMinute field's value.

func (*IoTJobExponentialRolloutRate) SetIncrementFactor 

func (s *IoTJobExponentialRolloutRate) SetIncrementFactor(v float64) *IoTJobExponentialRolloutRate

SetIncrementFactor sets the IncrementFactor field's value.

func (*IoTJobExponentialRolloutRate) SetRateIncreaseCriteria 

func (s *IoTJobExponentialRolloutRate) SetRateIncreaseCriteria(v *IoTJobRateIncreaseCriteria) *IoTJobExponentialRolloutRate

SetRateIncreaseCriteria sets the RateIncreaseCriteria field's value.

func (IoTJobExponentialRolloutRate) String 

func (s IoTJobExponentialRolloutRate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobExponentialRolloutRate) Validate 

func (s *IoTJobExponentialRolloutRate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IoTJobRateIncreaseCriteria 

type IoTJobRateIncreaseCriteria struct {

	// The number of devices to receive the job notification before the rollout
	// rate increases.
	NumberOfNotifiedThings *int64 `locationName:"numberOfNotifiedThings" min:"1" type:"integer"`

	// The number of devices to successfully run the configuration job before the
	// rollout rate increases.
	NumberOfSucceededThings *int64 `locationName:"numberOfSucceededThings" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

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

func (IoTJobRateIncreaseCriteria) GoString 

func (s IoTJobRateIncreaseCriteria) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobRateIncreaseCriteria) SetNumberOfNotifiedThings 

func (s *IoTJobRateIncreaseCriteria) SetNumberOfNotifiedThings(v int64) *IoTJobRateIncreaseCriteria

SetNumberOfNotifiedThings sets the NumberOfNotifiedThings field's value.

func (*IoTJobRateIncreaseCriteria) SetNumberOfSucceededThings 

func (s *IoTJobRateIncreaseCriteria) SetNumberOfSucceededThings(v int64) *IoTJobRateIncreaseCriteria

SetNumberOfSucceededThings sets the NumberOfSucceededThings field's value.

func (IoTJobRateIncreaseCriteria) String 

func (s IoTJobRateIncreaseCriteria) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobRateIncreaseCriteria) Validate 

func (s *IoTJobRateIncreaseCriteria) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"inProgressTimeoutInMinutes" type:"long"`
	// contains filtered or unexported fields
}

Contains information about the timeout configuration for a job.

func (IoTJobTimeoutConfig) GoString 

func (s IoTJobTimeoutConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IoTJobTimeoutConfig) SetInProgressTimeoutInMinutes 

func (s *IoTJobTimeoutConfig) SetInProgressTimeoutInMinutes(v int64) *IoTJobTimeoutConfig

SetInProgressTimeoutInMinutes sets the InProgressTimeoutInMinutes field's value.

func (IoTJobTimeoutConfig) String 

func (s IoTJobTimeoutConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LambdaContainerParams 

type LambdaContainerParams struct {

	// The list of system devices that the container can access.
	Devices []*LambdaDeviceMount `locationName:"devices" type:"list"`

	// The memory size of the container, expressed in kilobytes.
	//
	// Default: 16384 (16 MB)
	MemorySizeInKB *int64 `locationName:"memorySizeInKB" type:"integer"`

	// Whether or not the container can read information from the device's /sys
	// folder.
	//
	// Default: false
	MountROSysfs *bool `locationName:"mountROSysfs" type:"boolean"`

	// The list of volumes that the container can access.
	Volumes []*LambdaVolumeMount `locationName:"volumes" type:"list"`
	// contains filtered or unexported fields
}

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

func (LambdaContainerParams) GoString 

func (s LambdaContainerParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaContainerParams) SetDevices 

func (s *LambdaContainerParams) SetDevices(v []*LambdaDeviceMount) *LambdaContainerParams

SetDevices sets the Devices field's value.

func (*LambdaContainerParams) SetMemorySizeInKB 

func (s *LambdaContainerParams) SetMemorySizeInKB(v int64) *LambdaContainerParams

SetMemorySizeInKB sets the MemorySizeInKB field's value.

func (*LambdaContainerParams) SetMountROSysfs 

func (s *LambdaContainerParams) SetMountROSysfs(v bool) *LambdaContainerParams

SetMountROSysfs sets the MountROSysfs field's value.

func (*LambdaContainerParams) SetVolumes 

func (s *LambdaContainerParams) SetVolumes(v []*LambdaVolumeMount) *LambdaContainerParams

SetVolumes sets the Volumes field's value.

func (LambdaContainerParams) String 

func (s LambdaContainerParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaContainerParams) Validate 

func (s *LambdaContainerParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaDeviceMount 

type LambdaDeviceMount struct {

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

	// The mount path for the device in the file system.
	//
	// Path is a required field
	Path *string `locationName:"path" type:"string" required:"true"`

	// The permission to access the device: read/only (ro) or read/write (rw).
	//
	// Default: ro
	Permission *string `locationName:"permission" type:"string" enum:"LambdaFilesystemPermission"`
	// contains filtered or unexported fields
}

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

func (LambdaDeviceMount) GoString 

func (s LambdaDeviceMount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaDeviceMount) SetAddGroupOwner 

func (s *LambdaDeviceMount) SetAddGroupOwner(v bool) *LambdaDeviceMount

SetAddGroupOwner sets the AddGroupOwner field's value.

func (*LambdaDeviceMount) SetPath 

func (s *LambdaDeviceMount) SetPath(v string) *LambdaDeviceMount

SetPath sets the Path field's value.

func (*LambdaDeviceMount) SetPermission 

func (s *LambdaDeviceMount) SetPermission(v string) *LambdaDeviceMount

SetPermission sets the Permission field's value.

func (LambdaDeviceMount) String 

func (s LambdaDeviceMount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaDeviceMount) Validate 

func (s *LambdaDeviceMount) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaEventSource 

type LambdaEventSource struct {

	// The topic to which to subscribe to receive event messages.
	//
	// Topic is a required field
	Topic *string `locationName:"topic" type:"string" required:"true"`

	// 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.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"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.

func (LambdaEventSource) GoString 

func (s LambdaEventSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaEventSource) SetTopic 

func (s *LambdaEventSource) SetTopic(v string) *LambdaEventSource

SetTopic sets the Topic field's value.

func (*LambdaEventSource) SetType 

func (s *LambdaEventSource) SetType(v string) *LambdaEventSource

SetType sets the Type field's value.

func (LambdaEventSource) String 

func (s LambdaEventSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaEventSource) Validate 

func (s *LambdaEventSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaExecutionParameters 

type LambdaExecutionParameters struct {

	// The map of environment variables that are available to the Lambda function
	// when it runs.
	EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"`

	// 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 `locationName:"eventSources" type:"list"`

	// The list of arguments to pass to the Lambda function when it runs.
	ExecArgs []*string `locationName:"execArgs" type:"list"`

	// The encoding type that the Lambda function supports.
	//
	// Default: json
	InputPayloadEncodingType *string `locationName:"inputPayloadEncodingType" type:"string" enum:"LambdaInputPayloadEncodingType"`

	// The parameters for the Linux process that contains the Lambda function.
	LinuxProcessParams *LambdaLinuxProcessParams `locationName:"linuxProcessParams" type:"structure"`

	// 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 *int64 `locationName:"maxIdleTimeInSeconds" type:"integer"`

	// The maximum number of instances that a non-pinned Lambda function can run
	// at the same time.
	MaxInstancesCount *int64 `locationName:"maxInstancesCount" type:"integer"`

	// 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 *int64 `locationName:"maxQueueSize" type:"integer"`

	// 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 `locationName:"pinned" type:"boolean"`

	// 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 *int64 `locationName:"statusTimeoutInSeconds" type:"integer"`

	// The maximum amount of time in seconds that the Lambda function can process
	// a work item.
	TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"integer"`
	// contains filtered or unexported fields
}

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

func (LambdaExecutionParameters) GoString 

func (s LambdaExecutionParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaExecutionParameters) SetEnvironmentVariables 

func (s *LambdaExecutionParameters) SetEnvironmentVariables(v map[string]*string) *LambdaExecutionParameters

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*LambdaExecutionParameters) SetEventSources 

func (s *LambdaExecutionParameters) SetEventSources(v []*LambdaEventSource) *LambdaExecutionParameters

SetEventSources sets the EventSources field's value.

func (*LambdaExecutionParameters) SetExecArgs 

func (s *LambdaExecutionParameters) SetExecArgs(v []*string) *LambdaExecutionParameters

SetExecArgs sets the ExecArgs field's value.

func (*LambdaExecutionParameters) SetInputPayloadEncodingType 

func (s *LambdaExecutionParameters) SetInputPayloadEncodingType(v string) *LambdaExecutionParameters

SetInputPayloadEncodingType sets the InputPayloadEncodingType field's value.

func (*LambdaExecutionParameters) SetLinuxProcessParams 

func (s *LambdaExecutionParameters) SetLinuxProcessParams(v *LambdaLinuxProcessParams) *LambdaExecutionParameters

SetLinuxProcessParams sets the LinuxProcessParams field's value.

func (*LambdaExecutionParameters) SetMaxIdleTimeInSeconds 

func (s *LambdaExecutionParameters) SetMaxIdleTimeInSeconds(v int64) *LambdaExecutionParameters

SetMaxIdleTimeInSeconds sets the MaxIdleTimeInSeconds field's value.

func (*LambdaExecutionParameters) SetMaxInstancesCount 

func (s *LambdaExecutionParameters) SetMaxInstancesCount(v int64) *LambdaExecutionParameters

SetMaxInstancesCount sets the MaxInstancesCount field's value.

func (*LambdaExecutionParameters) SetMaxQueueSize 

func (s *LambdaExecutionParameters) SetMaxQueueSize(v int64) *LambdaExecutionParameters

SetMaxQueueSize sets the MaxQueueSize field's value.

func (*LambdaExecutionParameters) SetPinned 

func (s *LambdaExecutionParameters) SetPinned(v bool) *LambdaExecutionParameters

SetPinned sets the Pinned field's value.

func (*LambdaExecutionParameters) SetStatusTimeoutInSeconds 

func (s *LambdaExecutionParameters) SetStatusTimeoutInSeconds(v int64) *LambdaExecutionParameters

SetStatusTimeoutInSeconds sets the StatusTimeoutInSeconds field's value.

func (*LambdaExecutionParameters) SetTimeoutInSeconds 

func (s *LambdaExecutionParameters) SetTimeoutInSeconds(v int64) *LambdaExecutionParameters

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (LambdaExecutionParameters) String 

func (s LambdaExecutionParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaExecutionParameters) Validate 

func (s *LambdaExecutionParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaFunctionRecipeSource 

type LambdaFunctionRecipeSource struct {

	// The component versions on which this Lambda function component depends.
	ComponentDependencies map[string]*ComponentDependencyRequirement `locationName:"componentDependencies" type:"map"`

	// The system and runtime parameters for the Lambda function as it runs on the
	// Greengrass core device.
	ComponentLambdaParameters *LambdaExecutionParameters `locationName:"componentLambdaParameters" type:"structure"`

	// The name of the component.
	//
	// Defaults to the name of the Lambda function.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The platforms that the component version supports.
	ComponentPlatforms []*ComponentPlatform `locationName:"componentPlatforms" type:"list"`

	// 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 `locationName:"componentVersion" min:"1" type:"string"`

	// 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.
	//
	// LambdaArn is a required field
	LambdaArn *string `locationName:"lambdaArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (LambdaFunctionRecipeSource) GoString 

func (s LambdaFunctionRecipeSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunctionRecipeSource) SetComponentDependencies 

func (s *LambdaFunctionRecipeSource) SetComponentDependencies(v map[string]*ComponentDependencyRequirement) *LambdaFunctionRecipeSource

SetComponentDependencies sets the ComponentDependencies field's value.

func (*LambdaFunctionRecipeSource) SetComponentLambdaParameters 

func (s *LambdaFunctionRecipeSource) SetComponentLambdaParameters(v *LambdaExecutionParameters) *LambdaFunctionRecipeSource

SetComponentLambdaParameters sets the ComponentLambdaParameters field's value.

func (*LambdaFunctionRecipeSource) SetComponentName 

func (s *LambdaFunctionRecipeSource) SetComponentName(v string) *LambdaFunctionRecipeSource

SetComponentName sets the ComponentName field's value.

func (*LambdaFunctionRecipeSource) SetComponentPlatforms 

func (s *LambdaFunctionRecipeSource) SetComponentPlatforms(v []*ComponentPlatform) *LambdaFunctionRecipeSource

SetComponentPlatforms sets the ComponentPlatforms field's value.

func (*LambdaFunctionRecipeSource) SetComponentVersion 

func (s *LambdaFunctionRecipeSource) SetComponentVersion(v string) *LambdaFunctionRecipeSource

SetComponentVersion sets the ComponentVersion field's value.

func (*LambdaFunctionRecipeSource) SetLambdaArn 

func (s *LambdaFunctionRecipeSource) SetLambdaArn(v string) *LambdaFunctionRecipeSource

SetLambdaArn sets the LambdaArn field's value.

func (LambdaFunctionRecipeSource) String 

func (s LambdaFunctionRecipeSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaFunctionRecipeSource) Validate 

func (s *LambdaFunctionRecipeSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaLinuxProcessParams 

type LambdaLinuxProcessParams struct {

	// The parameters for the container in which the Lambda function runs.
	ContainerParams *LambdaContainerParams `locationName:"containerParams" type:"structure"`

	// 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 *string `locationName:"isolationMode" type:"string" enum:"LambdaIsolationMode"`
	// contains filtered or unexported fields
}

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

func (LambdaLinuxProcessParams) GoString 

func (s LambdaLinuxProcessParams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaLinuxProcessParams) SetContainerParams 

func (s *LambdaLinuxProcessParams) SetContainerParams(v *LambdaContainerParams) *LambdaLinuxProcessParams

SetContainerParams sets the ContainerParams field's value.

func (*LambdaLinuxProcessParams) SetIsolationMode 

func (s *LambdaLinuxProcessParams) SetIsolationMode(v string) *LambdaLinuxProcessParams

SetIsolationMode sets the IsolationMode field's value.

func (LambdaLinuxProcessParams) String 

func (s LambdaLinuxProcessParams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaLinuxProcessParams) Validate 

func (s *LambdaLinuxProcessParams) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LambdaVolumeMount 

type LambdaVolumeMount struct {

	// Whether or not to add the IoT Greengrass user group as an owner of the volume.
	//
	// Default: false
	AddGroupOwner *bool `locationName:"addGroupOwner" type:"boolean"`

	// The path to the logical volume in the file system.
	//
	// DestinationPath is a required field
	DestinationPath *string `locationName:"destinationPath" type:"string" required:"true"`

	// The permission to access the volume: read/only (ro) or read/write (rw).
	//
	// Default: ro
	Permission *string `locationName:"permission" type:"string" enum:"LambdaFilesystemPermission"`

	// The path to the physical volume in the file system.
	//
	// SourcePath is a required field
	SourcePath *string `locationName:"sourcePath" type:"string" required:"true"`
	// 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.

func (LambdaVolumeMount) GoString 

func (s LambdaVolumeMount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaVolumeMount) SetAddGroupOwner 

func (s *LambdaVolumeMount) SetAddGroupOwner(v bool) *LambdaVolumeMount

SetAddGroupOwner sets the AddGroupOwner field's value.

func (*LambdaVolumeMount) SetDestinationPath 

func (s *LambdaVolumeMount) SetDestinationPath(v string) *LambdaVolumeMount

SetDestinationPath sets the DestinationPath field's value.

func (*LambdaVolumeMount) SetPermission 

func (s *LambdaVolumeMount) SetPermission(v string) *LambdaVolumeMount

SetPermission sets the Permission field's value.

func (*LambdaVolumeMount) SetSourcePath 

func (s *LambdaVolumeMount) SetSourcePath(v string) *LambdaVolumeMount

SetSourcePath sets the SourcePath field's value.

func (LambdaVolumeMount) String 

func (s LambdaVolumeMount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaVolumeMount) Validate 

func (s *LambdaVolumeMount) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClientDevicesAssociatedWithCoreDeviceInput added in v1.38.61 

type ListClientDevicesAssociatedWithCoreDeviceInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClientDevicesAssociatedWithCoreDeviceInput) GoString added in v1.38.61 

func (s ListClientDevicesAssociatedWithCoreDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClientDevicesAssociatedWithCoreDeviceInput) SetCoreDeviceThingName added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceInput) SetCoreDeviceThingName(v string) *ListClientDevicesAssociatedWithCoreDeviceInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*ListClientDevicesAssociatedWithCoreDeviceInput) SetMaxResults added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceInput) SetMaxResults(v int64) *ListClientDevicesAssociatedWithCoreDeviceInput

SetMaxResults sets the MaxResults field's value.

func (*ListClientDevicesAssociatedWithCoreDeviceInput) SetNextToken added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceInput) SetNextToken(v string) *ListClientDevicesAssociatedWithCoreDeviceInput

SetNextToken sets the NextToken field's value.

func (ListClientDevicesAssociatedWithCoreDeviceInput) String added in v1.38.61 

func (s ListClientDevicesAssociatedWithCoreDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClientDevicesAssociatedWithCoreDeviceInput) Validate added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClientDevicesAssociatedWithCoreDeviceOutput added in v1.38.61 

type ListClientDevicesAssociatedWithCoreDeviceOutput struct {

	// A list that describes the client devices that are associated with the core
	// device.
	AssociatedClientDevices []*AssociatedClientDevice `locationName:"associatedClientDevices" min:"1" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClientDevicesAssociatedWithCoreDeviceOutput) GoString added in v1.38.61 

func (s ListClientDevicesAssociatedWithCoreDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClientDevicesAssociatedWithCoreDeviceOutput) SetAssociatedClientDevices added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceOutput) SetAssociatedClientDevices(v []*AssociatedClientDevice) *ListClientDevicesAssociatedWithCoreDeviceOutput

SetAssociatedClientDevices sets the AssociatedClientDevices field's value.

func (*ListClientDevicesAssociatedWithCoreDeviceOutput) SetNextToken added in v1.38.61 

func (s *ListClientDevicesAssociatedWithCoreDeviceOutput) SetNextToken(v string) *ListClientDevicesAssociatedWithCoreDeviceOutput

SetNextToken sets the NextToken field's value.

func (ListClientDevicesAssociatedWithCoreDeviceOutput) String added in v1.38.61 

func (s ListClientDevicesAssociatedWithCoreDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListComponentVersionsInput 

type ListComponentVersionsInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the component.
	//
	// Arn is a required field
	Arn *string `location:"uri" locationName:"arn" type:"string" required:"true"`

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListComponentVersionsInput) GoString 

func (s ListComponentVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentVersionsInput) SetArn 

func (s *ListComponentVersionsInput) SetArn(v string) *ListComponentVersionsInput

SetArn sets the Arn field's value.

func (*ListComponentVersionsInput) SetMaxResults 

func (s *ListComponentVersionsInput) SetMaxResults(v int64) *ListComponentVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListComponentVersionsInput) SetNextToken 

func (s *ListComponentVersionsInput) SetNextToken(v string) *ListComponentVersionsInput

SetNextToken sets the NextToken field's value.

func (ListComponentVersionsInput) String 

func (s ListComponentVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentVersionsInput) Validate 

func (s *ListComponentVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentVersionsOutput 

type ListComponentVersionsOutput struct {

	// A list of versions that exist for the component.
	ComponentVersions []*ComponentVersionListItem `locationName:"componentVersions" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListComponentVersionsOutput) GoString 

func (s ListComponentVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentVersionsOutput) SetComponentVersions 

func (s *ListComponentVersionsOutput) SetComponentVersions(v []*ComponentVersionListItem) *ListComponentVersionsOutput

SetComponentVersions sets the ComponentVersions field's value.

func (*ListComponentVersionsOutput) SetNextToken 

func (s *ListComponentVersionsOutput) SetNextToken(v string) *ListComponentVersionsOutput

SetNextToken sets the NextToken field's value.

func (ListComponentVersionsOutput) String 

func (s ListComponentVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListComponentsInput 

type ListComponentsInput struct {

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The scope of the components to list.
	//
	// Default: PRIVATE
	Scope *string `location:"querystring" locationName:"scope" type:"string" enum:"ComponentVisibilityScope"`
	// contains filtered or unexported fields
}

func (ListComponentsInput) GoString 

func (s ListComponentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsInput) SetMaxResults 

func (s *ListComponentsInput) SetMaxResults(v int64) *ListComponentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListComponentsInput) SetNextToken 

func (s *ListComponentsInput) SetNextToken(v string) *ListComponentsInput

SetNextToken sets the NextToken field's value.

func (*ListComponentsInput) SetScope 

func (s *ListComponentsInput) SetScope(v string) *ListComponentsInput

SetScope sets the Scope field's value.

func (ListComponentsInput) String 

func (s ListComponentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsInput) Validate 

func (s *ListComponentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComponentsOutput 

type ListComponentsOutput struct {

	// A list that summarizes each component.
	Components []*Component `locationName:"components" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListComponentsOutput) GoString 

func (s ListComponentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListComponentsOutput) SetComponents 

func (s *ListComponentsOutput) SetComponents(v []*Component) *ListComponentsOutput

SetComponents sets the Components field's value.

func (*ListComponentsOutput) SetNextToken 

func (s *ListComponentsOutput) SetNextToken(v string) *ListComponentsOutput

SetNextToken sets the NextToken field's value.

func (ListComponentsOutput) String 

func (s ListComponentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCoreDevicesInput 

type ListCoreDevicesInput struct {

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The core device status by which to filter. If you specify this parameter,
	// the list includes only core devices that have this status. Choose one of
	// the following options:
	//
	//    * 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 *string `location:"querystring" locationName:"status" type:"string" enum:"CoreDeviceStatus"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the IoT thing group by which to filter. If you specify this parameter,
	// the list includes only core devices that have successfully deployed a deployment
	// that targets the thing group. When you remove a core device from a thing
	// group, the list continues to include that core device.
	ThingGroupArn *string `location:"querystring" locationName:"thingGroupArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListCoreDevicesInput) GoString 

func (s ListCoreDevicesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCoreDevicesInput) SetMaxResults 

func (s *ListCoreDevicesInput) SetMaxResults(v int64) *ListCoreDevicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListCoreDevicesInput) SetNextToken 

func (s *ListCoreDevicesInput) SetNextToken(v string) *ListCoreDevicesInput

SetNextToken sets the NextToken field's value.

func (*ListCoreDevicesInput) SetStatus 

func (s *ListCoreDevicesInput) SetStatus(v string) *ListCoreDevicesInput

SetStatus sets the Status field's value.

func (*ListCoreDevicesInput) SetThingGroupArn 

func (s *ListCoreDevicesInput) SetThingGroupArn(v string) *ListCoreDevicesInput

SetThingGroupArn sets the ThingGroupArn field's value.

func (ListCoreDevicesInput) String 

func (s ListCoreDevicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCoreDevicesInput) Validate 

func (s *ListCoreDevicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCoreDevicesOutput 

type ListCoreDevicesOutput struct {

	// A list that summarizes each core device.
	CoreDevices []*CoreDevice `locationName:"coreDevices" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCoreDevicesOutput) GoString 

func (s ListCoreDevicesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCoreDevicesOutput) SetCoreDevices 

func (s *ListCoreDevicesOutput) SetCoreDevices(v []*CoreDevice) *ListCoreDevicesOutput

SetCoreDevices sets the CoreDevices field's value.

func (*ListCoreDevicesOutput) SetNextToken 

func (s *ListCoreDevicesOutput) SetNextToken(v string) *ListCoreDevicesOutput

SetNextToken sets the NextToken field's value.

func (ListCoreDevicesOutput) String 

func (s ListCoreDevicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDeploymentsInput 

type ListDeploymentsInput struct {

	// The filter for the list of deployments. Choose one of the following options:
	//
	//    * ALL – The list includes all deployments.
	//
	//    * LATEST_ONLY – The list includes only the latest revision of each deployment.
	//
	// Default: LATEST_ONLY
	HistoryFilter *string `location:"querystring" locationName:"historyFilter" type:"string" enum:"DeploymentHistoryFilter"`

	// The maximum number of results to be returned per paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

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

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the target IoT thing or thing group.
	TargetArn *string `location:"querystring" locationName:"targetArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentsInput) GoString 

func (s ListDeploymentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsInput) SetHistoryFilter 

func (s *ListDeploymentsInput) SetHistoryFilter(v string) *ListDeploymentsInput

SetHistoryFilter sets the HistoryFilter field's value.

func (*ListDeploymentsInput) SetMaxResults 

func (s *ListDeploymentsInput) SetMaxResults(v int64) *ListDeploymentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDeploymentsInput) SetNextToken 

func (s *ListDeploymentsInput) SetNextToken(v string) *ListDeploymentsInput

SetNextToken sets the NextToken field's value.

func (*ListDeploymentsInput) SetParentTargetArn added in v1.44.138 

func (s *ListDeploymentsInput) SetParentTargetArn(v string) *ListDeploymentsInput

SetParentTargetArn sets the ParentTargetArn field's value.

func (*ListDeploymentsInput) SetTargetArn 

func (s *ListDeploymentsInput) SetTargetArn(v string) *ListDeploymentsInput

SetTargetArn sets the TargetArn field's value.

func (ListDeploymentsInput) String 

func (s ListDeploymentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsInput) Validate 

func (s *ListDeploymentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDeploymentsOutput 

type ListDeploymentsOutput struct {

	// A list that summarizes each deployment.
	Deployments []*Deployment `locationName:"deployments" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeploymentsOutput) GoString 

func (s ListDeploymentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDeploymentsOutput) SetDeployments 

func (s *ListDeploymentsOutput) SetDeployments(v []*Deployment) *ListDeploymentsOutput

SetDeployments sets the Deployments field's value.

func (*ListDeploymentsOutput) SetNextToken 

func (s *ListDeploymentsOutput) SetNextToken(v string) *ListDeploymentsOutput

SetNextToken sets the NextToken field's value.

func (ListDeploymentsOutput) String 

func (s ListDeploymentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEffectiveDeploymentsInput 

type ListEffectiveDeploymentsInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEffectiveDeploymentsInput) GoString 

func (s ListEffectiveDeploymentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEffectiveDeploymentsInput) SetCoreDeviceThingName 

func (s *ListEffectiveDeploymentsInput) SetCoreDeviceThingName(v string) *ListEffectiveDeploymentsInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*ListEffectiveDeploymentsInput) SetMaxResults 

func (s *ListEffectiveDeploymentsInput) SetMaxResults(v int64) *ListEffectiveDeploymentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEffectiveDeploymentsInput) SetNextToken 

func (s *ListEffectiveDeploymentsInput) SetNextToken(v string) *ListEffectiveDeploymentsInput

SetNextToken sets the NextToken field's value.

func (ListEffectiveDeploymentsInput) String 

func (s ListEffectiveDeploymentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEffectiveDeploymentsInput) Validate 

func (s *ListEffectiveDeploymentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEffectiveDeploymentsOutput 

type ListEffectiveDeploymentsOutput struct {

	// A list that summarizes each deployment on the core device.
	EffectiveDeployments []*EffectiveDeployment `locationName:"effectiveDeployments" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEffectiveDeploymentsOutput) GoString 

func (s ListEffectiveDeploymentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEffectiveDeploymentsOutput) SetEffectiveDeployments 

func (s *ListEffectiveDeploymentsOutput) SetEffectiveDeployments(v []*EffectiveDeployment) *ListEffectiveDeploymentsOutput

SetEffectiveDeployments sets the EffectiveDeployments field's value.

func (*ListEffectiveDeploymentsOutput) SetNextToken 

func (s *ListEffectiveDeploymentsOutput) SetNextToken(v string) *ListEffectiveDeploymentsOutput

SetNextToken sets the NextToken field's value.

func (ListEffectiveDeploymentsOutput) String 

func (s ListEffectiveDeploymentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInstalledComponentsInput 

type ListInstalledComponentsInput struct {

	// The name of the core device. This is also the name of the IoT thing.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `location:"uri" locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`

	// The maximum number of results to be returned per paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The filter for the list of components. Choose from the following options:
	//
	//    * ALL – The list includes all components installed on the core device.
	//
	//    * ROOT – The list includes only root components, which are components
	//    that you specify in a deployment. When you choose this option, the list
	//    doesn't include components that the core device installs as dependencies
	//    of other components.
	//
	// Default: ROOT
	TopologyFilter *string `location:"querystring" locationName:"topologyFilter" type:"string" enum:"InstalledComponentTopologyFilter"`
	// contains filtered or unexported fields
}

func (ListInstalledComponentsInput) GoString 

func (s ListInstalledComponentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstalledComponentsInput) SetCoreDeviceThingName 

func (s *ListInstalledComponentsInput) SetCoreDeviceThingName(v string) *ListInstalledComponentsInput

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (*ListInstalledComponentsInput) SetMaxResults 

func (s *ListInstalledComponentsInput) SetMaxResults(v int64) *ListInstalledComponentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListInstalledComponentsInput) SetNextToken 

func (s *ListInstalledComponentsInput) SetNextToken(v string) *ListInstalledComponentsInput

SetNextToken sets the NextToken field's value.

func (*ListInstalledComponentsInput) SetTopologyFilter added in v1.44.88 

func (s *ListInstalledComponentsInput) SetTopologyFilter(v string) *ListInstalledComponentsInput

SetTopologyFilter sets the TopologyFilter field's value.

func (ListInstalledComponentsInput) String 

func (s ListInstalledComponentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstalledComponentsInput) Validate 

func (s *ListInstalledComponentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListInstalledComponentsOutput 

type ListInstalledComponentsOutput struct {

	// A list that summarizes each component on the core device.
	//
	// Greengrass nucleus v2.7.0 or later is required to get an accurate lastStatusChangeTimestamp
	// response. This response can be inaccurate in earlier Greengrass nucleus versions.
	//
	// Greengrass nucleus v2.8.0 or later is required to get an accurate lastInstallationSource
	// and lastReportedTimestamp response. This response can be inaccurate or null
	// in earlier Greengrass nucleus versions.
	InstalledComponents []*InstalledComponent `locationName:"installedComponents" type:"list"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInstalledComponentsOutput) GoString 

func (s ListInstalledComponentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInstalledComponentsOutput) SetInstalledComponents 

func (s *ListInstalledComponentsOutput) SetInstalledComponents(v []*InstalledComponent) *ListInstalledComponentsOutput

SetInstalledComponents sets the InstalledComponents field's value.

func (*ListInstalledComponentsOutput) SetNextToken 

func (s *ListInstalledComponentsOutput) SetNextToken(v string) *ListInstalledComponentsOutput

SetNextToken sets the NextToken field's value.

func (ListInstalledComponentsOutput) String 

func (s ListInstalledComponentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestAlreadyInProgressException added in v1.40.13 

type RequestAlreadyInProgressException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code added in v1.40.13 

func (s *RequestAlreadyInProgressException) Code() string

Code returns the exception type name.

func (*RequestAlreadyInProgressException) Error added in v1.40.13 

func (s *RequestAlreadyInProgressException) Error() string

func (RequestAlreadyInProgressException) GoString added in v1.40.13 

func (s RequestAlreadyInProgressException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestAlreadyInProgressException) Message added in v1.40.13 

func (s *RequestAlreadyInProgressException) Message() string

Message returns the exception's message.

func (*RequestAlreadyInProgressException) OrigErr added in v1.40.13 

func (s *RequestAlreadyInProgressException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestAlreadyInProgressException) RequestID added in v1.40.13 

func (s *RequestAlreadyInProgressException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestAlreadyInProgressException) StatusCode added in v1.40.13 

func (s *RequestAlreadyInProgressException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestAlreadyInProgressException) String added in v1.40.13 

func (s RequestAlreadyInProgressException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResolveComponentCandidatesInput 

type ResolveComponentCandidatesInput struct {

	// The list of components to resolve.
	ComponentCandidates []*ComponentCandidate `locationName:"componentCandidates" type:"list"`

	// The platform to use to resolve compatible components.
	Platform *ComponentPlatform `locationName:"platform" type:"structure"`
	// contains filtered or unexported fields
}

func (ResolveComponentCandidatesInput) GoString 

func (s ResolveComponentCandidatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveComponentCandidatesInput) SetComponentCandidates 

func (s *ResolveComponentCandidatesInput) SetComponentCandidates(v []*ComponentCandidate) *ResolveComponentCandidatesInput

SetComponentCandidates sets the ComponentCandidates field's value.

func (*ResolveComponentCandidatesInput) SetPlatform 

func (s *ResolveComponentCandidatesInput) SetPlatform(v *ComponentPlatform) *ResolveComponentCandidatesInput

SetPlatform sets the Platform field's value.

func (ResolveComponentCandidatesInput) String 

func (s ResolveComponentCandidatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveComponentCandidatesInput) Validate 

func (s *ResolveComponentCandidatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResolveComponentCandidatesOutput 

type ResolveComponentCandidatesOutput struct {

	// A list of components that meet the requirements that you specify in the request.
	// This list includes each component's recipe that you can use to install the
	// component.
	ResolvedComponentVersions []*ResolvedComponentVersion `locationName:"resolvedComponentVersions" type:"list"`
	// contains filtered or unexported fields
}

func (ResolveComponentCandidatesOutput) GoString 

func (s ResolveComponentCandidatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolveComponentCandidatesOutput) SetResolvedComponentVersions 

func (s *ResolveComponentCandidatesOutput) SetResolvedComponentVersions(v []*ResolvedComponentVersion) *ResolveComponentCandidatesOutput

SetResolvedComponentVersions sets the ResolvedComponentVersions field's value.

func (ResolveComponentCandidatesOutput) String 

func (s ResolveComponentCandidatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"arn" type:"string"`

	// The name of the component.
	ComponentName *string `locationName:"componentName" min:"1" type:"string"`

	// The version of the component.
	ComponentVersion *string `locationName:"componentVersion" min:"1" type:"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 `locationName:"message" min:"1" type:"string"`

	// The recipe of the component version.
	// Recipe is automatically base64 encoded/decoded by the SDK.
	Recipe []byte `locationName:"recipe" type:"blob"`

	// 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 *string `locationName:"vendorGuidance" type:"string" enum:"VendorGuidance"`
	// contains filtered or unexported fields
}

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

func (ResolvedComponentVersion) GoString 

func (s ResolvedComponentVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResolvedComponentVersion) SetArn 

func (s *ResolvedComponentVersion) SetArn(v string) *ResolvedComponentVersion

SetArn sets the Arn field's value.

func (*ResolvedComponentVersion) SetComponentName 

func (s *ResolvedComponentVersion) SetComponentName(v string) *ResolvedComponentVersion

SetComponentName sets the ComponentName field's value.

func (*ResolvedComponentVersion) SetComponentVersion 

func (s *ResolvedComponentVersion) SetComponentVersion(v string) *ResolvedComponentVersion

SetComponentVersion sets the ComponentVersion field's value.

func (*ResolvedComponentVersion) SetMessage added in v1.44.17 

func (s *ResolvedComponentVersion) SetMessage(v string) *ResolvedComponentVersion

SetMessage sets the Message field's value.

func (*ResolvedComponentVersion) SetRecipe 

func (s *ResolvedComponentVersion) SetRecipe(v []byte) *ResolvedComponentVersion

SetRecipe sets the Recipe field's value.

func (*ResolvedComponentVersion) SetVendorGuidance added in v1.44.17 

func (s *ResolvedComponentVersion) SetVendorGuidance(v string) *ResolvedComponentVersion

SetVendorGuidance sets the VendorGuidance field's value.

func (ResolvedComponentVersion) String 

func (s ResolvedComponentVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that isn't found.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that isn't found.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The requested resource can't be found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The code for the quota in Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html).
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// The ID of the resource that exceeds the service quota.
	ResourceId *string `locationName:"resourceId" type:"string"`

	// The type of the resource that exceeds the service quota.
	ResourceType *string `locationName:"resourceType" type:"string"`

	// The code for the service in Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html).
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// 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) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SystemResourceLimits added in v1.40.13 

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 `locationName:"cpus" type:"double"`

	// The maximum amount of RAM, expressed in kilobytes, that a component's processes
	// can use on the core device.
	Memory *int64 `locationName:"memory" type:"long"`
	// 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).

func (SystemResourceLimits) GoString added in v1.40.13 

func (s SystemResourceLimits) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SystemResourceLimits) SetCpus added in v1.40.13 

func (s *SystemResourceLimits) SetCpus(v float64) *SystemResourceLimits

SetCpus sets the Cpus field's value.

func (*SystemResourceLimits) SetMemory added in v1.40.13 

func (s *SystemResourceLimits) SetMemory(v int64) *SystemResourceLimits

SetMemory sets the Memory field's value.

func (SystemResourceLimits) String added in v1.40.13 

func (s SystemResourceLimits) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tag your resources (https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)
	// in the IoT Greengrass V2 Developer Guide.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The code for the quota in Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html).
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// The amount of time to wait before you retry the request.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// The code for the service in Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html).
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// 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) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to untag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A list of keys for tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateConnectivityInfoInput added in v1.42.26 

type UpdateConnectivityInfoInput struct {

	// The connectivity information for the core device.
	//
	// ConnectivityInfo is a required field
	ConnectivityInfo []*ConnectivityInfo `locationName:"ConnectivityInfo" type:"list" required:"true"`

	// The name of the core device. This is also the name of the IoT thing.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateConnectivityInfoInput) GoString added in v1.42.26 

func (s UpdateConnectivityInfoInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectivityInfoInput) SetConnectivityInfo added in v1.42.26 

func (s *UpdateConnectivityInfoInput) SetConnectivityInfo(v []*ConnectivityInfo) *UpdateConnectivityInfoInput

SetConnectivityInfo sets the ConnectivityInfo field's value.

func (*UpdateConnectivityInfoInput) SetThingName added in v1.42.26 

func (s *UpdateConnectivityInfoInput) SetThingName(v string) *UpdateConnectivityInfoInput

SetThingName sets the ThingName field's value.

func (UpdateConnectivityInfoInput) String added in v1.42.26 

func (s UpdateConnectivityInfoInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectivityInfoInput) Validate added in v1.42.26 

func (s *UpdateConnectivityInfoInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectivityInfoOutput added in v1.42.26 

type UpdateConnectivityInfoOutput struct {

	// A message about the connectivity information update request.
	Message *string `locationName:"Message" type:"string"`

	// The new version of the connectivity information for the core device.
	Version *string `locationName:"Version" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateConnectivityInfoOutput) GoString added in v1.42.26 

func (s UpdateConnectivityInfoOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectivityInfoOutput) SetMessage added in v1.42.26 

func (s *UpdateConnectivityInfoOutput) SetMessage(v string) *UpdateConnectivityInfoOutput

SetMessage sets the Message field's value.

func (*UpdateConnectivityInfoOutput) SetVersion added in v1.42.26 

func (s *UpdateConnectivityInfoOutput) SetVersion(v string) *UpdateConnectivityInfoOutput

SetVersion sets the Version field's value.

func (UpdateConnectivityInfoOutput) String added in v1.42.26 

func (s UpdateConnectivityInfoOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The list of fields that failed to validate.
	Fields []*ValidationExceptionField `locationName:"fields" type:"list"`

	Message_ *string `locationName:"message" type:"string"`

	// The reason for the validation exception.
	Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField 

type ValidationExceptionField struct {

	// The message of the exception field.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the exception field.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a validation exception field.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package greengrassv2iface provides an interface to enable mocking the AWS IoT Greengrass V2 service client for testing your code.
 Package greengrassv2iface provides an interface to enable mocking the AWS IoT Greengrass V2 service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.