Interface SagemakerEdgeClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SagemakerEdgeClient extends AwsClient
Service client for accessing Amazon Sagemaker Edge Manager. This can be created using the staticbuilder()method.SageMaker Edge Manager dataplane service for communicating with active agents.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SagemakerEdgeClientBuilderbuilder()Create a builder that can be used to configure and create aSagemakerEdgeClient.static SagemakerEdgeClientcreate()Create aSagemakerEdgeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default GetDeploymentsResponsegetDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)Use to get the active deployments from a device.default GetDeploymentsResponsegetDeployments(GetDeploymentsRequest getDeploymentsRequest)Use to get the active deployments from a device.default GetDeviceRegistrationResponsegetDeviceRegistration(Consumer<GetDeviceRegistrationRequest.Builder> getDeviceRegistrationRequest)Use to check if a device is registered with SageMaker Edge Manager.default GetDeviceRegistrationResponsegetDeviceRegistration(GetDeviceRegistrationRequest getDeviceRegistrationRequest)Use to check if a device is registered with SageMaker Edge Manager.default SendHeartbeatResponsesendHeartbeat(Consumer<SendHeartbeatRequest.Builder> sendHeartbeatRequest)Use to get the current status of devices registered on SageMaker Edge Manager.default SendHeartbeatResponsesendHeartbeat(SendHeartbeatRequest sendHeartbeatRequest)Use to get the current status of devices registered on SageMaker Edge Manager.default SagemakerEdgeServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDeployments
default GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDeployments
default GetDeploymentsResponse getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
Use to get the active deployments from a device.
This is a convenience which creates an instance of the
GetDeploymentsRequest.Builderavoiding the need to create one manually viaGetDeploymentsRequest.builder()- Parameters:
getDeploymentsRequest- AConsumerthat will call methods onGetDeploymentsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDeviceRegistration
default GetDeviceRegistrationResponse getDeviceRegistration(GetDeviceRegistrationRequest getDeviceRegistrationRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDeviceRegistration
default GetDeviceRegistrationResponse getDeviceRegistration(Consumer<GetDeviceRegistrationRequest.Builder> getDeviceRegistrationRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
Use to check if a device is registered with SageMaker Edge Manager.
This is a convenience which creates an instance of the
GetDeviceRegistrationRequest.Builderavoiding the need to create one manually viaGetDeviceRegistrationRequest.builder()- Parameters:
getDeviceRegistrationRequest- AConsumerthat will call methods onGetDeviceRegistrationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendHeartbeat
default SendHeartbeatResponse sendHeartbeat(SendHeartbeatRequest sendHeartbeatRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendHeartbeat
default SendHeartbeatResponse sendHeartbeat(Consumer<SendHeartbeatRequest.Builder> sendHeartbeatRequest) throws InternalServiceException, AwsServiceException, SdkClientException, SagemakerEdgeException
Use to get the current status of devices registered on SageMaker Edge Manager.
This is a convenience which creates an instance of the
SendHeartbeatRequest.Builderavoiding the need to create one manually viaSendHeartbeatRequest.builder()- Parameters:
sendHeartbeatRequest- AConsumerthat will call methods onSendHeartbeatRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SagemakerEdgeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SagemakerEdgeClient create()
Create aSagemakerEdgeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SagemakerEdgeClientBuilder builder()
Create a builder that can be used to configure and create aSagemakerEdgeClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SagemakerEdgeServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-