com.amazonaws.services.sagemakeredgemanager

Interface AmazonSagemakerEdgeManager

All Known Subinterfaces:

AmazonSagemakerEdgeManagerAsync

All Known Implementing Classes:

AbstractAmazonSagemakerEdgeManager, AbstractAmazonSagemakerEdgeManagerAsync, AmazonSagemakerEdgeManagerAsyncClient, AmazonSagemakerEdgeManagerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSagemakerEdgeManager

Interface for accessing Amazon Sagemaker Edge Manager.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSagemakerEdgeManager instead.

SageMaker Edge Manager dataplane service for communicating with active agents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDeploymentsResult	getDeployments(GetDeploymentsRequest getDeploymentsRequest) Use to get the active deployments from a device.
GetDeviceRegistrationResult	getDeviceRegistration(GetDeviceRegistrationRequest getDeviceRegistrationRequest) Use to check if a device is registered with SageMaker Edge Manager.
SendHeartbeatResult	sendHeartbeat(SendHeartbeatRequest sendHeartbeatRequest) Use to get the current status of devices registered on SageMaker Edge Manager.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getDeployments

GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)

Use to get the active deployments from a device.

Parameters:

getDeploymentsRequest -

Returns:

Result of the GetDeployments operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

getDeviceRegistration

GetDeviceRegistrationResult getDeviceRegistration(GetDeviceRegistrationRequest getDeviceRegistrationRequest)

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

Parameters:

getDeviceRegistrationRequest -

Returns:

Result of the GetDeviceRegistration operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

sendHeartbeat

SendHeartbeatResult sendHeartbeat(SendHeartbeatRequest sendHeartbeatRequest)

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

Parameters:

sendHeartbeatRequest -

Returns:

Result of the SendHeartbeat operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.