Package software.amazon.awssdk.services.sagemakeredge

Interface SagemakerEdgeAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SagemakerEdgeAsyncClient extends AwsClient
Service client for accessing Amazon Sagemaker Edge Manager asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

SageMaker Edge Manager dataplane service for communicating with active agents.

  • Field Details

  • Method Details

    • getDeployments

      default CompletableFuture<GetDeploymentsResponse> getDeployments(GetDeploymentsRequest getDeploymentsRequest)

      Use to get the active deployments from a device.

      Parameters:
      getDeploymentsRequest -
      Returns:
      A Java Future containing the result of the GetDeployments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeployments

      default CompletableFuture<GetDeploymentsResponse> getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)

      Use to get the active deployments from a device.


      This is a convenience which creates an instance of the GetDeploymentsRequest.Builder avoiding the need to create one manually via GetDeploymentsRequest.builder()

      Parameters:
      getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDeployments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeviceRegistration

      default CompletableFuture<GetDeviceRegistrationResponse> getDeviceRegistration(GetDeviceRegistrationRequest getDeviceRegistrationRequest)

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

      Parameters:
      getDeviceRegistrationRequest -
      Returns:
      A Java Future containing the result of the GetDeviceRegistration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getDeviceRegistration

      default CompletableFuture<GetDeviceRegistrationResponse> getDeviceRegistration(Consumer<GetDeviceRegistrationRequest.Builder> getDeviceRegistrationRequest)

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


      This is a convenience which creates an instance of the GetDeviceRegistrationRequest.Builder avoiding the need to create one manually via GetDeviceRegistrationRequest.builder()

      Parameters:
      getDeviceRegistrationRequest - A Consumer that will call methods on GetDeviceRegistrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDeviceRegistration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendHeartbeat

      default CompletableFuture<SendHeartbeatResponse> sendHeartbeat(SendHeartbeatRequest sendHeartbeatRequest)

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

      Parameters:
      sendHeartbeatRequest -
      Returns:
      A Java Future containing the result of the SendHeartbeat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • sendHeartbeat

      default CompletableFuture<SendHeartbeatResponse> sendHeartbeat(Consumer<SendHeartbeatRequest.Builder> sendHeartbeatRequest)

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


      This is a convenience which creates an instance of the SendHeartbeatRequest.Builder avoiding the need to create one manually via SendHeartbeatRequest.builder()

      Parameters:
      sendHeartbeatRequest - A Consumer that will call methods on SendHeartbeatRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendHeartbeat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default SagemakerEdgeServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SagemakerEdgeAsyncClient create()
      Create a SagemakerEdgeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SagemakerEdgeAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SagemakerEdgeAsyncClient.