sagemakeredgemanager

package
v1.0.3 Latest Latest
Warning

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

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

Documentation

Overview

Package sagemakeredgemanager provides the client and types for making API requests to Amazon Sagemaker Edge Manager.

SageMaker Edge Manager dataplane service for communicating with active agents.

See https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23 for more information on this service.

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

Using the Client

To contact Amazon Sagemaker Edge Manager 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 Amazon Sagemaker Edge Manager client SagemakerEdgeManager for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakeredgemanager/#New

Index

Constants

View Source 
const (
	// DeploymentStatusSuccess is a DeploymentStatus enum value
	DeploymentStatusSuccess = "SUCCESS"

	// DeploymentStatusFail is a DeploymentStatus enum value
	DeploymentStatusFail = "FAIL"
)
View Source 
const (
	// FailureHandlingPolicyRollbackOnFailure is a FailureHandlingPolicy enum value
	FailureHandlingPolicyRollbackOnFailure = "ROLLBACK_ON_FAILURE"

	// FailureHandlingPolicyDoNothing is a FailureHandlingPolicy enum value
	FailureHandlingPolicyDoNothing = "DO_NOTHING"
)
View Source 
const (
	// ModelStateDeploy is a ModelState enum value
	ModelStateDeploy = "DEPLOY"

	// ModelStateUndeploy is a ModelState enum value
	ModelStateUndeploy = "UNDEPLOY"
)
View Source 
const (
	ServiceName = "Sagemaker Edge" // Name of service.
	EndpointsID = "edge.sagemaker" // ID to lookup a service endpoint with.
	ServiceID   = "Sagemaker Edge" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ChecksumTypeSha1 is a ChecksumType enum value
	ChecksumTypeSha1 = "SHA1"
)
View Source 
const (
	// DeploymentTypeModel is a DeploymentType enum value
	DeploymentTypeModel = "Model"
)
View Source 
const (

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// An internal failure occurred. Try your request again. If the problem persists,
	// contact Amazon Web Services customer support.
	ErrCodeInternalServiceException = "InternalServiceException"
)

Variables

This section is empty.

Functions

func ChecksumType_Values 

func ChecksumType_Values() []string

ChecksumType_Values returns all elements of the ChecksumType enum

func DeploymentStatus_Values 

func DeploymentStatus_Values() []string

DeploymentStatus_Values returns all elements of the DeploymentStatus enum

func DeploymentType_Values 

func DeploymentType_Values() []string

DeploymentType_Values returns all elements of the DeploymentType enum

func FailureHandlingPolicy_Values 

func FailureHandlingPolicy_Values() []string

FailureHandlingPolicy_Values returns all elements of the FailureHandlingPolicy enum

func ModelState_Values 

func ModelState_Values() []string

ModelState_Values returns all elements of the ModelState enum

Types

type Checksum 

type Checksum struct {

	// The checksum of the model.
	Sum *string `min:"1" type:"string"`

	// The type of the checksum.
	Type *string `type:"string" enum:"ChecksumType"`
	// contains filtered or unexported fields
}

Information about the checksum of a model deployed on a device.

func (Checksum) GoString 

func (s Checksum) 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 (*Checksum) SetSum 

func (s *Checksum) SetSum(v string) *Checksum

SetSum sets the Sum field's value.

func (*Checksum) SetType 

func (s *Checksum) SetType(v string) *Checksum

SetType sets the Type field's value.

func (Checksum) String 

func (s Checksum) 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 Definition 

type Definition struct {

	// The checksum information of the model.
	Checksum *Checksum `type:"structure"`

	// The unique model handle.
	ModelHandle *string `min:"1" type:"string"`

	// The absolute S3 location of the model.
	S3Url *string `type:"string"`

	// The desired state of the model.
	State *string `type:"string" enum:"ModelState"`
	// contains filtered or unexported fields
}

func (Definition) GoString 

func (s Definition) 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 (*Definition) SetChecksum 

func (s *Definition) SetChecksum(v *Checksum) *Definition

SetChecksum sets the Checksum field's value.

func (*Definition) SetModelHandle 

func (s *Definition) SetModelHandle(v string) *Definition

SetModelHandle sets the ModelHandle field's value.

func (*Definition) SetS3Url 

func (s *Definition) SetS3Url(v string) *Definition

SetS3Url sets the S3Url field's value.

func (*Definition) SetState 

func (s *Definition) SetState(v string) *Definition

SetState sets the State field's value.

func (Definition) String 

func (s Definition) 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 DeploymentModel 

type DeploymentModel struct {

	// The desired state of the model.
	DesiredState *string `type:"string" enum:"ModelState"`

	// The unique handle of the model.
	ModelHandle *string `min:"1" type:"string"`

	// The name of the model.
	ModelName *string `min:"4" type:"string"`

	// The version of the model.
	ModelVersion *string `min:"1" type:"string"`

	// Returns the error message if there is a rollback.
	RollbackFailureReason *string `type:"string"`

	// Returns the current state of the model.
	State *string `type:"string" enum:"ModelState"`

	// Returns the deployment status of the model.
	Status *string `type:"string" enum:"DeploymentStatus"`

	// Returns the error message for the deployment status result.
	StatusReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeploymentModel) GoString 

func (s DeploymentModel) 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 (*DeploymentModel) SetDesiredState 

func (s *DeploymentModel) SetDesiredState(v string) *DeploymentModel

SetDesiredState sets the DesiredState field's value.

func (*DeploymentModel) SetModelHandle 

func (s *DeploymentModel) SetModelHandle(v string) *DeploymentModel

SetModelHandle sets the ModelHandle field's value.

func (*DeploymentModel) SetModelName 

func (s *DeploymentModel) SetModelName(v string) *DeploymentModel

SetModelName sets the ModelName field's value.

func (*DeploymentModel) SetModelVersion 

func (s *DeploymentModel) SetModelVersion(v string) *DeploymentModel

SetModelVersion sets the ModelVersion field's value.

func (*DeploymentModel) SetRollbackFailureReason 

func (s *DeploymentModel) SetRollbackFailureReason(v string) *DeploymentModel

SetRollbackFailureReason sets the RollbackFailureReason field's value.

func (*DeploymentModel) SetState 

func (s *DeploymentModel) SetState(v string) *DeploymentModel

SetState sets the State field's value.

func (*DeploymentModel) SetStatus 

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

SetStatus sets the Status field's value.

func (*DeploymentModel) SetStatusReason 

func (s *DeploymentModel) SetStatusReason(v string) *DeploymentModel

SetStatusReason sets the StatusReason field's value.

func (DeploymentModel) String 

func (s DeploymentModel) 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 (*DeploymentModel) Validate 

func (s *DeploymentModel) Validate() error

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

type DeploymentResult 

type DeploymentResult struct {

	// The timestamp of when the deployment was ended, and the agent got the deployment
	// results.
	DeploymentEndTime *time.Time `type:"timestamp"`

	// Returns a list of models deployed on the agent.
	DeploymentModels []*DeploymentModel `type:"list"`

	// The name and unique ID of the deployment.
	DeploymentName *string `min:"1" type:"string"`

	// The timestamp of when the deployment was started on the agent.
	DeploymentStartTime *time.Time `type:"timestamp"`

	// Returns the bucket error code.
	DeploymentStatus *string `min:"1" type:"string"`

	// Returns the detailed error message.
	DeploymentStatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the result of a deployment on an edge device that is registered with SageMaker Edge Manager.

func (DeploymentResult) GoString 

func (s DeploymentResult) 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 (*DeploymentResult) SetDeploymentEndTime 

func (s *DeploymentResult) SetDeploymentEndTime(v time.Time) *DeploymentResult

SetDeploymentEndTime sets the DeploymentEndTime field's value.

func (*DeploymentResult) SetDeploymentModels 

func (s *DeploymentResult) SetDeploymentModels(v []*DeploymentModel) *DeploymentResult

SetDeploymentModels sets the DeploymentModels field's value.

func (*DeploymentResult) SetDeploymentName 

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

SetDeploymentName sets the DeploymentName field's value.

func (*DeploymentResult) SetDeploymentStartTime 

func (s *DeploymentResult) SetDeploymentStartTime(v time.Time) *DeploymentResult

SetDeploymentStartTime sets the DeploymentStartTime field's value.

func (*DeploymentResult) SetDeploymentStatus 

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

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*DeploymentResult) SetDeploymentStatusMessage 

func (s *DeploymentResult) SetDeploymentStatusMessage(v string) *DeploymentResult

SetDeploymentStatusMessage sets the DeploymentStatusMessage field's value.

func (DeploymentResult) String 

func (s DeploymentResult) 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 (*DeploymentResult) Validate 

func (s *DeploymentResult) Validate() error

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

type EdgeDeployment 

type EdgeDeployment struct {

	// Returns a list of Definition objects.
	Definitions []*Definition `type:"list"`

	// The name and unique ID of the deployment.
	DeploymentName *string `min:"1" type:"string"`

	// Determines whether to rollback to previous configuration if deployment fails.
	FailureHandlingPolicy *string `type:"string" enum:"FailureHandlingPolicy"`

	// The type of the deployment.
	Type *string `type:"string" enum:"DeploymentType"`
	// contains filtered or unexported fields
}

Information about a deployment on an edge device that is registered with SageMaker Edge Manager.

func (EdgeDeployment) GoString 

func (s EdgeDeployment) 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 (*EdgeDeployment) SetDefinitions 

func (s *EdgeDeployment) SetDefinitions(v []*Definition) *EdgeDeployment

SetDefinitions sets the Definitions field's value.

func (*EdgeDeployment) SetDeploymentName 

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

SetDeploymentName sets the DeploymentName field's value.

func (*EdgeDeployment) SetFailureHandlingPolicy 

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

SetFailureHandlingPolicy sets the FailureHandlingPolicy field's value.

func (*EdgeDeployment) SetType 

func (s *EdgeDeployment) SetType(v string) *EdgeDeployment

SetType sets the Type field's value.

func (EdgeDeployment) String 

func (s EdgeDeployment) 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 EdgeMetric 

type EdgeMetric struct {

	// The dimension of metrics published.
	Dimension *string `min:"1" type:"string"`

	// Returns the name of the metric.
	MetricName *string `min:"4" type:"string"`

	// Timestamp of when the metric was requested.
	Timestamp *time.Time `type:"timestamp"`

	// Returns the value of the metric.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

Information required for edge device metrics.

func (EdgeMetric) GoString 

func (s EdgeMetric) 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 (*EdgeMetric) SetDimension 

func (s *EdgeMetric) SetDimension(v string) *EdgeMetric

SetDimension sets the Dimension field's value.

func (*EdgeMetric) SetMetricName 

func (s *EdgeMetric) SetMetricName(v string) *EdgeMetric

SetMetricName sets the MetricName field's value.

func (*EdgeMetric) SetTimestamp 

func (s *EdgeMetric) SetTimestamp(v time.Time) *EdgeMetric

SetTimestamp sets the Timestamp field's value.

func (*EdgeMetric) SetValue 

func (s *EdgeMetric) SetValue(v float64) *EdgeMetric

SetValue sets the Value field's value.

func (EdgeMetric) String 

func (s EdgeMetric) 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 (*EdgeMetric) Validate 

func (s *EdgeMetric) Validate() error

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

type GetDeploymentsInput 

type GetDeploymentsInput struct {

	// The name of the fleet that the device belongs to.
	//
	// DeviceFleetName is a required field
	DeviceFleetName *string `min:"1" type:"string" required:"true"`

	// The unique name of the device you want to get the configuration of active
	// deployments from.
	//
	// DeviceName is a required field
	DeviceName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeploymentsInput) GoString 

func (s GetDeploymentsInput) 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 (*GetDeploymentsInput) SetDeviceFleetName 

func (s *GetDeploymentsInput) SetDeviceFleetName(v string) *GetDeploymentsInput

SetDeviceFleetName sets the DeviceFleetName field's value.

func (*GetDeploymentsInput) SetDeviceName 

func (s *GetDeploymentsInput) SetDeviceName(v string) *GetDeploymentsInput

SetDeviceName sets the DeviceName field's value.

func (GetDeploymentsInput) String 

func (s GetDeploymentsInput) 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 (*GetDeploymentsInput) Validate 

func (s *GetDeploymentsInput) Validate() error

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

type GetDeploymentsOutput 

type GetDeploymentsOutput struct {

	// Returns a list of the configurations of the active deployments on the device.
	Deployments []*EdgeDeployment `type:"list"`
	// contains filtered or unexported fields
}

func (GetDeploymentsOutput) GoString 

func (s GetDeploymentsOutput) 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 (*GetDeploymentsOutput) SetDeployments 

func (s *GetDeploymentsOutput) SetDeployments(v []*EdgeDeployment) *GetDeploymentsOutput

SetDeployments sets the Deployments field's value.

func (GetDeploymentsOutput) String 

func (s GetDeploymentsOutput) 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 GetDeviceRegistrationInput 

type GetDeviceRegistrationInput struct {

	// The name of the fleet that the device belongs to.
	//
	// DeviceFleetName is a required field
	DeviceFleetName *string `min:"1" type:"string" required:"true"`

	// The unique name of the device you want to get the registration status from.
	//
	// DeviceName is a required field
	DeviceName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeviceRegistrationInput) GoString 

func (s GetDeviceRegistrationInput) 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 (*GetDeviceRegistrationInput) SetDeviceFleetName 

func (s *GetDeviceRegistrationInput) SetDeviceFleetName(v string) *GetDeviceRegistrationInput

SetDeviceFleetName sets the DeviceFleetName field's value.

func (*GetDeviceRegistrationInput) SetDeviceName 

func (s *GetDeviceRegistrationInput) SetDeviceName(v string) *GetDeviceRegistrationInput

SetDeviceName sets the DeviceName field's value.

func (GetDeviceRegistrationInput) String 

func (s GetDeviceRegistrationInput) 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 (*GetDeviceRegistrationInput) Validate 

func (s *GetDeviceRegistrationInput) Validate() error

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

type GetDeviceRegistrationOutput 

type GetDeviceRegistrationOutput struct {

	// The amount of time, in seconds, that the registration status is stored on
	// the device’s cache before it is refreshed.
	CacheTTL *string `min:"1" type:"string"`

	// Describes if the device is currently registered with SageMaker Edge Manager.
	DeviceRegistration *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDeviceRegistrationOutput) GoString 

func (s GetDeviceRegistrationOutput) 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 (*GetDeviceRegistrationOutput) SetCacheTTL 

func (s *GetDeviceRegistrationOutput) SetCacheTTL(v string) *GetDeviceRegistrationOutput

SetCacheTTL sets the CacheTTL field's value.

func (*GetDeviceRegistrationOutput) SetDeviceRegistration 

func (s *GetDeviceRegistrationOutput) SetDeviceRegistration(v string) *GetDeviceRegistrationOutput

SetDeviceRegistration sets the DeviceRegistration field's value.

func (GetDeviceRegistrationOutput) String 

func (s GetDeviceRegistrationOutput) 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 InternalServiceException 

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

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

An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.

func (*InternalServiceException) Code 

func (s *InternalServiceException) Code() string

Code returns the exception type name.

func (*InternalServiceException) Error 

func (s *InternalServiceException) Error() string

func (InternalServiceException) GoString 

func (s InternalServiceException) 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 (*InternalServiceException) Message 

func (s *InternalServiceException) Message() string

Message returns the exception's message.

func (*InternalServiceException) OrigErr 

func (s *InternalServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceException) RequestID 

func (s *InternalServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceException) StatusCode 

func (s *InternalServiceException) StatusCode() int

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

func (InternalServiceException) String 

func (s InternalServiceException) 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 Model 

type Model struct {

	// The timestamp of the last inference that was made.
	LatestInference *time.Time `type:"timestamp"`

	// The timestamp of the last data sample taken.
	LatestSampleTime *time.Time `type:"timestamp"`

	// Information required for model metrics.
	ModelMetrics []*EdgeMetric `type:"list"`

	// The name of the model.
	ModelName *string `min:"4" type:"string"`

	// The version of the model.
	ModelVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.

func (Model) GoString 

func (s Model) 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 (*Model) SetLatestInference 

func (s *Model) SetLatestInference(v time.Time) *Model

SetLatestInference sets the LatestInference field's value.

func (*Model) SetLatestSampleTime 

func (s *Model) SetLatestSampleTime(v time.Time) *Model

SetLatestSampleTime sets the LatestSampleTime field's value.

func (*Model) SetModelMetrics 

func (s *Model) SetModelMetrics(v []*EdgeMetric) *Model

SetModelMetrics sets the ModelMetrics field's value.

func (*Model) SetModelName 

func (s *Model) SetModelName(v string) *Model

SetModelName sets the ModelName field's value.

func (*Model) SetModelVersion 

func (s *Model) SetModelVersion(v string) *Model

SetModelVersion sets the ModelVersion field's value.

func (Model) String 

func (s Model) 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 (*Model) Validate 

func (s *Model) Validate() error

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

type SagemakerEdgeManager 

type SagemakerEdgeManager struct {
	*client.Client
}

SagemakerEdgeManager provides the API operation methods for making requests to Amazon Sagemaker Edge Manager. See this package's package overview docs for details on the service.

SagemakerEdgeManager 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) *SagemakerEdgeManager

New creates a new instance of the SagemakerEdgeManager 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 SagemakerEdgeManager client from just a session.
svc := sagemakeredgemanager.New(mySession)

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

func (*SagemakerEdgeManager) GetDeployments 

func (c *SagemakerEdgeManager) GetDeployments(input *GetDeploymentsInput) (*GetDeploymentsOutput, error)

GetDeployments API operation for Amazon Sagemaker Edge Manager.

Use to get the active deployments from a 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 Amazon Sagemaker Edge Manager's API operation GetDeployments for usage and error information.

Returned Error Types:

  • InternalServiceException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeployments

func (*SagemakerEdgeManager) GetDeploymentsRequest 

func (c *SagemakerEdgeManager) GetDeploymentsRequest(input *GetDeploymentsInput) (req *request.Request, output *GetDeploymentsOutput)

GetDeploymentsRequest generates a "aws/request.Request" representing the client's request for the GetDeployments 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 GetDeployments for more information on using the GetDeployments 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 GetDeploymentsRequest method.
req, resp := client.GetDeploymentsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeployments

func (*SagemakerEdgeManager) GetDeploymentsWithContext 

func (c *SagemakerEdgeManager) GetDeploymentsWithContext(ctx aws.Context, input *GetDeploymentsInput, opts ...request.Option) (*GetDeploymentsOutput, error)

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

See GetDeployments 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 (*SagemakerEdgeManager) GetDeviceRegistration 

func (c *SagemakerEdgeManager) GetDeviceRegistration(input *GetDeviceRegistrationInput) (*GetDeviceRegistrationOutput, error)

GetDeviceRegistration API operation for Amazon Sagemaker Edge Manager.

Use to check if a device is registered with SageMaker Edge Manager.

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 Amazon Sagemaker Edge Manager's API operation GetDeviceRegistration for usage and error information.

Returned Error Types:

  • InternalServiceException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeviceRegistration

func (*SagemakerEdgeManager) GetDeviceRegistrationRequest 

func (c *SagemakerEdgeManager) GetDeviceRegistrationRequest(input *GetDeviceRegistrationInput) (req *request.Request, output *GetDeviceRegistrationOutput)

GetDeviceRegistrationRequest generates a "aws/request.Request" representing the client's request for the GetDeviceRegistration 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 GetDeviceRegistration for more information on using the GetDeviceRegistration 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 GetDeviceRegistrationRequest method.
req, resp := client.GetDeviceRegistrationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/GetDeviceRegistration

func (*SagemakerEdgeManager) GetDeviceRegistrationWithContext 

func (c *SagemakerEdgeManager) GetDeviceRegistrationWithContext(ctx aws.Context, input *GetDeviceRegistrationInput, opts ...request.Option) (*GetDeviceRegistrationOutput, error)

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

See GetDeviceRegistration 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 (*SagemakerEdgeManager) SendHeartbeat 

func (c *SagemakerEdgeManager) SendHeartbeat(input *SendHeartbeatInput) (*SendHeartbeatOutput, error)

SendHeartbeat API operation for Amazon Sagemaker Edge Manager.

Use to get the current status of devices registered on SageMaker Edge Manager.

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 Amazon Sagemaker Edge Manager's API operation SendHeartbeat for usage and error information.

Returned Error Types:

  • InternalServiceException An internal failure occurred. Try your request again. If the problem persists, contact Amazon Web Services customer support.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/SendHeartbeat

func (*SagemakerEdgeManager) SendHeartbeatRequest 

func (c *SagemakerEdgeManager) SendHeartbeatRequest(input *SendHeartbeatInput) (req *request.Request, output *SendHeartbeatOutput)

SendHeartbeatRequest generates a "aws/request.Request" representing the client's request for the SendHeartbeat 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 SendHeartbeat for more information on using the SendHeartbeat 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 SendHeartbeatRequest method.
req, resp := client.SendHeartbeatRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-edge-2020-09-23/SendHeartbeat

func (*SagemakerEdgeManager) SendHeartbeatWithContext 

func (c *SagemakerEdgeManager) SendHeartbeatWithContext(ctx aws.Context, input *SendHeartbeatInput, opts ...request.Option) (*SendHeartbeatOutput, error)

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

See SendHeartbeat 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 SendHeartbeatInput 

type SendHeartbeatInput struct {

	// For internal use. Returns a list of SageMaker Edge Manager agent operating
	// metrics.
	AgentMetrics []*EdgeMetric `type:"list"`

	// Returns the version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `min:"1" type:"string" required:"true"`

	// Returns the result of a deployment on the device.
	DeploymentResult *DeploymentResult `type:"structure"`

	// The name of the fleet that the device belongs to.
	//
	// DeviceFleetName is a required field
	DeviceFleetName *string `min:"1" type:"string" required:"true"`

	// The unique name of the device.
	//
	// DeviceName is a required field
	DeviceName *string `min:"1" type:"string" required:"true"`

	// Returns a list of models deployed on the the device.
	Models []*Model `type:"list"`
	// contains filtered or unexported fields
}

func (SendHeartbeatInput) GoString 

func (s SendHeartbeatInput) 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 (*SendHeartbeatInput) SetAgentMetrics 

func (s *SendHeartbeatInput) SetAgentMetrics(v []*EdgeMetric) *SendHeartbeatInput

SetAgentMetrics sets the AgentMetrics field's value.

func (*SendHeartbeatInput) SetAgentVersion 

func (s *SendHeartbeatInput) SetAgentVersion(v string) *SendHeartbeatInput

SetAgentVersion sets the AgentVersion field's value.

func (*SendHeartbeatInput) SetDeploymentResult 

func (s *SendHeartbeatInput) SetDeploymentResult(v *DeploymentResult) *SendHeartbeatInput

SetDeploymentResult sets the DeploymentResult field's value.

func (*SendHeartbeatInput) SetDeviceFleetName 

func (s *SendHeartbeatInput) SetDeviceFleetName(v string) *SendHeartbeatInput

SetDeviceFleetName sets the DeviceFleetName field's value.

func (*SendHeartbeatInput) SetDeviceName 

func (s *SendHeartbeatInput) SetDeviceName(v string) *SendHeartbeatInput

SetDeviceName sets the DeviceName field's value.

func (*SendHeartbeatInput) SetModels 

func (s *SendHeartbeatInput) SetModels(v []*Model) *SendHeartbeatInput

SetModels sets the Models field's value.

func (SendHeartbeatInput) String 

func (s SendHeartbeatInput) 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 (*SendHeartbeatInput) Validate 

func (s *SendHeartbeatInput) Validate() error

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

type SendHeartbeatOutput 

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

func (SendHeartbeatOutput) GoString 

func (s SendHeartbeatOutput) 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 (SendHeartbeatOutput) String 

func (s SendHeartbeatOutput) 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 sagemakeredgemanageriface provides an interface to enable mocking the Amazon Sagemaker Edge Manager service client for testing your code.
 Package sagemakeredgemanageriface provides an interface to enable mocking the Amazon Sagemaker Edge Manager 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.