com.amazonaws.services.sagemakeredgemanager

Class AmazonSagemakerEdgeManagerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sagemakeredgemanager.AmazonSagemakerEdgeManagerClient

All Implemented Interfaces:

AmazonSagemakerEdgeManager

Direct Known Subclasses:

AmazonSagemakerEdgeManagerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSagemakerEdgeManagerClient
extends AmazonWebServiceClient
implements AmazonSagemakerEdgeManager

Client for accessing Amazon Sagemaker Edge Manager. All service calls made using this client are blocking, and will not return until the service call completes.

SageMaker Edge Manager dataplane service for communicating with active agents.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.sagemakeredgemanager.AmazonSagemakerEdgeManager

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonSagemakerEdgeManagerClientBuilder	builder()
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 request) Use to get the active deployments from a device.
GetDeviceRegistrationResult	getDeviceRegistration(GetDeviceRegistrationRequest request) Use to check if a device is registered with SageMaker Edge Manager.
SendHeartbeatResult	sendHeartbeat(SendHeartbeatRequest request) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonSagemakerEdgeManagerClientBuilder builder()

getDeployments

public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)

Use to get the active deployments from a device.

Specified by:

getDeployments in interface AmazonSagemakerEdgeManager

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

public GetDeviceRegistrationResult getDeviceRegistration(GetDeviceRegistrationRequest request)

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

Specified by:

getDeviceRegistration in interface AmazonSagemakerEdgeManager

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

public SendHeartbeatResult sendHeartbeat(SendHeartbeatRequest request)

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

Specified by:

sendHeartbeat in interface AmazonSagemakerEdgeManager

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonSagemakerEdgeManager

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonSagemakerEdgeManager

Overrides:

shutdown in class AmazonWebServiceClient