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 (
	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 (
    
    	// ErrCodeInternalServiceException for service response error code
    	// "InternalServiceException".
    	//
    	// An internal failure occurred. Try your request again. If the problem persists,
    	// contact AWS customer support.
    	ErrCodeInternalServiceException = "InternalServiceException"
    )

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    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

        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

                  func (*EdgeMetric) Validate

                  func (s *EdgeMetric) Validate() error

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

                    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

                      func (*GetDeviceRegistrationInput) SetDeviceFleetName

                        SetDeviceFleetName sets the DeviceFleetName field's value.

                        func (*GetDeviceRegistrationInput) SetDeviceName

                          SetDeviceName sets the DeviceName field's value.

                          func (GetDeviceRegistrationInput) String

                            String returns the string representation

                            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

                                func (*GetDeviceRegistrationOutput) SetCacheTTL

                                  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

                                      String returns the string representation

                                      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 AWS 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

                                            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

                                                      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

                                                          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

                                                                      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

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

                                                                              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 AWS 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

                                                                                    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 AWS 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"`
                                                                                        
                                                                                        	// 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

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

                                                                                                      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

                                                                                                          func (SendHeartbeatOutput) String

                                                                                                          func (s SendHeartbeatOutput) String() string

                                                                                                            String returns the string representation

                                                                                                            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.