Package software.amazon.awssdk.services.sagemaker

Interface SageMakerAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SageMakerAsyncClient extends AwsClient
Service client for accessing SageMaker 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.

Provides APIs for creating and managing SageMaker resources.

Other Resources:

  • Field Details

  • Method Details

    • addAssociation

      default CompletableFuture<AddAssociationResponse> addAssociation(AddAssociationRequest addAssociationRequest)

      Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

      Parameters:
      addAssociationRequest -
      Returns:
      A Java Future containing the result of the AddAssociation 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addAssociation

      default CompletableFuture<AddAssociationResponse> addAssociation(Consumer<AddAssociationRequest.Builder> addAssociationRequest)

      Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.


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

      Parameters:
      addAssociationRequest - A Consumer that will call methods on AddAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddAssociation 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTags

      default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)

      Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

      Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

      Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

      Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

      Parameters:
      addTagsRequest -
      Returns:
      A Java Future containing the result of the AddTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTags

      default CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)

      Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

      Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

      Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

      Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.


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

      Parameters:
      addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTrialComponent

      default CompletableFuture<AssociateTrialComponentResponse> associateTrialComponent(AssociateTrialComponentRequest associateTrialComponentRequest)

      Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

      Parameters:
      associateTrialComponentRequest -
      Returns:
      A Java Future containing the result of the AssociateTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTrialComponent

      default CompletableFuture<AssociateTrialComponentResponse> associateTrialComponent(Consumer<AssociateTrialComponentRequest.Builder> associateTrialComponentRequest)

      Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.


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

      Parameters:
      associateTrialComponentRequest - A Consumer that will call methods on AssociateTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDescribeModelPackage

      default CompletableFuture<BatchDescribeModelPackageResponse> batchDescribeModelPackage(BatchDescribeModelPackageRequest batchDescribeModelPackageRequest)

      This action batch describes a list of versioned model packages

      Parameters:
      batchDescribeModelPackageRequest -
      Returns:
      A Java Future containing the result of the BatchDescribeModelPackage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDescribeModelPackage

      default CompletableFuture<BatchDescribeModelPackageResponse> batchDescribeModelPackage(Consumer<BatchDescribeModelPackageRequest.Builder> batchDescribeModelPackageRequest)

      This action batch describes a list of versioned model packages


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

      Parameters:
      batchDescribeModelPackageRequest - A Consumer that will call methods on BatchDescribeModelPackageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDescribeModelPackage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAction

      default CompletableFuture<CreateActionResponse> createAction(CreateActionRequest createActionRequest)

      Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

      Parameters:
      createActionRequest -
      Returns:
      A Java Future containing the result of the CreateAction 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAction

      default CompletableFuture<CreateActionResponse> createAction(Consumer<CreateActionRequest.Builder> createActionRequest)

      Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.


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

      Parameters:
      createActionRequest - A Consumer that will call methods on CreateActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAction 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAlgorithm

      default CompletableFuture<CreateAlgorithmResponse> createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest)

      Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

      Parameters:
      createAlgorithmRequest -
      Returns:
      A Java Future containing the result of the CreateAlgorithm 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAlgorithm

      default CompletableFuture<CreateAlgorithmResponse> createAlgorithm(Consumer<CreateAlgorithmRequest.Builder> createAlgorithmRequest)

      Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.


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

      Parameters:
      createAlgorithmRequest - A Consumer that will call methods on CreateAlgorithmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAlgorithm 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApp

      default CompletableFuture<CreateAppResponse> createApp(CreateAppRequest createAppRequest)

      Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

      Parameters:
      createAppRequest -
      Returns:
      A Java Future containing the result of the CreateApp 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApp

      default CompletableFuture<CreateAppResponse> createApp(Consumer<CreateAppRequest.Builder> createAppRequest)

      Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.


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

      Parameters:
      createAppRequest - A Consumer that will call methods on CreateAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApp 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAppImageConfig

      default CompletableFuture<CreateAppImageConfigResponse> createAppImageConfig(CreateAppImageConfigRequest createAppImageConfigRequest)

      Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

      Parameters:
      createAppImageConfigRequest -
      Returns:
      A Java Future containing the result of the CreateAppImageConfig 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAppImageConfig

      default CompletableFuture<CreateAppImageConfigResponse> createAppImageConfig(Consumer<CreateAppImageConfigRequest.Builder> createAppImageConfigRequest)

      Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.


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

      Parameters:
      createAppImageConfigRequest - A Consumer that will call methods on CreateAppImageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAppImageConfig 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createArtifact

      default CompletableFuture<CreateArtifactResponse> createArtifact(CreateArtifactRequest createArtifactRequest)

      Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

      Parameters:
      createArtifactRequest -
      Returns:
      A Java Future containing the result of the CreateArtifact 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createArtifact

      default CompletableFuture<CreateArtifactResponse> createArtifact(Consumer<CreateArtifactRequest.Builder> createArtifactRequest)

      Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.


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

      Parameters:
      createArtifactRequest - A Consumer that will call methods on CreateArtifactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateArtifact 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAutoMLJob

      default CompletableFuture<CreateAutoMlJobResponse> createAutoMLJob(CreateAutoMlJobRequest createAutoMlJobRequest)

      Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

      We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

      CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

      Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

      You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.

      Parameters:
      createAutoMlJobRequest -
      Returns:
      A Java Future containing the result of the CreateAutoMLJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAutoMLJob

      default CompletableFuture<CreateAutoMlJobResponse> createAutoMLJob(Consumer<CreateAutoMlJobRequest.Builder> createAutoMlJobRequest)

      Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.

      We recommend using the new versions CreateAutoMLJobV2 and DescribeAutoMLJobV2, which offer backward compatibility.

      CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

      Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

      You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.


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

      Parameters:
      createAutoMlJobRequest - A Consumer that will call methods on CreateAutoMlJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAutoMLJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAutoMLJobV2

      default CompletableFuture<CreateAutoMlJobV2Response> createAutoMLJobV2(CreateAutoMlJobV2Request createAutoMlJobV2Request)

      Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

      CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

      CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

      Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

      For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

      You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.

      Parameters:
      createAutoMlJobV2Request -
      Returns:
      A Java Future containing the result of the CreateAutoMLJobV2 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAutoMLJobV2

      default CompletableFuture<CreateAutoMlJobV2Response> createAutoMLJobV2(Consumer<CreateAutoMlJobV2Request.Builder> createAutoMlJobV2Request)

      Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.

      CreateAutoMLJobV2 and DescribeAutoMLJobV2 are new versions of CreateAutoMLJob and DescribeAutoMLJob which offer backward compatibility.

      CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning).

      Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.

      For the list of available problem types supported by CreateAutoMLJobV2, see AutoMLProblemTypeConfig.

      You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.


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

      Parameters:
      createAutoMlJobV2Request - A Consumer that will call methods on CreateAutoMlJobV2Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAutoMLJobV2 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

      Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

      Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.


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

      Parameters:
      createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCluster 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCodeRepository

      default CompletableFuture<CreateCodeRepositoryResponse> createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest)

      Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

      The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

      Parameters:
      createCodeRepositoryRequest -
      Returns:
      A Java Future containing the result of the CreateCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCodeRepository

      default CompletableFuture<CreateCodeRepositoryResponse> createCodeRepository(Consumer<CreateCodeRepositoryRequest.Builder> createCodeRepositoryRequest)

      Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

      The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.


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

      Parameters:
      createCodeRepositoryRequest - A Consumer that will call methods on CreateCodeRepositoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCompilationJob

      default CompletableFuture<CreateCompilationJobResponse> createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest)

      Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

      If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

      In the request body, you provide the following:

      • A name for the compilation job

      • Information about the input model artifacts

      • The output location for the compiled model and the device (target) that the model runs on

      • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

      You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

      To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

      Parameters:
      createCompilationJobRequest -
      Returns:
      A Java Future containing the result of the CreateCompilationJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCompilationJob

      default CompletableFuture<CreateCompilationJobResponse> createCompilationJob(Consumer<CreateCompilationJobRequest.Builder> createCompilationJobRequest)

      Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

      If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

      In the request body, you provide the following:

      • A name for the compilation job

      • Information about the input model artifacts

      • The output location for the compiled model and the device (target) that the model runs on

      • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

      You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

      To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.


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

      Parameters:
      createCompilationJobRequest - A Consumer that will call methods on CreateCompilationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCompilationJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContext

      default CompletableFuture<CreateContextResponse> createContext(CreateContextRequest createContextRequest)

      Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

      Parameters:
      createContextRequest -
      Returns:
      A Java Future containing the result of the CreateContext 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContext

      default CompletableFuture<CreateContextResponse> createContext(Consumer<CreateContextRequest.Builder> createContextRequest)

      Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.


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

      Parameters:
      createContextRequest - A Consumer that will call methods on CreateContextRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContext 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataQualityJobDefinition

      default CompletableFuture<CreateDataQualityJobDefinitionResponse> createDataQualityJobDefinition(CreateDataQualityJobDefinitionRequest createDataQualityJobDefinitionRequest)

      Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

      Parameters:
      createDataQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateDataQualityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataQualityJobDefinition

      default CompletableFuture<CreateDataQualityJobDefinitionResponse> createDataQualityJobDefinition(Consumer<CreateDataQualityJobDefinitionRequest.Builder> createDataQualityJobDefinitionRequest)

      Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.


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

      Parameters:
      createDataQualityJobDefinitionRequest - A Consumer that will call methods on CreateDataQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataQualityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDeviceFleet

      default CompletableFuture<CreateDeviceFleetResponse> createDeviceFleet(CreateDeviceFleetRequest createDeviceFleetRequest)

      Creates a device fleet.

      Parameters:
      createDeviceFleetRequest -
      Returns:
      A Java Future containing the result of the CreateDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDeviceFleet

      default CompletableFuture<CreateDeviceFleetResponse> createDeviceFleet(Consumer<CreateDeviceFleetRequest.Builder> createDeviceFleetRequest)

      Creates a device fleet.


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

      Parameters:
      createDeviceFleetRequest - A Consumer that will call methods on CreateDeviceFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)

      Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

      EFS storage

      When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

      SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

      VPC configuration

      All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

      • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

      • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

        When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

      NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

      For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.

      Parameters:
      createDomainRequest -
      Returns:
      A Java Future containing the result of the CreateDomain 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)

      Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

      EFS storage

      When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

      SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

      VPC configuration

      All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

      • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

      • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

        When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

      NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully.

      For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.


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

      Parameters:
      createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomain 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgeDeploymentPlan

      default CompletableFuture<CreateEdgeDeploymentPlanResponse> createEdgeDeploymentPlan(CreateEdgeDeploymentPlanRequest createEdgeDeploymentPlanRequest)

      Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

      Parameters:
      createEdgeDeploymentPlanRequest -
      Returns:
      A Java Future containing the result of the CreateEdgeDeploymentPlan 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgeDeploymentPlan

      default CompletableFuture<CreateEdgeDeploymentPlanResponse> createEdgeDeploymentPlan(Consumer<CreateEdgeDeploymentPlanRequest.Builder> createEdgeDeploymentPlanRequest)

      Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.


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

      Parameters:
      createEdgeDeploymentPlanRequest - A Consumer that will call methods on CreateEdgeDeploymentPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEdgeDeploymentPlan 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgeDeploymentStage

      default CompletableFuture<CreateEdgeDeploymentStageResponse> createEdgeDeploymentStage(CreateEdgeDeploymentStageRequest createEdgeDeploymentStageRequest)

      Creates a new stage in an existing edge deployment plan.

      Parameters:
      createEdgeDeploymentStageRequest -
      Returns:
      A Java Future containing the result of the CreateEdgeDeploymentStage 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgeDeploymentStage

      default CompletableFuture<CreateEdgeDeploymentStageResponse> createEdgeDeploymentStage(Consumer<CreateEdgeDeploymentStageRequest.Builder> createEdgeDeploymentStageRequest)

      Creates a new stage in an existing edge deployment plan.


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

      Parameters:
      createEdgeDeploymentStageRequest - A Consumer that will call methods on CreateEdgeDeploymentStageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEdgeDeploymentStage 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgePackagingJob

      default CompletableFuture<CreateEdgePackagingJobResponse> createEdgePackagingJob(CreateEdgePackagingJobRequest createEdgePackagingJobRequest)

      Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

      Parameters:
      createEdgePackagingJobRequest -
      Returns:
      A Java Future containing the result of the CreateEdgePackagingJob 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEdgePackagingJob

      default CompletableFuture<CreateEdgePackagingJobResponse> createEdgePackagingJob(Consumer<CreateEdgePackagingJobRequest.Builder> createEdgePackagingJobRequest)

      Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.


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

      Parameters:
      createEdgePackagingJobRequest - A Consumer that will call methods on CreateEdgePackagingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEdgePackagingJob 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(CreateEndpointRequest createEndpointRequest)

      Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

      Use this API to deploy models using SageMaker hosting services.

      You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

      The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

      When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

      When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

      When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

      If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

      To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

      • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

      • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

        "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]

        "Resource": [

        "arn:aws:sagemaker:region:account-id:endpoint/endpointName"

        "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

        ]

        For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

      Parameters:
      createEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateEndpoint 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpoint

      default CompletableFuture<CreateEndpointResponse> createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)

      Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

      Use this API to deploy models using SageMaker hosting services.

      You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

      The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

      When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

      When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

      When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

      If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

      To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

      • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.

      • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:

        "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]

        "Resource": [

        "arn:aws:sagemaker:region:account-id:endpoint/endpointName"

        "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"

        ]

        For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.


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

      Parameters:
      createEndpointRequest - A Consumer that will call methods on CreateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEndpoint 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpointConfig

      default CompletableFuture<CreateEndpointConfigResponse> createEndpointConfig(CreateEndpointConfigRequest createEndpointConfigRequest)

      Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

      Use this API if you want to use SageMaker hosting services to deploy models into production.

      In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

      If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

      When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

      Parameters:
      createEndpointConfigRequest -
      Returns:
      A Java Future containing the result of the CreateEndpointConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEndpointConfig

      default CompletableFuture<CreateEndpointConfigResponse> createEndpointConfig(Consumer<CreateEndpointConfigRequest.Builder> createEndpointConfigRequest)

      Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

      Use this API if you want to use SageMaker hosting services to deploy models into production.

      In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

      If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

      When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.


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

      Parameters:
      createEndpointConfigRequest - A Consumer that will call methods on CreateEndpointConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEndpointConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExperiment

      default CompletableFuture<CreateExperimentResponse> createExperiment(CreateExperimentRequest createExperimentRequest)

      Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

      In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

      The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

      To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

      To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

      Parameters:
      createExperimentRequest -
      Returns:
      A Java Future containing the result of the CreateExperiment 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExperiment

      default CompletableFuture<CreateExperimentResponse> createExperiment(Consumer<CreateExperimentRequest.Builder> createExperimentRequest)

      Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

      In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.

      The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

      To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

      To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.


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

      Parameters:
      createExperimentRequest - A Consumer that will call methods on CreateExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateExperiment 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFeatureGroup

      default CompletableFuture<CreateFeatureGroupResponse> createFeatureGroup(CreateFeatureGroupRequest createFeatureGroupRequest)

      Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

      The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

      Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

      You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

      Parameters:
      createFeatureGroupRequest -
      Returns:
      A Java Future containing the result of the CreateFeatureGroup 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFeatureGroup

      default CompletableFuture<CreateFeatureGroupResponse> createFeatureGroup(Consumer<CreateFeatureGroupRequest.Builder> createFeatureGroupRequest)

      Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

      The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

      Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType.

      You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.


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

      Parameters:
      createFeatureGroupRequest - A Consumer that will call methods on CreateFeatureGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFeatureGroup 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlowDefinition

      default CompletableFuture<CreateFlowDefinitionResponse> createFlowDefinition(CreateFlowDefinitionRequest createFlowDefinitionRequest)

      Creates a flow definition.

      Parameters:
      createFlowDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateFlowDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlowDefinition

      default CompletableFuture<CreateFlowDefinitionResponse> createFlowDefinition(Consumer<CreateFlowDefinitionRequest.Builder> createFlowDefinitionRequest)

      Creates a flow definition.


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

      Parameters:
      createFlowDefinitionRequest - A Consumer that will call methods on CreateFlowDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFlowDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHub

      default CompletableFuture<CreateHubResponse> createHub(CreateHubRequest createHubRequest)

      Create a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      createHubRequest -
      Returns:
      A Java Future containing the result of the CreateHub 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHub

      default CompletableFuture<CreateHubResponse> createHub(Consumer<CreateHubRequest.Builder> createHubRequest)

      Create a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      createHubRequest - A Consumer that will call methods on CreateHubRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHub 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHumanTaskUi

      default CompletableFuture<CreateHumanTaskUiResponse> createHumanTaskUi(CreateHumanTaskUiRequest createHumanTaskUiRequest)

      Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

      Parameters:
      createHumanTaskUiRequest -
      Returns:
      A Java Future containing the result of the CreateHumanTaskUi 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHumanTaskUi

      default CompletableFuture<CreateHumanTaskUiResponse> createHumanTaskUi(Consumer<CreateHumanTaskUiRequest.Builder> createHumanTaskUiRequest)

      Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.


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

      Parameters:
      createHumanTaskUiRequest - A Consumer that will call methods on CreateHumanTaskUiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHumanTaskUi 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHyperParameterTuningJob

      default CompletableFuture<CreateHyperParameterTuningJobResponse> createHyperParameterTuningJob(CreateHyperParameterTuningJobRequest createHyperParameterTuningJobRequest)

      Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

      A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

      Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

      Parameters:
      createHyperParameterTuningJobRequest -
      Returns:
      A Java Future containing the result of the CreateHyperParameterTuningJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHyperParameterTuningJob

      default CompletableFuture<CreateHyperParameterTuningJobResponse> createHyperParameterTuningJob(Consumer<CreateHyperParameterTuningJobRequest.Builder> createHyperParameterTuningJobRequest)

      Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

      A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.

      Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.


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

      Parameters:
      createHyperParameterTuningJobRequest - A Consumer that will call methods on CreateHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHyperParameterTuningJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImage

      default CompletableFuture<CreateImageResponse> createImage(CreateImageRequest createImageRequest)

      Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

      Parameters:
      createImageRequest -
      Returns:
      A Java Future containing the result of the CreateImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImage

      default CompletableFuture<CreateImageResponse> createImage(Consumer<CreateImageRequest.Builder> createImageRequest)

      Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.


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

      Parameters:
      createImageRequest - A Consumer that will call methods on CreateImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImageVersion

      default CompletableFuture<CreateImageVersionResponse> createImageVersion(CreateImageVersionRequest createImageVersionRequest)

      Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.

      Parameters:
      createImageVersionRequest -
      Returns:
      A Java Future containing the result of the CreateImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImageVersion

      default CompletableFuture<CreateImageVersionResponse> createImageVersion(Consumer<CreateImageVersionRequest.Builder> createImageVersionRequest)

      Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.


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

      Parameters:
      createImageVersionRequest - A Consumer that will call methods on CreateImageVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceComponent

      default CompletableFuture<CreateInferenceComponentResponse> createInferenceComponent(CreateInferenceComponentRequest createInferenceComponentRequest)

      Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

      Parameters:
      createInferenceComponentRequest -
      Returns:
      A Java Future containing the result of the CreateInferenceComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceComponent

      default CompletableFuture<CreateInferenceComponentResponse> createInferenceComponent(Consumer<CreateInferenceComponentRequest.Builder> createInferenceComponentRequest)

      Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.


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

      Parameters:
      createInferenceComponentRequest - A Consumer that will call methods on CreateInferenceComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInferenceComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceExperiment

      default CompletableFuture<CreateInferenceExperimentResponse> createInferenceExperiment(CreateInferenceExperimentRequest createInferenceExperimentRequest)

      Creates an inference experiment using the configurations specified in the request.

      Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

      Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

      While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.

      Parameters:
      createInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the CreateInferenceExperiment 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceExperiment

      default CompletableFuture<CreateInferenceExperimentResponse> createInferenceExperiment(Consumer<CreateInferenceExperimentRequest.Builder> createInferenceExperimentRequest)

      Creates an inference experiment using the configurations specified in the request.

      Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests.

      Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

      While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests.


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

      Parameters:
      createInferenceExperimentRequest - A Consumer that will call methods on CreateInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInferenceExperiment 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceRecommendationsJob

      default CompletableFuture<CreateInferenceRecommendationsJobResponse> createInferenceRecommendationsJob(CreateInferenceRecommendationsJobRequest createInferenceRecommendationsJobRequest)

      Starts a recommendation job. You can create either an instance recommendation or load test job.

      Parameters:
      createInferenceRecommendationsJobRequest -
      Returns:
      A Java Future containing the result of the CreateInferenceRecommendationsJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInferenceRecommendationsJob

      default CompletableFuture<CreateInferenceRecommendationsJobResponse> createInferenceRecommendationsJob(Consumer<CreateInferenceRecommendationsJobRequest.Builder> createInferenceRecommendationsJobRequest)

      Starts a recommendation job. You can create either an instance recommendation or load test job.


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

      Parameters:
      createInferenceRecommendationsJobRequest - A Consumer that will call methods on CreateInferenceRecommendationsJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInferenceRecommendationsJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLabelingJob

      default CompletableFuture<CreateLabelingJobResponse> createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest)

      Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

      You can select your workforce from one of three providers:

      • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

      • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

      • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

      You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

      The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

      The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

      You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

      Parameters:
      createLabelingJobRequest -
      Returns:
      A Java Future containing the result of the CreateLabelingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLabelingJob

      default CompletableFuture<CreateLabelingJobResponse> createLabelingJob(Consumer<CreateLabelingJobRequest.Builder> createLabelingJobRequest)

      Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

      You can select your workforce from one of three providers:

      • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

      • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.

      • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

      You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

      The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

      The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

      You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.


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

      Parameters:
      createLabelingJobRequest - A Consumer that will call methods on CreateLabelingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLabelingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModel

      default CompletableFuture<CreateModelResponse> createModel(CreateModelRequest createModelRequest)

      Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

      Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

      To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

      To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

      In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

      Parameters:
      createModelRequest -
      Returns:
      A Java Future containing the result of the CreateModel 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModel

      default CompletableFuture<CreateModelResponse> createModel(Consumer<CreateModelRequest.Builder> createModelRequest)

      Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

      Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

      To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

      To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

      In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.


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

      Parameters:
      createModelRequest - A Consumer that will call methods on CreateModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModel 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelBiasJobDefinition

      default CompletableFuture<CreateModelBiasJobDefinitionResponse> createModelBiasJobDefinition(CreateModelBiasJobDefinitionRequest createModelBiasJobDefinitionRequest)

      Creates the definition for a model bias job.

      Parameters:
      createModelBiasJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateModelBiasJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelBiasJobDefinition

      default CompletableFuture<CreateModelBiasJobDefinitionResponse> createModelBiasJobDefinition(Consumer<CreateModelBiasJobDefinitionRequest.Builder> createModelBiasJobDefinitionRequest)

      Creates the definition for a model bias job.


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

      Parameters:
      createModelBiasJobDefinitionRequest - A Consumer that will call methods on CreateModelBiasJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelBiasJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelCard

      default CompletableFuture<CreateModelCardResponse> createModelCard(CreateModelCardRequest createModelCardRequest)

      Creates an Amazon SageMaker Model Card.

      For information about how to use model cards, see Amazon SageMaker Model Card.

      Parameters:
      createModelCardRequest -
      Returns:
      A Java Future containing the result of the CreateModelCard 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelCard

      default CompletableFuture<CreateModelCardResponse> createModelCard(Consumer<CreateModelCardRequest.Builder> createModelCardRequest)

      Creates an Amazon SageMaker Model Card.

      For information about how to use model cards, see Amazon SageMaker Model Card.


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

      Parameters:
      createModelCardRequest - A Consumer that will call methods on CreateModelCardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelCard 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelCardExportJob

      default CompletableFuture<CreateModelCardExportJobResponse> createModelCardExportJob(CreateModelCardExportJobRequest createModelCardExportJobRequest)

      Creates an Amazon SageMaker Model Card export job.

      Parameters:
      createModelCardExportJobRequest -
      Returns:
      A Java Future containing the result of the CreateModelCardExportJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelCardExportJob

      default CompletableFuture<CreateModelCardExportJobResponse> createModelCardExportJob(Consumer<CreateModelCardExportJobRequest.Builder> createModelCardExportJobRequest)

      Creates an Amazon SageMaker Model Card export job.


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

      Parameters:
      createModelCardExportJobRequest - A Consumer that will call methods on CreateModelCardExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelCardExportJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelExplainabilityJobDefinition

      default CompletableFuture<CreateModelExplainabilityJobDefinitionResponse> createModelExplainabilityJobDefinition(CreateModelExplainabilityJobDefinitionRequest createModelExplainabilityJobDefinitionRequest)

      Creates the definition for a model explainability job.

      Parameters:
      createModelExplainabilityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateModelExplainabilityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelExplainabilityJobDefinition

      default CompletableFuture<CreateModelExplainabilityJobDefinitionResponse> createModelExplainabilityJobDefinition(Consumer<CreateModelExplainabilityJobDefinitionRequest.Builder> createModelExplainabilityJobDefinitionRequest)

      Creates the definition for a model explainability job.


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

      Parameters:
      createModelExplainabilityJobDefinitionRequest - A Consumer that will call methods on CreateModelExplainabilityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelExplainabilityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelPackage

      default CompletableFuture<CreateModelPackageResponse> createModelPackage(CreateModelPackageRequest createModelPackageRequest)

      Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

      To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

      There are two types of model packages:

      • Versioned - a model that is part of a model group in the model registry.

      • Unversioned - a model package that is not part of a model group.

      Parameters:
      createModelPackageRequest -
      Returns:
      A Java Future containing the result of the CreateModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelPackage

      default CompletableFuture<CreateModelPackageResponse> createModelPackage(Consumer<CreateModelPackageRequest.Builder> createModelPackageRequest)

      Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

      To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

      There are two types of model packages:

      • Versioned - a model that is part of a model group in the model registry.

      • Unversioned - a model package that is not part of a model group.


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

      Parameters:
      createModelPackageRequest - A Consumer that will call methods on CreateModelPackageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelPackageGroup

      default CompletableFuture<CreateModelPackageGroupResponse> createModelPackageGroup(CreateModelPackageGroupRequest createModelPackageGroupRequest)

      Creates a model group. A model group contains a group of model versions.

      Parameters:
      createModelPackageGroupRequest -
      Returns:
      A Java Future containing the result of the CreateModelPackageGroup 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelPackageGroup

      default CompletableFuture<CreateModelPackageGroupResponse> createModelPackageGroup(Consumer<CreateModelPackageGroupRequest.Builder> createModelPackageGroupRequest)

      Creates a model group. A model group contains a group of model versions.


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

      Parameters:
      createModelPackageGroupRequest - A Consumer that will call methods on CreateModelPackageGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelPackageGroup 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelQualityJobDefinition

      default CompletableFuture<CreateModelQualityJobDefinitionResponse> createModelQualityJobDefinition(CreateModelQualityJobDefinitionRequest createModelQualityJobDefinitionRequest)

      Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

      Parameters:
      createModelQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateModelQualityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createModelQualityJobDefinition

      default CompletableFuture<CreateModelQualityJobDefinitionResponse> createModelQualityJobDefinition(Consumer<CreateModelQualityJobDefinitionRequest.Builder> createModelQualityJobDefinitionRequest)

      Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.


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

      Parameters:
      createModelQualityJobDefinitionRequest - A Consumer that will call methods on CreateModelQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateModelQualityJobDefinition 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMonitoringSchedule

      default CompletableFuture<CreateMonitoringScheduleResponse> createMonitoringSchedule(CreateMonitoringScheduleRequest createMonitoringScheduleRequest)

      Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

      Parameters:
      createMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the CreateMonitoringSchedule 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMonitoringSchedule

      default CompletableFuture<CreateMonitoringScheduleResponse> createMonitoringSchedule(Consumer<CreateMonitoringScheduleRequest.Builder> createMonitoringScheduleRequest)

      Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.


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

      Parameters:
      createMonitoringScheduleRequest - A Consumer that will call methods on CreateMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMonitoringSchedule 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebookInstance

      default CompletableFuture<CreateNotebookInstanceResponse> createNotebookInstance(CreateNotebookInstanceRequest createNotebookInstanceRequest)

      Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

      In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

      SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

      After receiving the request, SageMaker does the following:

      1. Creates a network interface in the SageMaker VPC.

      2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

      3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

      After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

      After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

      For more information, see How It Works.

      Parameters:
      createNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the CreateNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebookInstance

      default CompletableFuture<CreateNotebookInstanceResponse> createNotebookInstance(Consumer<CreateNotebookInstanceRequest.Builder> createNotebookInstanceRequest)

      Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

      In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

      SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

      After receiving the request, SageMaker does the following:

      1. Creates a network interface in the SageMaker VPC.

      2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

      3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

      After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

      After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

      For more information, see How It Works.


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

      Parameters:
      createNotebookInstanceRequest - A Consumer that will call methods on CreateNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebookInstanceLifecycleConfig

      default CompletableFuture<CreateNotebookInstanceLifecycleConfigResponse> createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest createNotebookInstanceLifecycleConfigRequest)

      Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

      Each lifecycle configuration script has a limit of 16384 characters.

      The value of the invalid input: '&#36'PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

      View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

      Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

      For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

      Parameters:
      createNotebookInstanceLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the CreateNotebookInstanceLifecycleConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebookInstanceLifecycleConfig

      default CompletableFuture<CreateNotebookInstanceLifecycleConfigResponse> createNotebookInstanceLifecycleConfig(Consumer<CreateNotebookInstanceLifecycleConfigRequest.Builder> createNotebookInstanceLifecycleConfigRequest)

      Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

      Each lifecycle configuration script has a limit of 16384 characters.

      The value of the invalid input: '&#36'PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

      View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

      Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

      For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.


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

      Parameters:
      createNotebookInstanceLifecycleConfigRequest - A Consumer that will call methods on CreateNotebookInstanceLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNotebookInstanceLifecycleConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)

      Creates a pipeline using a JSON pipeline definition.

      Parameters:
      createPipelineRequest -
      Returns:
      A Java Future containing the result of the CreatePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)

      Creates a pipeline using a JSON pipeline definition.


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

      Parameters:
      createPipelineRequest - A Consumer that will call methods on CreatePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedDomainUrl

      default CompletableFuture<CreatePresignedDomainUrlResponse> createPresignedDomainUrl(CreatePresignedDomainUrlRequest createPresignedDomainUrlRequest)

      Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

      The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

      You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

      The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

      Parameters:
      createPresignedDomainUrlRequest -
      Returns:
      A Java Future containing the result of the CreatePresignedDomainUrl 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedDomainUrl

      default CompletableFuture<CreatePresignedDomainUrlResponse> createPresignedDomainUrl(Consumer<CreatePresignedDomainUrlRequest.Builder> createPresignedDomainUrlRequest)

      Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

      The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

      You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

      The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.


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

      Parameters:
      createPresignedDomainUrlRequest - A Consumer that will call methods on CreatePresignedDomainUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePresignedDomainUrl 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedNotebookInstanceUrl

      default CompletableFuture<CreatePresignedNotebookInstanceUrlResponse> createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest createPresignedNotebookInstanceUrlRequest)

      Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

      The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

      You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

      The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

      Parameters:
      createPresignedNotebookInstanceUrlRequest -
      Returns:
      A Java Future containing the result of the CreatePresignedNotebookInstanceUrl 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedNotebookInstanceUrl

      default CompletableFuture<CreatePresignedNotebookInstanceUrlResponse> createPresignedNotebookInstanceUrl(Consumer<CreatePresignedNotebookInstanceUrlRequest.Builder> createPresignedNotebookInstanceUrlRequest)

      Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

      The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

      You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

      The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.


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

      Parameters:
      createPresignedNotebookInstanceUrlRequest - A Consumer that will call methods on CreatePresignedNotebookInstanceUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePresignedNotebookInstanceUrl 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProcessingJob

      default CompletableFuture<CreateProcessingJobResponse> createProcessingJob(CreateProcessingJobRequest createProcessingJobRequest)

      Creates a processing job.

      Parameters:
      createProcessingJobRequest -
      Returns:
      A Java Future containing the result of the CreateProcessingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProcessingJob

      default CompletableFuture<CreateProcessingJobResponse> createProcessingJob(Consumer<CreateProcessingJobRequest.Builder> createProcessingJobRequest)

      Creates a processing job.


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

      Parameters:
      createProcessingJobRequest - A Consumer that will call methods on CreateProcessingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProcessingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)

      Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

      Parameters:
      createProjectRequest -
      Returns:
      A Java Future containing the result of the CreateProject 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createProject

      default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)

      Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.


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

      Parameters:
      createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProject 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSpace

      default CompletableFuture<CreateSpaceResponse> createSpace(CreateSpaceRequest createSpaceRequest)

      Creates a private space or a space used for real time collaboration in a domain.

      Parameters:
      createSpaceRequest -
      Returns:
      A Java Future containing the result of the CreateSpace 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSpace

      default CompletableFuture<CreateSpaceResponse> createSpace(Consumer<CreateSpaceRequest.Builder> createSpaceRequest)

      Creates a private space or a space used for real time collaboration in a domain.


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

      Parameters:
      createSpaceRequest - A Consumer that will call methods on CreateSpaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSpace 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStudioLifecycleConfig

      default CompletableFuture<CreateStudioLifecycleConfigResponse> createStudioLifecycleConfig(CreateStudioLifecycleConfigRequest createStudioLifecycleConfigRequest)

      Creates a new Amazon SageMaker Studio Lifecycle Configuration.

      Parameters:
      createStudioLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the CreateStudioLifecycleConfig 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStudioLifecycleConfig

      default CompletableFuture<CreateStudioLifecycleConfigResponse> createStudioLifecycleConfig(Consumer<CreateStudioLifecycleConfigRequest.Builder> createStudioLifecycleConfigRequest)

      Creates a new Amazon SageMaker Studio Lifecycle Configuration.


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

      Parameters:
      createStudioLifecycleConfigRequest - A Consumer that will call methods on CreateStudioLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStudioLifecycleConfig 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrainingJob

      default CompletableFuture<CreateTrainingJobResponse> createTrainingJob(CreateTrainingJobRequest createTrainingJobRequest)

      Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

      If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

      In the request body, you provide the following:

      • AlgorithmSpecification - Identifies the training algorithm to use.

      • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

        Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

      • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

      • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

      • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

      • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

      • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

      • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

      • Environment - The environment variables to set in the Docker container.

      • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

      For more information about SageMaker, see How It Works.

      Parameters:
      createTrainingJobRequest -
      Returns:
      A Java Future containing the result of the CreateTrainingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrainingJob

      default CompletableFuture<CreateTrainingJobResponse> createTrainingJob(Consumer<CreateTrainingJobRequest.Builder> createTrainingJobRequest)

      Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

      If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

      In the request body, you provide the following:

      • AlgorithmSpecification - Identifies the training algorithm to use.

      • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

        Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

      • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.

      • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.

      • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

      • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

      • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.

      • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.

      • Environment - The environment variables to set in the Docker container.

      • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

      For more information about SageMaker, see How It Works.


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

      Parameters:
      createTrainingJobRequest - A Consumer that will call methods on CreateTrainingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrainingJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTransformJob

      default CompletableFuture<CreateTransformJobResponse> createTransformJob(CreateTransformJobRequest createTransformJobRequest)

      Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

      To perform batch transformations, you create a transform job and use the data that you have readily available.

      In the request body, you provide the following:

      • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

      • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

      • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

      • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

      • TransformResources - Identifies the ML compute instances for the transform job.

      For more information about how batch transformation works, see Batch Transform.

      Parameters:
      createTransformJobRequest -
      Returns:
      A Java Future containing the result of the CreateTransformJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTransformJob

      default CompletableFuture<CreateTransformJobResponse> createTransformJob(Consumer<CreateTransformJobRequest.Builder> createTransformJobRequest)

      Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

      To perform batch transformations, you create a transform job and use the data that you have readily available.

      In the request body, you provide the following:

      • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

      • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.

      • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

      • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

      • TransformResources - Identifies the ML compute instances for the transform job.

      For more information about how batch transformation works, see Batch Transform.


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

      Parameters:
      createTransformJobRequest - A Consumer that will call methods on CreateTransformJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTransformJob 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrial

      default CompletableFuture<CreateTrialResponse> createTrial(CreateTrialRequest createTrialRequest)

      Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to a trial and then use the Search API to search for the tags.

      To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

      Parameters:
      createTrialRequest -
      Returns:
      A Java Future containing the result of the CreateTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrial

      default CompletableFuture<CreateTrialResponse> createTrial(Consumer<CreateTrialRequest.Builder> createTrialRequest)

      Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to a trial and then use the Search API to search for the tags.

      To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.


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

      Parameters:
      createTrialRequest - A Consumer that will call methods on CreateTrialRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrialComponent

      default CompletableFuture<CreateTrialComponentResponse> createTrialComponent(CreateTrialComponentRequest createTrialComponentRequest)

      Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

      Trial components include pre-processing jobs, training jobs, and batch transform jobs.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to a trial component and then use the Search API to search for the tags.

      Parameters:
      createTrialComponentRequest -
      Returns:
      A Java Future containing the result of the CreateTrialComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrialComponent

      default CompletableFuture<CreateTrialComponentResponse> createTrialComponent(Consumer<CreateTrialComponentRequest.Builder> createTrialComponentRequest)

      Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

      Trial components include pre-processing jobs, training jobs, and batch transform jobs.

      When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

      You can add tags to a trial component and then use the Search API to search for the tags.


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

      Parameters:
      createTrialComponentRequest - A Consumer that will call methods on CreateTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrialComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUserProfile

      default CompletableFuture<CreateUserProfileResponse> createUserProfile(CreateUserProfileRequest createUserProfileRequest)

      Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.

      Parameters:
      createUserProfileRequest -
      Returns:
      A Java Future containing the result of the CreateUserProfile 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUserProfile

      default CompletableFuture<CreateUserProfileResponse> createUserProfile(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest)

      Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.


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

      Parameters:
      createUserProfileRequest - A Consumer that will call methods on CreateUserProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUserProfile 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkforce

      default CompletableFuture<CreateWorkforceResponse> createWorkforce(CreateWorkforceRequest createWorkforceRequest)

      Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

      If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

      To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

      To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

      Parameters:
      createWorkforceRequest -
      Returns:
      A Java Future containing the result of the CreateWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkforce

      default CompletableFuture<CreateWorkforceResponse> createWorkforce(Consumer<CreateWorkforceRequest.Builder> createWorkforceRequest)

      Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

      If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

      To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

      To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).


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

      Parameters:
      createWorkforceRequest - A Consumer that will call methods on CreateWorkforceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkteam

      default CompletableFuture<CreateWorkteamResponse> createWorkteam(CreateWorkteamRequest createWorkteamRequest)

      Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

      You cannot create more than 25 work teams in an account and region.

      Parameters:
      createWorkteamRequest -
      Returns:
      A Java Future containing the result of the CreateWorkteam 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkteam

      default CompletableFuture<CreateWorkteamResponse> createWorkteam(Consumer<CreateWorkteamRequest.Builder> createWorkteamRequest)

      Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

      You cannot create more than 25 work teams in an account and region.


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

      Parameters:
      createWorkteamRequest - A Consumer that will call methods on CreateWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkteam 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAction

      default CompletableFuture<DeleteActionResponse> deleteAction(DeleteActionRequest deleteActionRequest)

      Deletes an action.

      Parameters:
      deleteActionRequest -
      Returns:
      A Java Future containing the result of the DeleteAction 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAction

      default CompletableFuture<DeleteActionResponse> deleteAction(Consumer<DeleteActionRequest.Builder> deleteActionRequest)

      Deletes an action.


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

      Parameters:
      deleteActionRequest - A Consumer that will call methods on DeleteActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAction 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAlgorithm

      default CompletableFuture<DeleteAlgorithmResponse> deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest)

      Removes the specified algorithm from your account.

      Parameters:
      deleteAlgorithmRequest -
      Returns:
      A Java Future containing the result of the DeleteAlgorithm 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAlgorithm

      default CompletableFuture<DeleteAlgorithmResponse> deleteAlgorithm(Consumer<DeleteAlgorithmRequest.Builder> deleteAlgorithmRequest)

      Removes the specified algorithm from your account.


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

      Parameters:
      deleteAlgorithmRequest - A Consumer that will call methods on DeleteAlgorithmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAlgorithm 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)

      Used to stop and delete an app.

      Parameters:
      deleteAppRequest -
      Returns:
      A Java Future containing the result of the DeleteApp 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)

      Used to stop and delete an app.


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

      Parameters:
      deleteAppRequest - A Consumer that will call methods on DeleteAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApp 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAppImageConfig

      default CompletableFuture<DeleteAppImageConfigResponse> deleteAppImageConfig(DeleteAppImageConfigRequest deleteAppImageConfigRequest)

      Deletes an AppImageConfig.

      Parameters:
      deleteAppImageConfigRequest -
      Returns:
      A Java Future containing the result of the DeleteAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAppImageConfig

      default CompletableFuture<DeleteAppImageConfigResponse> deleteAppImageConfig(Consumer<DeleteAppImageConfigRequest.Builder> deleteAppImageConfigRequest)

      Deletes an AppImageConfig.


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

      Parameters:
      deleteAppImageConfigRequest - A Consumer that will call methods on DeleteAppImageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteArtifact

      default CompletableFuture<DeleteArtifactResponse> deleteArtifact(DeleteArtifactRequest deleteArtifactRequest)

      Deletes an artifact. Either ArtifactArn or Source must be specified.

      Parameters:
      deleteArtifactRequest -
      Returns:
      A Java Future containing the result of the DeleteArtifact 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteArtifact

      default CompletableFuture<DeleteArtifactResponse> deleteArtifact(Consumer<DeleteArtifactRequest.Builder> deleteArtifactRequest)

      Deletes an artifact. Either ArtifactArn or Source must be specified.


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

      Parameters:
      deleteArtifactRequest - A Consumer that will call methods on DeleteArtifactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteArtifact 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssociation

      default CompletableFuture<DeleteAssociationResponse> deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)

      Deletes an association.

      Parameters:
      deleteAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteAssociation 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssociation

      default CompletableFuture<DeleteAssociationResponse> deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)

      Deletes an association.


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

      Parameters:
      deleteAssociationRequest - A Consumer that will call methods on DeleteAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssociation 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

      Delete a SageMaker HyperPod cluster.

      Parameters:
      deleteClusterRequest -
      Returns:
      A Java Future containing the result of the DeleteCluster 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

      Delete a SageMaker HyperPod cluster.


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

      Parameters:
      deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCluster 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCodeRepository

      default CompletableFuture<DeleteCodeRepositoryResponse> deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest)

      Deletes the specified Git repository from your account.

      Parameters:
      deleteCodeRepositoryRequest -
      Returns:
      A Java Future containing the result of the DeleteCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCodeRepository

      default CompletableFuture<DeleteCodeRepositoryResponse> deleteCodeRepository(Consumer<DeleteCodeRepositoryRequest.Builder> deleteCodeRepositoryRequest)

      Deletes the specified Git repository from your account.


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

      Parameters:
      deleteCodeRepositoryRequest - A Consumer that will call methods on DeleteCodeRepositoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCompilationJob

      default CompletableFuture<DeleteCompilationJobResponse> deleteCompilationJob(DeleteCompilationJobRequest deleteCompilationJobRequest)

      Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

      You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.

      Parameters:
      deleteCompilationJobRequest -
      Returns:
      A Java Future containing the result of the DeleteCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCompilationJob

      default CompletableFuture<DeleteCompilationJobResponse> deleteCompilationJob(Consumer<DeleteCompilationJobRequest.Builder> deleteCompilationJobRequest)

      Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role.

      You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomes STOPPED.


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

      Parameters:
      deleteCompilationJobRequest - A Consumer that will call methods on DeleteCompilationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContext

      default CompletableFuture<DeleteContextResponse> deleteContext(DeleteContextRequest deleteContextRequest)

      Deletes an context.

      Parameters:
      deleteContextRequest -
      Returns:
      A Java Future containing the result of the DeleteContext 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContext

      default CompletableFuture<DeleteContextResponse> deleteContext(Consumer<DeleteContextRequest.Builder> deleteContextRequest)

      Deletes an context.


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

      Parameters:
      deleteContextRequest - A Consumer that will call methods on DeleteContextRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContext 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataQualityJobDefinition

      default CompletableFuture<DeleteDataQualityJobDefinitionResponse> deleteDataQualityJobDefinition(DeleteDataQualityJobDefinitionRequest deleteDataQualityJobDefinitionRequest)

      Deletes a data quality monitoring job definition.

      Parameters:
      deleteDataQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteDataQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataQualityJobDefinition

      default CompletableFuture<DeleteDataQualityJobDefinitionResponse> deleteDataQualityJobDefinition(Consumer<DeleteDataQualityJobDefinitionRequest.Builder> deleteDataQualityJobDefinitionRequest)

      Deletes a data quality monitoring job definition.


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

      Parameters:
      deleteDataQualityJobDefinitionRequest - A Consumer that will call methods on DeleteDataQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDeviceFleet

      default CompletableFuture<DeleteDeviceFleetResponse> deleteDeviceFleet(DeleteDeviceFleetRequest deleteDeviceFleetRequest)

      Deletes a fleet.

      Parameters:
      deleteDeviceFleetRequest -
      Returns:
      A Java Future containing the result of the DeleteDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDeviceFleet

      default CompletableFuture<DeleteDeviceFleetResponse> deleteDeviceFleet(Consumer<DeleteDeviceFleetRequest.Builder> deleteDeviceFleetRequest)

      Deletes a fleet.


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

      Parameters:
      deleteDeviceFleetRequest - A Consumer that will call methods on DeleteDeviceFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

      Parameters:
      deleteDomainRequest -
      Returns:
      A Java Future containing the result of the DeleteDomain 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)

      Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.


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

      Parameters:
      deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDomain 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEdgeDeploymentPlan

      default CompletableFuture<DeleteEdgeDeploymentPlanResponse> deleteEdgeDeploymentPlan(DeleteEdgeDeploymentPlanRequest deleteEdgeDeploymentPlanRequest)

      Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

      Parameters:
      deleteEdgeDeploymentPlanRequest -
      Returns:
      A Java Future containing the result of the DeleteEdgeDeploymentPlan 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEdgeDeploymentPlan

      default CompletableFuture<DeleteEdgeDeploymentPlanResponse> deleteEdgeDeploymentPlan(Consumer<DeleteEdgeDeploymentPlanRequest.Builder> deleteEdgeDeploymentPlanRequest)

      Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.


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

      Parameters:
      deleteEdgeDeploymentPlanRequest - A Consumer that will call methods on DeleteEdgeDeploymentPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEdgeDeploymentPlan 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEdgeDeploymentStage

      default CompletableFuture<DeleteEdgeDeploymentStageResponse> deleteEdgeDeploymentStage(DeleteEdgeDeploymentStageRequest deleteEdgeDeploymentStageRequest)

      Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

      Parameters:
      deleteEdgeDeploymentStageRequest -
      Returns:
      A Java Future containing the result of the DeleteEdgeDeploymentStage 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEdgeDeploymentStage

      default CompletableFuture<DeleteEdgeDeploymentStageResponse> deleteEdgeDeploymentStage(Consumer<DeleteEdgeDeploymentStageRequest.Builder> deleteEdgeDeploymentStageRequest)

      Delete a stage in an edge deployment plan if (and only if) the stage is inactive.


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

      Parameters:
      deleteEdgeDeploymentStageRequest - A Consumer that will call methods on DeleteEdgeDeploymentStageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEdgeDeploymentStage 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

      Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

      SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

      When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

      Parameters:
      deleteEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)

      Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

      SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

      When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.


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

      Parameters:
      deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpointConfig

      default CompletableFuture<DeleteEndpointConfigResponse> deleteEndpointConfig(DeleteEndpointConfigRequest deleteEndpointConfigRequest)

      Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

      You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

      Parameters:
      deleteEndpointConfigRequest -
      Returns:
      A Java Future containing the result of the DeleteEndpointConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpointConfig

      default CompletableFuture<DeleteEndpointConfigResponse> deleteEndpointConfig(Consumer<DeleteEndpointConfigRequest.Builder> deleteEndpointConfigRequest)

      Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

      You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.


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

      Parameters:
      deleteEndpointConfigRequest - A Consumer that will call methods on DeleteEndpointConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEndpointConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExperiment

      default CompletableFuture<DeleteExperimentResponse> deleteExperiment(DeleteExperimentRequest deleteExperimentRequest)

      Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

      Parameters:
      deleteExperimentRequest -
      Returns:
      A Java Future containing the result of the DeleteExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExperiment

      default CompletableFuture<DeleteExperimentResponse> deleteExperiment(Consumer<DeleteExperimentRequest.Builder> deleteExperimentRequest)

      Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.


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

      Parameters:
      deleteExperimentRequest - A Consumer that will call methods on DeleteExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFeatureGroup

      default CompletableFuture<DeleteFeatureGroupResponse> deleteFeatureGroup(DeleteFeatureGroupRequest deleteFeatureGroupRequest)

      Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

      Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

      Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.

      Parameters:
      deleteFeatureGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFeatureGroup

      default CompletableFuture<DeleteFeatureGroupResponse> deleteFeatureGroup(Consumer<DeleteFeatureGroupRequest.Builder> deleteFeatureGroupRequest)

      Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

      Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

      Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.


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

      Parameters:
      deleteFeatureGroupRequest - A Consumer that will call methods on DeleteFeatureGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlowDefinition

      default CompletableFuture<DeleteFlowDefinitionResponse> deleteFlowDefinition(DeleteFlowDefinitionRequest deleteFlowDefinitionRequest)

      Deletes the specified flow definition.

      Parameters:
      deleteFlowDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteFlowDefinition 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlowDefinition

      default CompletableFuture<DeleteFlowDefinitionResponse> deleteFlowDefinition(Consumer<DeleteFlowDefinitionRequest.Builder> deleteFlowDefinitionRequest)

      Deletes the specified flow definition.


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

      Parameters:
      deleteFlowDefinitionRequest - A Consumer that will call methods on DeleteFlowDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFlowDefinition 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHub

      default CompletableFuture<DeleteHubResponse> deleteHub(DeleteHubRequest deleteHubRequest)

      Delete a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      deleteHubRequest -
      Returns:
      A Java Future containing the result of the DeleteHub 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHub

      default CompletableFuture<DeleteHubResponse> deleteHub(Consumer<DeleteHubRequest.Builder> deleteHubRequest)

      Delete a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      deleteHubRequest - A Consumer that will call methods on DeleteHubRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHub 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHubContent

      default CompletableFuture<DeleteHubContentResponse> deleteHubContent(DeleteHubContentRequest deleteHubContentRequest)

      Delete the contents of a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      deleteHubContentRequest -
      Returns:
      A Java Future containing the result of the DeleteHubContent 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHubContent

      default CompletableFuture<DeleteHubContentResponse> deleteHubContent(Consumer<DeleteHubContentRequest.Builder> deleteHubContentRequest)

      Delete the contents of a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      deleteHubContentRequest - A Consumer that will call methods on DeleteHubContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHubContent 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHumanTaskUi

      default CompletableFuture<DeleteHumanTaskUiResponse> deleteHumanTaskUi(DeleteHumanTaskUiRequest deleteHumanTaskUiRequest)

      Use this operation to delete a human task user interface (worker task template).

      To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

      Parameters:
      deleteHumanTaskUiRequest -
      Returns:
      A Java Future containing the result of the DeleteHumanTaskUi 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHumanTaskUi

      default CompletableFuture<DeleteHumanTaskUiResponse> deleteHumanTaskUi(Consumer<DeleteHumanTaskUiRequest.Builder> deleteHumanTaskUiRequest)

      Use this operation to delete a human task user interface (worker task template).

      To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.


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

      Parameters:
      deleteHumanTaskUiRequest - A Consumer that will call methods on DeleteHumanTaskUiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHumanTaskUi 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHyperParameterTuningJob

      default CompletableFuture<DeleteHyperParameterTuningJobResponse> deleteHyperParameterTuningJob(DeleteHyperParameterTuningJobRequest deleteHyperParameterTuningJobRequest)

      Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

      Parameters:
      deleteHyperParameterTuningJobRequest -
      Returns:
      A Java Future containing the result of the DeleteHyperParameterTuningJob 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHyperParameterTuningJob

      default CompletableFuture<DeleteHyperParameterTuningJobResponse> deleteHyperParameterTuningJob(Consumer<DeleteHyperParameterTuningJobRequest.Builder> deleteHyperParameterTuningJobRequest)

      Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.


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

      Parameters:
      deleteHyperParameterTuningJobRequest - A Consumer that will call methods on DeleteHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHyperParameterTuningJob 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImage

      default CompletableFuture<DeleteImageResponse> deleteImage(DeleteImageRequest deleteImageRequest)

      Deletes a SageMaker image and all versions of the image. The container images aren't deleted.

      Parameters:
      deleteImageRequest -
      Returns:
      A Java Future containing the result of the DeleteImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImage

      default CompletableFuture<DeleteImageResponse> deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest)

      Deletes a SageMaker image and all versions of the image. The container images aren't deleted.


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

      Parameters:
      deleteImageRequest - A Consumer that will call methods on DeleteImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageVersion

      default CompletableFuture<DeleteImageVersionResponse> deleteImageVersion(DeleteImageVersionRequest deleteImageVersionRequest)

      Deletes a version of a SageMaker image. The container image the version represents isn't deleted.

      Parameters:
      deleteImageVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImageVersion

      default CompletableFuture<DeleteImageVersionResponse> deleteImageVersion(Consumer<DeleteImageVersionRequest.Builder> deleteImageVersionRequest)

      Deletes a version of a SageMaker image. The container image the version represents isn't deleted.


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

      Parameters:
      deleteImageVersionRequest - A Consumer that will call methods on DeleteImageVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInferenceComponent

      default CompletableFuture<DeleteInferenceComponentResponse> deleteInferenceComponent(DeleteInferenceComponentRequest deleteInferenceComponentRequest)

      Deletes an inference component.

      Parameters:
      deleteInferenceComponentRequest -
      Returns:
      A Java Future containing the result of the DeleteInferenceComponent 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInferenceComponent

      default CompletableFuture<DeleteInferenceComponentResponse> deleteInferenceComponent(Consumer<DeleteInferenceComponentRequest.Builder> deleteInferenceComponentRequest)

      Deletes an inference component.


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

      Parameters:
      deleteInferenceComponentRequest - A Consumer that will call methods on DeleteInferenceComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInferenceComponent 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInferenceExperiment

      default CompletableFuture<DeleteInferenceExperimentResponse> deleteInferenceExperiment(DeleteInferenceExperimentRequest deleteInferenceExperimentRequest)

      Deletes an inference experiment.

      This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

      Parameters:
      deleteInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the DeleteInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInferenceExperiment

      default CompletableFuture<DeleteInferenceExperimentResponse> deleteInferenceExperiment(Consumer<DeleteInferenceExperimentRequest.Builder> deleteInferenceExperimentRequest)

      Deletes an inference experiment.

      This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.


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

      Parameters:
      deleteInferenceExperimentRequest - A Consumer that will call methods on DeleteInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModel

      default CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest deleteModelRequest)

      Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

      Parameters:
      deleteModelRequest -
      Returns:
      A Java Future containing the result of the DeleteModel 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModel

      default CompletableFuture<DeleteModelResponse> deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)

      Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.


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

      Parameters:
      deleteModelRequest - A Consumer that will call methods on DeleteModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModel 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelBiasJobDefinition

      default CompletableFuture<DeleteModelBiasJobDefinitionResponse> deleteModelBiasJobDefinition(DeleteModelBiasJobDefinitionRequest deleteModelBiasJobDefinitionRequest)

      Deletes an Amazon SageMaker model bias job definition.

      Parameters:
      deleteModelBiasJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteModelBiasJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelBiasJobDefinition

      default CompletableFuture<DeleteModelBiasJobDefinitionResponse> deleteModelBiasJobDefinition(Consumer<DeleteModelBiasJobDefinitionRequest.Builder> deleteModelBiasJobDefinitionRequest)

      Deletes an Amazon SageMaker model bias job definition.


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

      Parameters:
      deleteModelBiasJobDefinitionRequest - A Consumer that will call methods on DeleteModelBiasJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelBiasJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelCard

      default CompletableFuture<DeleteModelCardResponse> deleteModelCard(DeleteModelCardRequest deleteModelCardRequest)

      Deletes an Amazon SageMaker Model Card.

      Parameters:
      deleteModelCardRequest -
      Returns:
      A Java Future containing the result of the DeleteModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelCard

      default CompletableFuture<DeleteModelCardResponse> deleteModelCard(Consumer<DeleteModelCardRequest.Builder> deleteModelCardRequest)

      Deletes an Amazon SageMaker Model Card.


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

      Parameters:
      deleteModelCardRequest - A Consumer that will call methods on DeleteModelCardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelExplainabilityJobDefinition

      default CompletableFuture<DeleteModelExplainabilityJobDefinitionResponse> deleteModelExplainabilityJobDefinition(DeleteModelExplainabilityJobDefinitionRequest deleteModelExplainabilityJobDefinitionRequest)

      Deletes an Amazon SageMaker model explainability job definition.

      Parameters:
      deleteModelExplainabilityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteModelExplainabilityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelExplainabilityJobDefinition

      default CompletableFuture<DeleteModelExplainabilityJobDefinitionResponse> deleteModelExplainabilityJobDefinition(Consumer<DeleteModelExplainabilityJobDefinitionRequest.Builder> deleteModelExplainabilityJobDefinitionRequest)

      Deletes an Amazon SageMaker model explainability job definition.


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

      Parameters:
      deleteModelExplainabilityJobDefinitionRequest - A Consumer that will call methods on DeleteModelExplainabilityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelExplainabilityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackage

      default CompletableFuture<DeleteModelPackageResponse> deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest)

      Deletes a model package.

      A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

      Parameters:
      deleteModelPackageRequest -
      Returns:
      A Java Future containing the result of the DeleteModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackage

      default CompletableFuture<DeleteModelPackageResponse> deleteModelPackage(Consumer<DeleteModelPackageRequest.Builder> deleteModelPackageRequest)

      Deletes a model package.

      A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.


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

      Parameters:
      deleteModelPackageRequest - A Consumer that will call methods on DeleteModelPackageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackageGroup

      default CompletableFuture<DeleteModelPackageGroupResponse> deleteModelPackageGroup(DeleteModelPackageGroupRequest deleteModelPackageGroupRequest)

      Deletes the specified model group.

      Parameters:
      deleteModelPackageGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteModelPackageGroup 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackageGroup

      default CompletableFuture<DeleteModelPackageGroupResponse> deleteModelPackageGroup(Consumer<DeleteModelPackageGroupRequest.Builder> deleteModelPackageGroupRequest)

      Deletes the specified model group.


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

      Parameters:
      deleteModelPackageGroupRequest - A Consumer that will call methods on DeleteModelPackageGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelPackageGroup 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackageGroupPolicy

      default CompletableFuture<DeleteModelPackageGroupPolicyResponse> deleteModelPackageGroupPolicy(DeleteModelPackageGroupPolicyRequest deleteModelPackageGroupPolicyRequest)

      Deletes a model group resource policy.

      Parameters:
      deleteModelPackageGroupPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteModelPackageGroupPolicy 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelPackageGroupPolicy

      default CompletableFuture<DeleteModelPackageGroupPolicyResponse> deleteModelPackageGroupPolicy(Consumer<DeleteModelPackageGroupPolicyRequest.Builder> deleteModelPackageGroupPolicyRequest)

      Deletes a model group resource policy.


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

      Parameters:
      deleteModelPackageGroupPolicyRequest - A Consumer that will call methods on DeleteModelPackageGroupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelPackageGroupPolicy 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelQualityJobDefinition

      default CompletableFuture<DeleteModelQualityJobDefinitionResponse> deleteModelQualityJobDefinition(DeleteModelQualityJobDefinitionRequest deleteModelQualityJobDefinitionRequest)

      Deletes the secified model quality monitoring job definition.

      Parameters:
      deleteModelQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteModelQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteModelQualityJobDefinition

      default CompletableFuture<DeleteModelQualityJobDefinitionResponse> deleteModelQualityJobDefinition(Consumer<DeleteModelQualityJobDefinitionRequest.Builder> deleteModelQualityJobDefinitionRequest)

      Deletes the secified model quality monitoring job definition.


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

      Parameters:
      deleteModelQualityJobDefinitionRequest - A Consumer that will call methods on DeleteModelQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteModelQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMonitoringSchedule

      default CompletableFuture<DeleteMonitoringScheduleResponse> deleteMonitoringSchedule(DeleteMonitoringScheduleRequest deleteMonitoringScheduleRequest)

      Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

      Parameters:
      deleteMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the DeleteMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMonitoringSchedule

      default CompletableFuture<DeleteMonitoringScheduleResponse> deleteMonitoringSchedule(Consumer<DeleteMonitoringScheduleRequest.Builder> deleteMonitoringScheduleRequest)

      Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.


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

      Parameters:
      deleteMonitoringScheduleRequest - A Consumer that will call methods on DeleteMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebookInstance

      default CompletableFuture<DeleteNotebookInstanceResponse> deleteNotebookInstance(DeleteNotebookInstanceRequest deleteNotebookInstanceRequest)

      Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

      When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

      Parameters:
      deleteNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the DeleteNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebookInstance

      default CompletableFuture<DeleteNotebookInstanceResponse> deleteNotebookInstance(Consumer<DeleteNotebookInstanceRequest.Builder> deleteNotebookInstanceRequest)

      Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

      When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.


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

      Parameters:
      deleteNotebookInstanceRequest - A Consumer that will call methods on DeleteNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebookInstanceLifecycleConfig

      default CompletableFuture<DeleteNotebookInstanceLifecycleConfigResponse> deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest)

      Deletes a notebook instance lifecycle configuration.

      Parameters:
      deleteNotebookInstanceLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the DeleteNotebookInstanceLifecycleConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebookInstanceLifecycleConfig

      default CompletableFuture<DeleteNotebookInstanceLifecycleConfigResponse> deleteNotebookInstanceLifecycleConfig(Consumer<DeleteNotebookInstanceLifecycleConfigRequest.Builder> deleteNotebookInstanceLifecycleConfigRequest)

      Deletes a notebook instance lifecycle configuration.


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

      Parameters:
      deleteNotebookInstanceLifecycleConfigRequest - A Consumer that will call methods on DeleteNotebookInstanceLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNotebookInstanceLifecycleConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)

      Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

      Parameters:
      deletePipelineRequest -
      Returns:
      A Java Future containing the result of the DeletePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)

      Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.


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

      Parameters:
      deletePipelineRequest - A Consumer that will call methods on DeletePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteProject

      default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)

      Delete the specified project.

      Parameters:
      deleteProjectRequest -
      Returns:
      A Java Future containing the result of the DeleteProject 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteProject

      default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)

      Delete the specified project.


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

      Parameters:
      deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProject 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSpace

      default CompletableFuture<DeleteSpaceResponse> deleteSpace(DeleteSpaceRequest deleteSpaceRequest)

      Used to delete a space.

      Parameters:
      deleteSpaceRequest -
      Returns:
      A Java Future containing the result of the DeleteSpace 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSpace

      default CompletableFuture<DeleteSpaceResponse> deleteSpace(Consumer<DeleteSpaceRequest.Builder> deleteSpaceRequest)

      Used to delete a space.


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

      Parameters:
      deleteSpaceRequest - A Consumer that will call methods on DeleteSpaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSpace 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStudioLifecycleConfig

      default CompletableFuture<DeleteStudioLifecycleConfigResponse> deleteStudioLifecycleConfig(DeleteStudioLifecycleConfigRequest deleteStudioLifecycleConfigRequest)

      Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

      Parameters:
      deleteStudioLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the DeleteStudioLifecycleConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStudioLifecycleConfig

      default CompletableFuture<DeleteStudioLifecycleConfigResponse> deleteStudioLifecycleConfig(Consumer<DeleteStudioLifecycleConfigRequest.Builder> deleteStudioLifecycleConfigRequest)

      Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.


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

      Parameters:
      deleteStudioLifecycleConfigRequest - A Consumer that will call methods on DeleteStudioLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStudioLifecycleConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)

      Deletes the specified tags from an SageMaker resource.

      To list a resource's tags, use the ListTags API.

      When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

      When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

      Parameters:
      deleteTagsRequest -
      Returns:
      A Java Future containing the result of the DeleteTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTags

      default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)

      Deletes the specified tags from an SageMaker resource.

      To list a resource's tags, use the ListTags API.

      When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

      When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.


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

      Parameters:
      deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrial

      default CompletableFuture<DeleteTrialResponse> deleteTrial(DeleteTrialRequest deleteTrialRequest)

      Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

      Parameters:
      deleteTrialRequest -
      Returns:
      A Java Future containing the result of the DeleteTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrial

      default CompletableFuture<DeleteTrialResponse> deleteTrial(Consumer<DeleteTrialRequest.Builder> deleteTrialRequest)

      Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.


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

      Parameters:
      deleteTrialRequest - A Consumer that will call methods on DeleteTrialRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrialComponent

      default CompletableFuture<DeleteTrialComponentResponse> deleteTrialComponent(DeleteTrialComponentRequest deleteTrialComponentRequest)

      Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

      Parameters:
      deleteTrialComponentRequest -
      Returns:
      A Java Future containing the result of the DeleteTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrialComponent

      default CompletableFuture<DeleteTrialComponentResponse> deleteTrialComponent(Consumer<DeleteTrialComponentRequest.Builder> deleteTrialComponentRequest)

      Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.


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

      Parameters:
      deleteTrialComponentRequest - A Consumer that will call methods on DeleteTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserProfile

      default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest)

      Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

      Parameters:
      deleteUserProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteUserProfile 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserProfile

      default CompletableFuture<DeleteUserProfileResponse> deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest)

      Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.


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

      Parameters:
      deleteUserProfileRequest - A Consumer that will call methods on DeleteUserProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserProfile 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkforce

      default CompletableFuture<DeleteWorkforceResponse> deleteWorkforce(DeleteWorkforceRequest deleteWorkforceRequest)

      Use this operation to delete a workforce.

      If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

      If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

      Parameters:
      deleteWorkforceRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkforce

      default CompletableFuture<DeleteWorkforceResponse> deleteWorkforce(Consumer<DeleteWorkforceRequest.Builder> deleteWorkforceRequest)

      Use this operation to delete a workforce.

      If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

      If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.


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

      Parameters:
      deleteWorkforceRequest - A Consumer that will call methods on DeleteWorkforceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkteam

      default CompletableFuture<DeleteWorkteamResponse> deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest)

      Deletes an existing work team. This operation can't be undone.

      Parameters:
      deleteWorkteamRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkteam 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkteam

      default CompletableFuture<DeleteWorkteamResponse> deleteWorkteam(Consumer<DeleteWorkteamRequest.Builder> deleteWorkteamRequest)

      Deletes an existing work team. This operation can't be undone.


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

      Parameters:
      deleteWorkteamRequest - A Consumer that will call methods on DeleteWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkteam 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterDevices

      default CompletableFuture<DeregisterDevicesResponse> deregisterDevices(DeregisterDevicesRequest deregisterDevicesRequest)

      Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

      Parameters:
      deregisterDevicesRequest -
      Returns:
      A Java Future containing the result of the DeregisterDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterDevices

      default CompletableFuture<DeregisterDevicesResponse> deregisterDevices(Consumer<DeregisterDevicesRequest.Builder> deregisterDevicesRequest)

      Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.


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

      Parameters:
      deregisterDevicesRequest - A Consumer that will call methods on DeregisterDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAction

      default CompletableFuture<DescribeActionResponse> describeAction(DescribeActionRequest describeActionRequest)

      Describes an action.

      Parameters:
      describeActionRequest -
      Returns:
      A Java Future containing the result of the DescribeAction 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAction

      default CompletableFuture<DescribeActionResponse> describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest)

      Describes an action.


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

      Parameters:
      describeActionRequest - A Consumer that will call methods on DescribeActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAction 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAlgorithm

      default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)

      Returns a description of the specified algorithm that is in your account.

      Parameters:
      describeAlgorithmRequest -
      Returns:
      A Java Future containing the result of the DescribeAlgorithm 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAlgorithm

      default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)

      Returns a description of the specified algorithm that is in your account.


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

      Parameters:
      describeAlgorithmRequest - A Consumer that will call methods on DescribeAlgorithmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAlgorithm 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApp

      default CompletableFuture<DescribeAppResponse> describeApp(DescribeAppRequest describeAppRequest)

      Describes the app.

      Parameters:
      describeAppRequest -
      Returns:
      A Java Future containing the result of the DescribeApp 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApp

      default CompletableFuture<DescribeAppResponse> describeApp(Consumer<DescribeAppRequest.Builder> describeAppRequest)

      Describes the app.


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

      Parameters:
      describeAppRequest - A Consumer that will call methods on DescribeAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeApp 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAppImageConfig

      default CompletableFuture<DescribeAppImageConfigResponse> describeAppImageConfig(DescribeAppImageConfigRequest describeAppImageConfigRequest)

      Describes an AppImageConfig.

      Parameters:
      describeAppImageConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAppImageConfig

      default CompletableFuture<DescribeAppImageConfigResponse> describeAppImageConfig(Consumer<DescribeAppImageConfigRequest.Builder> describeAppImageConfigRequest)

      Describes an AppImageConfig.


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

      Parameters:
      describeAppImageConfigRequest - A Consumer that will call methods on DescribeAppImageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeArtifact

      default CompletableFuture<DescribeArtifactResponse> describeArtifact(DescribeArtifactRequest describeArtifactRequest)

      Describes an artifact.

      Parameters:
      describeArtifactRequest -
      Returns:
      A Java Future containing the result of the DescribeArtifact 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeArtifact

      default CompletableFuture<DescribeArtifactResponse> describeArtifact(Consumer<DescribeArtifactRequest.Builder> describeArtifactRequest)

      Describes an artifact.


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

      Parameters:
      describeArtifactRequest - A Consumer that will call methods on DescribeArtifactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeArtifact 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutoMLJob

      default CompletableFuture<DescribeAutoMlJobResponse> describeAutoMLJob(DescribeAutoMlJobRequest describeAutoMlJobRequest)

      Returns information about an AutoML job created by calling CreateAutoMLJob.

      AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.

      Parameters:
      describeAutoMlJobRequest -
      Returns:
      A Java Future containing the result of the DescribeAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutoMLJob

      default CompletableFuture<DescribeAutoMlJobResponse> describeAutoMLJob(Consumer<DescribeAutoMlJobRequest.Builder> describeAutoMlJobRequest)

      Returns information about an AutoML job created by calling CreateAutoMLJob.

      AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.


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

      Parameters:
      describeAutoMlJobRequest - A Consumer that will call methods on DescribeAutoMlJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutoMLJobV2

      default CompletableFuture<DescribeAutoMlJobV2Response> describeAutoMLJobV2(DescribeAutoMlJobV2Request describeAutoMlJobV2Request)

      Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.

      Parameters:
      describeAutoMlJobV2Request -
      Returns:
      A Java Future containing the result of the DescribeAutoMLJobV2 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAutoMLJobV2

      default CompletableFuture<DescribeAutoMlJobV2Response> describeAutoMLJobV2(Consumer<DescribeAutoMlJobV2Request.Builder> describeAutoMlJobV2Request)

      Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.


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

      Parameters:
      describeAutoMlJobV2Request - A Consumer that will call methods on DescribeAutoMlJobV2Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAutoMLJobV2 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(DescribeClusterRequest describeClusterRequest)

      Retrieves information of a SageMaker HyperPod cluster.

      Parameters:
      describeClusterRequest -
      Returns:
      A Java Future containing the result of the DescribeCluster 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCluster

      default CompletableFuture<DescribeClusterResponse> describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

      Retrieves information of a SageMaker HyperPod cluster.


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

      Parameters:
      describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCluster 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClusterNode

      default CompletableFuture<DescribeClusterNodeResponse> describeClusterNode(DescribeClusterNodeRequest describeClusterNodeRequest)

      Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

      Parameters:
      describeClusterNodeRequest -
      Returns:
      A Java Future containing the result of the DescribeClusterNode 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeClusterNode

      default CompletableFuture<DescribeClusterNodeResponse> describeClusterNode(Consumer<DescribeClusterNodeRequest.Builder> describeClusterNodeRequest)

      Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.


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

      Parameters:
      describeClusterNodeRequest - A Consumer that will call methods on DescribeClusterNodeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeClusterNode 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCodeRepository

      default CompletableFuture<DescribeCodeRepositoryResponse> describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest)

      Gets details about the specified Git repository.

      Parameters:
      describeCodeRepositoryRequest -
      Returns:
      A Java Future containing the result of the DescribeCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCodeRepository

      default CompletableFuture<DescribeCodeRepositoryResponse> describeCodeRepository(Consumer<DescribeCodeRepositoryRequest.Builder> describeCodeRepositoryRequest)

      Gets details about the specified Git repository.


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

      Parameters:
      describeCodeRepositoryRequest - A Consumer that will call methods on DescribeCodeRepositoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCodeRepository 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCompilationJob

      default CompletableFuture<DescribeCompilationJobResponse> describeCompilationJob(DescribeCompilationJobRequest describeCompilationJobRequest)

      Returns information about a model compilation job.

      To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

      Parameters:
      describeCompilationJobRequest -
      Returns:
      A Java Future containing the result of the DescribeCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeCompilationJob

      default CompletableFuture<DescribeCompilationJobResponse> describeCompilationJob(Consumer<DescribeCompilationJobRequest.Builder> describeCompilationJobRequest)

      Returns information about a model compilation job.

      To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.


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

      Parameters:
      describeCompilationJobRequest - A Consumer that will call methods on DescribeCompilationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContext

      default CompletableFuture<DescribeContextResponse> describeContext(DescribeContextRequest describeContextRequest)

      Describes a context.

      Parameters:
      describeContextRequest -
      Returns:
      A Java Future containing the result of the DescribeContext 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContext

      default CompletableFuture<DescribeContextResponse> describeContext(Consumer<DescribeContextRequest.Builder> describeContextRequest)

      Describes a context.


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

      Parameters:
      describeContextRequest - A Consumer that will call methods on DescribeContextRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContext 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataQualityJobDefinition

      default CompletableFuture<DescribeDataQualityJobDefinitionResponse> describeDataQualityJobDefinition(DescribeDataQualityJobDefinitionRequest describeDataQualityJobDefinitionRequest)

      Gets the details of a data quality monitoring job definition.

      Parameters:
      describeDataQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeDataQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataQualityJobDefinition

      default CompletableFuture<DescribeDataQualityJobDefinitionResponse> describeDataQualityJobDefinition(Consumer<DescribeDataQualityJobDefinitionRequest.Builder> describeDataQualityJobDefinitionRequest)

      Gets the details of a data quality monitoring job definition.


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

      Parameters:
      describeDataQualityJobDefinitionRequest - A Consumer that will call methods on DescribeDataQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDevice

      default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest)

      Describes the device.

      Parameters:
      describeDeviceRequest -
      Returns:
      A Java Future containing the result of the DescribeDevice 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDevice

      default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)

      Describes the device.


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

      Parameters:
      describeDeviceRequest - A Consumer that will call methods on DescribeDeviceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDevice 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDeviceFleet

      default CompletableFuture<DescribeDeviceFleetResponse> describeDeviceFleet(DescribeDeviceFleetRequest describeDeviceFleetRequest)

      A description of the fleet the device belongs to.

      Parameters:
      describeDeviceFleetRequest -
      Returns:
      A Java Future containing the result of the DescribeDeviceFleet 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDeviceFleet

      default CompletableFuture<DescribeDeviceFleetResponse> describeDeviceFleet(Consumer<DescribeDeviceFleetRequest.Builder> describeDeviceFleetRequest)

      A description of the fleet the device belongs to.


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

      Parameters:
      describeDeviceFleetRequest - A Consumer that will call methods on DescribeDeviceFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDeviceFleet 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest)

      The description of the domain.

      Parameters:
      describeDomainRequest -
      Returns:
      A Java Future containing the result of the DescribeDomain 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)

      The description of the domain.


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

      Parameters:
      describeDomainRequest - A Consumer that will call methods on DescribeDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDomain 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEdgeDeploymentPlan

      default CompletableFuture<DescribeEdgeDeploymentPlanResponse> describeEdgeDeploymentPlan(DescribeEdgeDeploymentPlanRequest describeEdgeDeploymentPlanRequest)

      Describes an edge deployment plan with deployment status per stage.

      Parameters:
      describeEdgeDeploymentPlanRequest -
      Returns:
      A Java Future containing the result of the DescribeEdgeDeploymentPlan 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEdgeDeploymentPlan

      default CompletableFuture<DescribeEdgeDeploymentPlanResponse> describeEdgeDeploymentPlan(Consumer<DescribeEdgeDeploymentPlanRequest.Builder> describeEdgeDeploymentPlanRequest)

      Describes an edge deployment plan with deployment status per stage.


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

      Parameters:
      describeEdgeDeploymentPlanRequest - A Consumer that will call methods on DescribeEdgeDeploymentPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEdgeDeploymentPlan 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEdgePackagingJob

      default CompletableFuture<DescribeEdgePackagingJobResponse> describeEdgePackagingJob(DescribeEdgePackagingJobRequest describeEdgePackagingJobRequest)

      A description of edge packaging jobs.

      Parameters:
      describeEdgePackagingJobRequest -
      Returns:
      A Java Future containing the result of the DescribeEdgePackagingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEdgePackagingJob

      default CompletableFuture<DescribeEdgePackagingJobResponse> describeEdgePackagingJob(Consumer<DescribeEdgePackagingJobRequest.Builder> describeEdgePackagingJobRequest)

      A description of edge packaging jobs.


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

      Parameters:
      describeEdgePackagingJobRequest - A Consumer that will call methods on DescribeEdgePackagingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEdgePackagingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpoint

      default CompletableFuture<DescribeEndpointResponse> describeEndpoint(DescribeEndpointRequest describeEndpointRequest)

      Returns the description of an endpoint.

      Parameters:
      describeEndpointRequest -
      Returns:
      A Java Future containing the result of the DescribeEndpoint 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpoint

      default CompletableFuture<DescribeEndpointResponse> describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest)

      Returns the description of an endpoint.


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

      Parameters:
      describeEndpointRequest - A Consumer that will call methods on DescribeEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEndpoint 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpointConfig

      default CompletableFuture<DescribeEndpointConfigResponse> describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest)

      Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

      Parameters:
      describeEndpointConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeEndpointConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEndpointConfig

      default CompletableFuture<DescribeEndpointConfigResponse> describeEndpointConfig(Consumer<DescribeEndpointConfigRequest.Builder> describeEndpointConfigRequest)

      Returns the description of an endpoint configuration created using the CreateEndpointConfig API.


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

      Parameters:
      describeEndpointConfigRequest - A Consumer that will call methods on DescribeEndpointConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEndpointConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExperiment

      default CompletableFuture<DescribeExperimentResponse> describeExperiment(DescribeExperimentRequest describeExperimentRequest)

      Provides a list of an experiment's properties.

      Parameters:
      describeExperimentRequest -
      Returns:
      A Java Future containing the result of the DescribeExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExperiment

      default CompletableFuture<DescribeExperimentResponse> describeExperiment(Consumer<DescribeExperimentRequest.Builder> describeExperimentRequest)

      Provides a list of an experiment's properties.


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

      Parameters:
      describeExperimentRequest - A Consumer that will call methods on DescribeExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeatureGroup

      default CompletableFuture<DescribeFeatureGroupResponse> describeFeatureGroup(DescribeFeatureGroupRequest describeFeatureGroupRequest)

      Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

      Parameters:
      describeFeatureGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeatureGroup

      default CompletableFuture<DescribeFeatureGroupResponse> describeFeatureGroup(Consumer<DescribeFeatureGroupRequest.Builder> describeFeatureGroupRequest)

      Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.


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

      Parameters:
      describeFeatureGroupRequest - A Consumer that will call methods on DescribeFeatureGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeatureMetadata

      default CompletableFuture<DescribeFeatureMetadataResponse> describeFeatureMetadata(DescribeFeatureMetadataRequest describeFeatureMetadataRequest)

      Shows the metadata for a feature within a feature group.

      Parameters:
      describeFeatureMetadataRequest -
      Returns:
      A Java Future containing the result of the DescribeFeatureMetadata 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFeatureMetadata

      default CompletableFuture<DescribeFeatureMetadataResponse> describeFeatureMetadata(Consumer<DescribeFeatureMetadataRequest.Builder> describeFeatureMetadataRequest)

      Shows the metadata for a feature within a feature group.


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

      Parameters:
      describeFeatureMetadataRequest - A Consumer that will call methods on DescribeFeatureMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFeatureMetadata 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowDefinition

      default CompletableFuture<DescribeFlowDefinitionResponse> describeFlowDefinition(DescribeFlowDefinitionRequest describeFlowDefinitionRequest)

      Returns information about the specified flow definition.

      Parameters:
      describeFlowDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeFlowDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowDefinition

      default CompletableFuture<DescribeFlowDefinitionResponse> describeFlowDefinition(Consumer<DescribeFlowDefinitionRequest.Builder> describeFlowDefinitionRequest)

      Returns information about the specified flow definition.


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

      Parameters:
      describeFlowDefinitionRequest - A Consumer that will call methods on DescribeFlowDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFlowDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHub

      default CompletableFuture<DescribeHubResponse> describeHub(DescribeHubRequest describeHubRequest)

      Describe a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      describeHubRequest -
      Returns:
      A Java Future containing the result of the DescribeHub 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHub

      default CompletableFuture<DescribeHubResponse> describeHub(Consumer<DescribeHubRequest.Builder> describeHubRequest)

      Describe a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      describeHubRequest - A Consumer that will call methods on DescribeHubRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHub 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHubContent

      default CompletableFuture<DescribeHubContentResponse> describeHubContent(DescribeHubContentRequest describeHubContentRequest)

      Describe the content of a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      describeHubContentRequest -
      Returns:
      A Java Future containing the result of the DescribeHubContent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHubContent

      default CompletableFuture<DescribeHubContentResponse> describeHubContent(Consumer<DescribeHubContentRequest.Builder> describeHubContentRequest)

      Describe the content of a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      describeHubContentRequest - A Consumer that will call methods on DescribeHubContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHubContent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHumanTaskUi

      default CompletableFuture<DescribeHumanTaskUiResponse> describeHumanTaskUi(DescribeHumanTaskUiRequest describeHumanTaskUiRequest)

      Returns information about the requested human task user interface (worker task template).

      Parameters:
      describeHumanTaskUiRequest -
      Returns:
      A Java Future containing the result of the DescribeHumanTaskUi 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHumanTaskUi

      default CompletableFuture<DescribeHumanTaskUiResponse> describeHumanTaskUi(Consumer<DescribeHumanTaskUiRequest.Builder> describeHumanTaskUiRequest)

      Returns information about the requested human task user interface (worker task template).


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

      Parameters:
      describeHumanTaskUiRequest - A Consumer that will call methods on DescribeHumanTaskUiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHumanTaskUi 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHyperParameterTuningJob

      default CompletableFuture<DescribeHyperParameterTuningJobResponse> describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest)

      Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

      Parameters:
      describeHyperParameterTuningJobRequest -
      Returns:
      A Java Future containing the result of the DescribeHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHyperParameterTuningJob

      default CompletableFuture<DescribeHyperParameterTuningJobResponse> describeHyperParameterTuningJob(Consumer<DescribeHyperParameterTuningJobRequest.Builder> describeHyperParameterTuningJobRequest)

      Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.


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

      Parameters:
      describeHyperParameterTuningJobRequest - A Consumer that will call methods on DescribeHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImage

      default CompletableFuture<DescribeImageResponse> describeImage(DescribeImageRequest describeImageRequest)

      Describes a SageMaker image.

      Parameters:
      describeImageRequest -
      Returns:
      A Java Future containing the result of the DescribeImage 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImage

      default CompletableFuture<DescribeImageResponse> describeImage(Consumer<DescribeImageRequest.Builder> describeImageRequest)

      Describes a SageMaker image.


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

      Parameters:
      describeImageRequest - A Consumer that will call methods on DescribeImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeImage 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImageVersion

      default CompletableFuture<DescribeImageVersionResponse> describeImageVersion(DescribeImageVersionRequest describeImageVersionRequest)

      Describes a version of a SageMaker image.

      Parameters:
      describeImageVersionRequest -
      Returns:
      A Java Future containing the result of the DescribeImageVersion 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeImageVersion

      default CompletableFuture<DescribeImageVersionResponse> describeImageVersion(Consumer<DescribeImageVersionRequest.Builder> describeImageVersionRequest)

      Describes a version of a SageMaker image.


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

      Parameters:
      describeImageVersionRequest - A Consumer that will call methods on DescribeImageVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeImageVersion 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceComponent

      default CompletableFuture<DescribeInferenceComponentResponse> describeInferenceComponent(DescribeInferenceComponentRequest describeInferenceComponentRequest)

      Returns information about an inference component.

      Parameters:
      describeInferenceComponentRequest -
      Returns:
      A Java Future containing the result of the DescribeInferenceComponent 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceComponent

      default CompletableFuture<DescribeInferenceComponentResponse> describeInferenceComponent(Consumer<DescribeInferenceComponentRequest.Builder> describeInferenceComponentRequest)

      Returns information about an inference component.


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

      Parameters:
      describeInferenceComponentRequest - A Consumer that will call methods on DescribeInferenceComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInferenceComponent 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceExperiment

      default CompletableFuture<DescribeInferenceExperimentResponse> describeInferenceExperiment(DescribeInferenceExperimentRequest describeInferenceExperimentRequest)

      Returns details about an inference experiment.

      Parameters:
      describeInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the DescribeInferenceExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceExperiment

      default CompletableFuture<DescribeInferenceExperimentResponse> describeInferenceExperiment(Consumer<DescribeInferenceExperimentRequest.Builder> describeInferenceExperimentRequest)

      Returns details about an inference experiment.


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

      Parameters:
      describeInferenceExperimentRequest - A Consumer that will call methods on DescribeInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInferenceExperiment 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceRecommendationsJob

      default CompletableFuture<DescribeInferenceRecommendationsJobResponse> describeInferenceRecommendationsJob(DescribeInferenceRecommendationsJobRequest describeInferenceRecommendationsJobRequest)

      Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

      Parameters:
      describeInferenceRecommendationsJobRequest -
      Returns:
      A Java Future containing the result of the DescribeInferenceRecommendationsJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInferenceRecommendationsJob

      default CompletableFuture<DescribeInferenceRecommendationsJobResponse> describeInferenceRecommendationsJob(Consumer<DescribeInferenceRecommendationsJobRequest.Builder> describeInferenceRecommendationsJobRequest)

      Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.


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

      Parameters:
      describeInferenceRecommendationsJobRequest - A Consumer that will call methods on DescribeInferenceRecommendationsJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInferenceRecommendationsJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLabelingJob

      default CompletableFuture<DescribeLabelingJobResponse> describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest)

      Gets information about a labeling job.

      Parameters:
      describeLabelingJobRequest -
      Returns:
      A Java Future containing the result of the DescribeLabelingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLabelingJob

      default CompletableFuture<DescribeLabelingJobResponse> describeLabelingJob(Consumer<DescribeLabelingJobRequest.Builder> describeLabelingJobRequest)

      Gets information about a labeling job.


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

      Parameters:
      describeLabelingJobRequest - A Consumer that will call methods on DescribeLabelingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLabelingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLineageGroup

      default CompletableFuture<DescribeLineageGroupResponse> describeLineageGroup(DescribeLineageGroupRequest describeLineageGroupRequest)

      Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

      Parameters:
      describeLineageGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeLineageGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLineageGroup

      default CompletableFuture<DescribeLineageGroupResponse> describeLineageGroup(Consumer<DescribeLineageGroupRequest.Builder> describeLineageGroupRequest)

      Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.


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

      Parameters:
      describeLineageGroupRequest - A Consumer that will call methods on DescribeLineageGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLineageGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModel

      default CompletableFuture<DescribeModelResponse> describeModel(DescribeModelRequest describeModelRequest)

      Describes a model that you created using the CreateModel API.

      Parameters:
      describeModelRequest -
      Returns:
      A Java Future containing the result of the DescribeModel 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModel

      default CompletableFuture<DescribeModelResponse> describeModel(Consumer<DescribeModelRequest.Builder> describeModelRequest)

      Describes a model that you created using the CreateModel API.


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

      Parameters:
      describeModelRequest - A Consumer that will call methods on DescribeModelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModel 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelBiasJobDefinition

      default CompletableFuture<DescribeModelBiasJobDefinitionResponse> describeModelBiasJobDefinition(DescribeModelBiasJobDefinitionRequest describeModelBiasJobDefinitionRequest)

      Returns a description of a model bias job definition.

      Parameters:
      describeModelBiasJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeModelBiasJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelBiasJobDefinition

      default CompletableFuture<DescribeModelBiasJobDefinitionResponse> describeModelBiasJobDefinition(Consumer<DescribeModelBiasJobDefinitionRequest.Builder> describeModelBiasJobDefinitionRequest)

      Returns a description of a model bias job definition.


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

      Parameters:
      describeModelBiasJobDefinitionRequest - A Consumer that will call methods on DescribeModelBiasJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelBiasJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelCard

      default CompletableFuture<DescribeModelCardResponse> describeModelCard(DescribeModelCardRequest describeModelCardRequest)

      Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

      Parameters:
      describeModelCardRequest -
      Returns:
      A Java Future containing the result of the DescribeModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelCard

      default CompletableFuture<DescribeModelCardResponse> describeModelCard(Consumer<DescribeModelCardRequest.Builder> describeModelCardRequest)

      Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.


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

      Parameters:
      describeModelCardRequest - A Consumer that will call methods on DescribeModelCardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelCardExportJob

      default CompletableFuture<DescribeModelCardExportJobResponse> describeModelCardExportJob(DescribeModelCardExportJobRequest describeModelCardExportJobRequest)

      Describes an Amazon SageMaker Model Card export job.

      Parameters:
      describeModelCardExportJobRequest -
      Returns:
      A Java Future containing the result of the DescribeModelCardExportJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelCardExportJob

      default CompletableFuture<DescribeModelCardExportJobResponse> describeModelCardExportJob(Consumer<DescribeModelCardExportJobRequest.Builder> describeModelCardExportJobRequest)

      Describes an Amazon SageMaker Model Card export job.


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

      Parameters:
      describeModelCardExportJobRequest - A Consumer that will call methods on DescribeModelCardExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelCardExportJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelExplainabilityJobDefinition

      default CompletableFuture<DescribeModelExplainabilityJobDefinitionResponse> describeModelExplainabilityJobDefinition(DescribeModelExplainabilityJobDefinitionRequest describeModelExplainabilityJobDefinitionRequest)

      Returns a description of a model explainability job definition.

      Parameters:
      describeModelExplainabilityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeModelExplainabilityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelExplainabilityJobDefinition

      default CompletableFuture<DescribeModelExplainabilityJobDefinitionResponse> describeModelExplainabilityJobDefinition(Consumer<DescribeModelExplainabilityJobDefinitionRequest.Builder> describeModelExplainabilityJobDefinitionRequest)

      Returns a description of a model explainability job definition.


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

      Parameters:
      describeModelExplainabilityJobDefinitionRequest - A Consumer that will call methods on DescribeModelExplainabilityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelExplainabilityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelPackage

      default CompletableFuture<DescribeModelPackageResponse> describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest)

      Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

      To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

      Parameters:
      describeModelPackageRequest -
      Returns:
      A Java Future containing the result of the DescribeModelPackage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelPackage

      default CompletableFuture<DescribeModelPackageResponse> describeModelPackage(Consumer<DescribeModelPackageRequest.Builder> describeModelPackageRequest)

      Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

      To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.


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

      Parameters:
      describeModelPackageRequest - A Consumer that will call methods on DescribeModelPackageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelPackage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelPackageGroup

      default CompletableFuture<DescribeModelPackageGroupResponse> describeModelPackageGroup(DescribeModelPackageGroupRequest describeModelPackageGroupRequest)

      Gets a description for the specified model group.

      Parameters:
      describeModelPackageGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeModelPackageGroup 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelPackageGroup

      default CompletableFuture<DescribeModelPackageGroupResponse> describeModelPackageGroup(Consumer<DescribeModelPackageGroupRequest.Builder> describeModelPackageGroupRequest)

      Gets a description for the specified model group.


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

      Parameters:
      describeModelPackageGroupRequest - A Consumer that will call methods on DescribeModelPackageGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelPackageGroup 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelQualityJobDefinition

      default CompletableFuture<DescribeModelQualityJobDefinitionResponse> describeModelQualityJobDefinition(DescribeModelQualityJobDefinitionRequest describeModelQualityJobDefinitionRequest)

      Returns a description of a model quality job definition.

      Parameters:
      describeModelQualityJobDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeModelQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeModelQualityJobDefinition

      default CompletableFuture<DescribeModelQualityJobDefinitionResponse> describeModelQualityJobDefinition(Consumer<DescribeModelQualityJobDefinitionRequest.Builder> describeModelQualityJobDefinitionRequest)

      Returns a description of a model quality job definition.


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

      Parameters:
      describeModelQualityJobDefinitionRequest - A Consumer that will call methods on DescribeModelQualityJobDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeModelQualityJobDefinition 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMonitoringSchedule

      default CompletableFuture<DescribeMonitoringScheduleResponse> describeMonitoringSchedule(DescribeMonitoringScheduleRequest describeMonitoringScheduleRequest)

      Describes the schedule for a monitoring job.

      Parameters:
      describeMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the DescribeMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMonitoringSchedule

      default CompletableFuture<DescribeMonitoringScheduleResponse> describeMonitoringSchedule(Consumer<DescribeMonitoringScheduleRequest.Builder> describeMonitoringScheduleRequest)

      Describes the schedule for a monitoring job.


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

      Parameters:
      describeMonitoringScheduleRequest - A Consumer that will call methods on DescribeMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNotebookInstance

      default CompletableFuture<DescribeNotebookInstanceResponse> describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest)

      Returns information about a notebook instance.

      Parameters:
      describeNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the DescribeNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNotebookInstance

      default CompletableFuture<DescribeNotebookInstanceResponse> describeNotebookInstance(Consumer<DescribeNotebookInstanceRequest.Builder> describeNotebookInstanceRequest)

      Returns information about a notebook instance.


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

      Parameters:
      describeNotebookInstanceRequest - A Consumer that will call methods on DescribeNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNotebookInstanceLifecycleConfig

      default CompletableFuture<DescribeNotebookInstanceLifecycleConfigResponse> describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest describeNotebookInstanceLifecycleConfigRequest)

      Returns a description of a notebook instance lifecycle configuration.

      For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

      Parameters:
      describeNotebookInstanceLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeNotebookInstanceLifecycleConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeNotebookInstanceLifecycleConfig

      default CompletableFuture<DescribeNotebookInstanceLifecycleConfigResponse> describeNotebookInstanceLifecycleConfig(Consumer<DescribeNotebookInstanceLifecycleConfigRequest.Builder> describeNotebookInstanceLifecycleConfigRequest)

      Returns a description of a notebook instance lifecycle configuration.

      For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.


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

      Parameters:
      describeNotebookInstanceLifecycleConfigRequest - A Consumer that will call methods on DescribeNotebookInstanceLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeNotebookInstanceLifecycleConfig 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipeline

      default CompletableFuture<DescribePipelineResponse> describePipeline(DescribePipelineRequest describePipelineRequest)

      Describes the details of a pipeline.

      Parameters:
      describePipelineRequest -
      Returns:
      A Java Future containing the result of the DescribePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipeline

      default CompletableFuture<DescribePipelineResponse> describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest)

      Describes the details of a pipeline.


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

      Parameters:
      describePipelineRequest - A Consumer that will call methods on DescribePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipelineDefinitionForExecution

      default CompletableFuture<DescribePipelineDefinitionForExecutionResponse> describePipelineDefinitionForExecution(DescribePipelineDefinitionForExecutionRequest describePipelineDefinitionForExecutionRequest)

      Describes the details of an execution's pipeline definition.

      Parameters:
      describePipelineDefinitionForExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribePipelineDefinitionForExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipelineDefinitionForExecution

      default CompletableFuture<DescribePipelineDefinitionForExecutionResponse> describePipelineDefinitionForExecution(Consumer<DescribePipelineDefinitionForExecutionRequest.Builder> describePipelineDefinitionForExecutionRequest)

      Describes the details of an execution's pipeline definition.


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

      Parameters:
      describePipelineDefinitionForExecutionRequest - A Consumer that will call methods on DescribePipelineDefinitionForExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePipelineDefinitionForExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipelineExecution

      default CompletableFuture<DescribePipelineExecutionResponse> describePipelineExecution(DescribePipelineExecutionRequest describePipelineExecutionRequest)

      Describes the details of a pipeline execution.

      Parameters:
      describePipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribePipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipelineExecution

      default CompletableFuture<DescribePipelineExecutionResponse> describePipelineExecution(Consumer<DescribePipelineExecutionRequest.Builder> describePipelineExecutionRequest)

      Describes the details of a pipeline execution.


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

      Parameters:
      describePipelineExecutionRequest - A Consumer that will call methods on DescribePipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProcessingJob

      default CompletableFuture<DescribeProcessingJobResponse> describeProcessingJob(DescribeProcessingJobRequest describeProcessingJobRequest)

      Returns a description of a processing job.

      Parameters:
      describeProcessingJobRequest -
      Returns:
      A Java Future containing the result of the DescribeProcessingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProcessingJob

      default CompletableFuture<DescribeProcessingJobResponse> describeProcessingJob(Consumer<DescribeProcessingJobRequest.Builder> describeProcessingJobRequest)

      Returns a description of a processing job.


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

      Parameters:
      describeProcessingJobRequest - A Consumer that will call methods on DescribeProcessingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProcessingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProject

      default CompletableFuture<DescribeProjectResponse> describeProject(DescribeProjectRequest describeProjectRequest)

      Describes the details of a project.

      Parameters:
      describeProjectRequest -
      Returns:
      A Java Future containing the result of the DescribeProject 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeProject

      default CompletableFuture<DescribeProjectResponse> describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)

      Describes the details of a project.


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

      Parameters:
      describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProject 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSpace

      default CompletableFuture<DescribeSpaceResponse> describeSpace(DescribeSpaceRequest describeSpaceRequest)

      Describes the space.

      Parameters:
      describeSpaceRequest -
      Returns:
      A Java Future containing the result of the DescribeSpace 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSpace

      default CompletableFuture<DescribeSpaceResponse> describeSpace(Consumer<DescribeSpaceRequest.Builder> describeSpaceRequest)

      Describes the space.


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

      Parameters:
      describeSpaceRequest - A Consumer that will call methods on DescribeSpaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSpace 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStudioLifecycleConfig

      default CompletableFuture<DescribeStudioLifecycleConfigResponse> describeStudioLifecycleConfig(DescribeStudioLifecycleConfigRequest describeStudioLifecycleConfigRequest)

      Describes the Amazon SageMaker Studio Lifecycle Configuration.

      Parameters:
      describeStudioLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeStudioLifecycleConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStudioLifecycleConfig

      default CompletableFuture<DescribeStudioLifecycleConfigResponse> describeStudioLifecycleConfig(Consumer<DescribeStudioLifecycleConfigRequest.Builder> describeStudioLifecycleConfigRequest)

      Describes the Amazon SageMaker Studio Lifecycle Configuration.


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

      Parameters:
      describeStudioLifecycleConfigRequest - A Consumer that will call methods on DescribeStudioLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStudioLifecycleConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSubscribedWorkteam

      default CompletableFuture<DescribeSubscribedWorkteamResponse> describeSubscribedWorkteam(DescribeSubscribedWorkteamRequest describeSubscribedWorkteamRequest)

      Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

      Parameters:
      describeSubscribedWorkteamRequest -
      Returns:
      A Java Future containing the result of the DescribeSubscribedWorkteam 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSubscribedWorkteam

      default CompletableFuture<DescribeSubscribedWorkteamResponse> describeSubscribedWorkteam(Consumer<DescribeSubscribedWorkteamRequest.Builder> describeSubscribedWorkteamRequest)

      Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.


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

      Parameters:
      describeSubscribedWorkteamRequest - A Consumer that will call methods on DescribeSubscribedWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSubscribedWorkteam 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrainingJob

      default CompletableFuture<DescribeTrainingJobResponse> describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest)

      Returns information about a training job.

      Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.

      Parameters:
      describeTrainingJobRequest -
      Returns:
      A Java Future containing the result of the DescribeTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrainingJob

      default CompletableFuture<DescribeTrainingJobResponse> describeTrainingJob(Consumer<DescribeTrainingJobRequest.Builder> describeTrainingJobRequest)

      Returns information about a training job.

      Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.


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

      Parameters:
      describeTrainingJobRequest - A Consumer that will call methods on DescribeTrainingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTransformJob

      default CompletableFuture<DescribeTransformJobResponse> describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest)

      Returns information about a transform job.

      Parameters:
      describeTransformJobRequest -
      Returns:
      A Java Future containing the result of the DescribeTransformJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTransformJob

      default CompletableFuture<DescribeTransformJobResponse> describeTransformJob(Consumer<DescribeTransformJobRequest.Builder> describeTransformJobRequest)

      Returns information about a transform job.


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

      Parameters:
      describeTransformJobRequest - A Consumer that will call methods on DescribeTransformJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTransformJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrial

      default CompletableFuture<DescribeTrialResponse> describeTrial(DescribeTrialRequest describeTrialRequest)

      Provides a list of a trial's properties.

      Parameters:
      describeTrialRequest -
      Returns:
      A Java Future containing the result of the DescribeTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrial

      default CompletableFuture<DescribeTrialResponse> describeTrial(Consumer<DescribeTrialRequest.Builder> describeTrialRequest)

      Provides a list of a trial's properties.


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

      Parameters:
      describeTrialRequest - A Consumer that will call methods on DescribeTrialRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrial 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrialComponent

      default CompletableFuture<DescribeTrialComponentResponse> describeTrialComponent(DescribeTrialComponentRequest describeTrialComponentRequest)

      Provides a list of a trials component's properties.

      Parameters:
      describeTrialComponentRequest -
      Returns:
      A Java Future containing the result of the DescribeTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrialComponent

      default CompletableFuture<DescribeTrialComponentResponse> describeTrialComponent(Consumer<DescribeTrialComponentRequest.Builder> describeTrialComponentRequest)

      Provides a list of a trials component's properties.


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

      Parameters:
      describeTrialComponentRequest - A Consumer that will call methods on DescribeTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserProfile

      default CompletableFuture<DescribeUserProfileResponse> describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest)

      Describes a user profile. For more information, see CreateUserProfile.

      Parameters:
      describeUserProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeUserProfile 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserProfile

      default CompletableFuture<DescribeUserProfileResponse> describeUserProfile(Consumer<DescribeUserProfileRequest.Builder> describeUserProfileRequest)

      Describes a user profile. For more information, see CreateUserProfile.


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

      Parameters:
      describeUserProfileRequest - A Consumer that will call methods on DescribeUserProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUserProfile 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkforce

      default CompletableFuture<DescribeWorkforceResponse> describeWorkforce(DescribeWorkforceRequest describeWorkforceRequest)

      Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

      This operation applies only to private workforces.

      Parameters:
      describeWorkforceRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkforce

      default CompletableFuture<DescribeWorkforceResponse> describeWorkforce(Consumer<DescribeWorkforceRequest.Builder> describeWorkforceRequest)

      Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

      This operation applies only to private workforces.


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

      Parameters:
      describeWorkforceRequest - A Consumer that will call methods on DescribeWorkforceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkforce 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkteam

      default CompletableFuture<DescribeWorkteamResponse> describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest)

      Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

      Parameters:
      describeWorkteamRequest -
      Returns:
      A Java Future containing the result of the DescribeWorkteam 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeWorkteam

      default CompletableFuture<DescribeWorkteamResponse> describeWorkteam(Consumer<DescribeWorkteamRequest.Builder> describeWorkteamRequest)

      Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).


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

      Parameters:
      describeWorkteamRequest - A Consumer that will call methods on DescribeWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeWorkteam 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableSagemakerServicecatalogPortfolio

      default CompletableFuture<DisableSagemakerServicecatalogPortfolioResponse> disableSagemakerServicecatalogPortfolio(DisableSagemakerServicecatalogPortfolioRequest disableSagemakerServicecatalogPortfolioRequest)

      Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

      Parameters:
      disableSagemakerServicecatalogPortfolioRequest -
      Returns:
      A Java Future containing the result of the DisableSagemakerServicecatalogPortfolio 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableSagemakerServicecatalogPortfolio

      default CompletableFuture<DisableSagemakerServicecatalogPortfolioResponse> disableSagemakerServicecatalogPortfolio(Consumer<DisableSagemakerServicecatalogPortfolioRequest.Builder> disableSagemakerServicecatalogPortfolioRequest)

      Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.


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

      Parameters:
      disableSagemakerServicecatalogPortfolioRequest - A Consumer that will call methods on DisableSagemakerServicecatalogPortfolioRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableSagemakerServicecatalogPortfolio 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTrialComponent

      default CompletableFuture<DisassociateTrialComponentResponse> disassociateTrialComponent(DisassociateTrialComponentRequest disassociateTrialComponentRequest)

      Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

      To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.

      Parameters:
      disassociateTrialComponentRequest -
      Returns:
      A Java Future containing the result of the DisassociateTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTrialComponent

      default CompletableFuture<DisassociateTrialComponentResponse> disassociateTrialComponent(Consumer<DisassociateTrialComponentRequest.Builder> disassociateTrialComponentRequest)

      Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.

      To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.


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

      Parameters:
      disassociateTrialComponentRequest - A Consumer that will call methods on DisassociateTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateTrialComponent 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableSagemakerServicecatalogPortfolio

      default CompletableFuture<EnableSagemakerServicecatalogPortfolioResponse> enableSagemakerServicecatalogPortfolio(EnableSagemakerServicecatalogPortfolioRequest enableSagemakerServicecatalogPortfolioRequest)

      Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

      Parameters:
      enableSagemakerServicecatalogPortfolioRequest -
      Returns:
      A Java Future containing the result of the EnableSagemakerServicecatalogPortfolio 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableSagemakerServicecatalogPortfolio

      default CompletableFuture<EnableSagemakerServicecatalogPortfolioResponse> enableSagemakerServicecatalogPortfolio(Consumer<EnableSagemakerServicecatalogPortfolioRequest.Builder> enableSagemakerServicecatalogPortfolioRequest)

      Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.


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

      Parameters:
      enableSagemakerServicecatalogPortfolioRequest - A Consumer that will call methods on EnableSagemakerServicecatalogPortfolioRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableSagemakerServicecatalogPortfolio 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDeviceFleetReport

      default CompletableFuture<GetDeviceFleetReportResponse> getDeviceFleetReport(GetDeviceFleetReportRequest getDeviceFleetReportRequest)

      Describes a fleet.

      Parameters:
      getDeviceFleetReportRequest -
      Returns:
      A Java Future containing the result of the GetDeviceFleetReport 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDeviceFleetReport

      default CompletableFuture<GetDeviceFleetReportResponse> getDeviceFleetReport(Consumer<GetDeviceFleetReportRequest.Builder> getDeviceFleetReportRequest)

      Describes a fleet.


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

      Parameters:
      getDeviceFleetReportRequest - A Consumer that will call methods on GetDeviceFleetReportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDeviceFleetReport 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLineageGroupPolicy

      default CompletableFuture<GetLineageGroupPolicyResponse> getLineageGroupPolicy(GetLineageGroupPolicyRequest getLineageGroupPolicyRequest)

      The resource policy for the lineage group.

      Parameters:
      getLineageGroupPolicyRequest -
      Returns:
      A Java Future containing the result of the GetLineageGroupPolicy 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLineageGroupPolicy

      default CompletableFuture<GetLineageGroupPolicyResponse> getLineageGroupPolicy(Consumer<GetLineageGroupPolicyRequest.Builder> getLineageGroupPolicyRequest)

      The resource policy for the lineage group.


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

      Parameters:
      getLineageGroupPolicyRequest - A Consumer that will call methods on GetLineageGroupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLineageGroupPolicy 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getModelPackageGroupPolicy

      default CompletableFuture<GetModelPackageGroupPolicyResponse> getModelPackageGroupPolicy(GetModelPackageGroupPolicyRequest getModelPackageGroupPolicyRequest)

      Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

      Parameters:
      getModelPackageGroupPolicyRequest -
      Returns:
      A Java Future containing the result of the GetModelPackageGroupPolicy 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getModelPackageGroupPolicy

      default CompletableFuture<GetModelPackageGroupPolicyResponse> getModelPackageGroupPolicy(Consumer<GetModelPackageGroupPolicyRequest.Builder> getModelPackageGroupPolicyRequest)

      Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..


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

      Parameters:
      getModelPackageGroupPolicyRequest - A Consumer that will call methods on GetModelPackageGroupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetModelPackageGroupPolicy 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSagemakerServicecatalogPortfolioStatus

      default CompletableFuture<GetSagemakerServicecatalogPortfolioStatusResponse> getSagemakerServicecatalogPortfolioStatus(GetSagemakerServicecatalogPortfolioStatusRequest getSagemakerServicecatalogPortfolioStatusRequest)

      Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

      Parameters:
      getSagemakerServicecatalogPortfolioStatusRequest -
      Returns:
      A Java Future containing the result of the GetSagemakerServicecatalogPortfolioStatus 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSagemakerServicecatalogPortfolioStatus

      default CompletableFuture<GetSagemakerServicecatalogPortfolioStatusResponse> getSagemakerServicecatalogPortfolioStatus(Consumer<GetSagemakerServicecatalogPortfolioStatusRequest.Builder> getSagemakerServicecatalogPortfolioStatusRequest)

      Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.


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

      Parameters:
      getSagemakerServicecatalogPortfolioStatusRequest - A Consumer that will call methods on GetSagemakerServicecatalogPortfolioStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSagemakerServicecatalogPortfolioStatus 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScalingConfigurationRecommendation

      default CompletableFuture<GetScalingConfigurationRecommendationResponse> getScalingConfigurationRecommendation(GetScalingConfigurationRecommendationRequest getScalingConfigurationRecommendationRequest)

      Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

      Parameters:
      getScalingConfigurationRecommendationRequest -
      Returns:
      A Java Future containing the result of the GetScalingConfigurationRecommendation 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScalingConfigurationRecommendation

      default CompletableFuture<GetScalingConfigurationRecommendationResponse> getScalingConfigurationRecommendation(Consumer<GetScalingConfigurationRecommendationRequest.Builder> getScalingConfigurationRecommendationRequest)

      Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.


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

      Parameters:
      getScalingConfigurationRecommendationRequest - A Consumer that will call methods on GetScalingConfigurationRecommendationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetScalingConfigurationRecommendation 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSearchSuggestions

      default CompletableFuture<GetSearchSuggestionsResponse> getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest)

      An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

      Parameters:
      getSearchSuggestionsRequest -
      Returns:
      A Java Future containing the result of the GetSearchSuggestions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSearchSuggestions

      default CompletableFuture<GetSearchSuggestionsResponse> getSearchSuggestions(Consumer<GetSearchSuggestionsRequest.Builder> getSearchSuggestionsRequest)

      An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.


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

      Parameters:
      getSearchSuggestionsRequest - A Consumer that will call methods on GetSearchSuggestionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSearchSuggestions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importHubContent

      default CompletableFuture<ImportHubContentResponse> importHubContent(ImportHubContentRequest importHubContentRequest)

      Import hub content.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      importHubContentRequest -
      Returns:
      A Java Future containing the result of the ImportHubContent 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importHubContent

      default CompletableFuture<ImportHubContentResponse> importHubContent(Consumer<ImportHubContentRequest.Builder> importHubContentRequest)

      Import hub content.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      importHubContentRequest - A Consumer that will call methods on ImportHubContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportHubContent 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(ListActionsRequest listActionsRequest)

      Lists the actions in your account and their properties.

      Parameters:
      listActionsRequest -
      Returns:
      A Java Future containing the result of the ListActions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)

      Lists the actions in your account and their properties.


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListActions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(ListActionsRequest listActionsRequest)

      This is a variant of listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest) operation.

      Parameters:
      listActionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)

      This is a variant of listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest) operation.


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithms

      default CompletableFuture<ListAlgorithmsResponse> listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest)

      Lists the machine learning algorithms that have been created.

      Parameters:
      listAlgorithmsRequest -
      Returns:
      A Java Future containing the result of the ListAlgorithms 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithms

      default CompletableFuture<ListAlgorithmsResponse> listAlgorithms(Consumer<ListAlgorithmsRequest.Builder> listAlgorithmsRequest)

      Lists the machine learning algorithms that have been created.


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

      Parameters:
      listAlgorithmsRequest - A Consumer that will call methods on ListAlgorithmsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAlgorithms 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithms

      default CompletableFuture<ListAlgorithmsResponse> listAlgorithms()

      Lists the machine learning algorithms that have been created.

      Returns:
      A Java Future containing the result of the ListAlgorithms 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithmsPaginator

      default ListAlgorithmsPublisher listAlgorithmsPaginator()

      This is a variant of listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithmsPaginator

      default ListAlgorithmsPublisher listAlgorithmsPaginator(ListAlgorithmsRequest listAlgorithmsRequest)

      This is a variant of listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation.

      Parameters:
      listAlgorithmsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAlgorithmsPaginator

      default ListAlgorithmsPublisher listAlgorithmsPaginator(Consumer<ListAlgorithmsRequest.Builder> listAlgorithmsRequest)

      This is a variant of listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsPublisher publisher = client.listAlgorithmsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest) operation.


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

      Parameters:
      listAlgorithmsRequest - A Consumer that will call methods on ListAlgorithmsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAliases

      default CompletableFuture<ListAliasesResponse> listAliases(ListAliasesRequest listAliasesRequest)

      Lists the aliases of a specified image or image version.

      Parameters:
      listAliasesRequest -
      Returns:
      A Java Future containing the result of the ListAliases 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAliases

      default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)

      Lists the aliases of a specified image or image version.


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

      Parameters:
      listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAliases 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAliasesPaginator

      default ListAliasesPublisher listAliasesPaginator(ListAliasesRequest listAliasesRequest)

      This is a variant of listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest) operation.

      Parameters:
      listAliasesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAliasesPaginator

      default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)

      This is a variant of listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest) operation.


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

      Parameters:
      listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppImageConfigs

      default CompletableFuture<ListAppImageConfigsResponse> listAppImageConfigs(ListAppImageConfigsRequest listAppImageConfigsRequest)

      Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

      Parameters:
      listAppImageConfigsRequest -
      Returns:
      A Java Future containing the result of the ListAppImageConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppImageConfigs

      default CompletableFuture<ListAppImageConfigsResponse> listAppImageConfigs(Consumer<ListAppImageConfigsRequest.Builder> listAppImageConfigsRequest)

      Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.


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

      Parameters:
      listAppImageConfigsRequest - A Consumer that will call methods on ListAppImageConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAppImageConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppImageConfigsPaginator

      default ListAppImageConfigsPublisher listAppImageConfigsPaginator(ListAppImageConfigsRequest listAppImageConfigsRequest)

      This is a variant of listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsPublisher publisher = client.listAppImageConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsPublisher publisher = client.listAppImageConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest) operation.

      Parameters:
      listAppImageConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppImageConfigsPaginator

      default ListAppImageConfigsPublisher listAppImageConfigsPaginator(Consumer<ListAppImageConfigsRequest.Builder> listAppImageConfigsRequest)

      This is a variant of listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsPublisher publisher = client.listAppImageConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsPublisher publisher = client.listAppImageConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest) operation.


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

      Parameters:
      listAppImageConfigsRequest - A Consumer that will call methods on ListAppImageConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApps

      default CompletableFuture<ListAppsResponse> listApps(ListAppsRequest listAppsRequest)

      Lists apps.

      Parameters:
      listAppsRequest -
      Returns:
      A Java Future containing the result of the ListApps 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApps

      default CompletableFuture<ListAppsResponse> listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)

      Lists apps.


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

      Parameters:
      listAppsRequest - A Consumer that will call methods on ListAppsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApps 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppsPaginator

      default ListAppsPublisher listAppsPaginator(ListAppsRequest listAppsRequest)

      This is a variant of listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest) operation.

      Parameters:
      listAppsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppsPaginator

      default ListAppsPublisher listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)

      This is a variant of listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAppsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAppsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest) operation.


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

      Parameters:
      listAppsRequest - A Consumer that will call methods on ListAppsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listArtifacts

      default CompletableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest listArtifactsRequest)

      Lists the artifacts in your account and their properties.

      Parameters:
      listArtifactsRequest -
      Returns:
      A Java Future containing the result of the ListArtifacts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listArtifacts

      default CompletableFuture<ListArtifactsResponse> listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)

      Lists the artifacts in your account and their properties.


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

      Parameters:
      listArtifactsRequest - A Consumer that will call methods on ListArtifactsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListArtifacts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listArtifactsPaginator

      default ListArtifactsPublisher listArtifactsPaginator(ListArtifactsRequest listArtifactsRequest)

      This is a variant of listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsPublisher publisher = client.listArtifactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsPublisher publisher = client.listArtifactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest) operation.

      Parameters:
      listArtifactsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listArtifactsPaginator

      default ListArtifactsPublisher listArtifactsPaginator(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)

      This is a variant of listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsPublisher publisher = client.listArtifactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsPublisher publisher = client.listArtifactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest) operation.


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

      Parameters:
      listArtifactsRequest - A Consumer that will call methods on ListArtifactsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociations

      default CompletableFuture<ListAssociationsResponse> listAssociations(ListAssociationsRequest listAssociationsRequest)

      Lists the associations in your account and their properties.

      Parameters:
      listAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListAssociations 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociations

      default CompletableFuture<ListAssociationsResponse> listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)

      Lists the associations in your account and their properties.


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

      Parameters:
      listAssociationsRequest - A Consumer that will call methods on ListAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssociations 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationsPaginator

      default ListAssociationsPublisher listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)

      This is a variant of listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest) operation.

      Parameters:
      listAssociationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssociationsPaginator

      default ListAssociationsPublisher listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)

      This is a variant of listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsPublisher publisher = client.listAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest) operation.


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

      Parameters:
      listAssociationsRequest - A Consumer that will call methods on ListAssociationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoMLJobs

      default CompletableFuture<ListAutoMlJobsResponse> listAutoMLJobs(ListAutoMlJobsRequest listAutoMlJobsRequest)

      Request a list of jobs.

      Parameters:
      listAutoMlJobsRequest -
      Returns:
      A Java Future containing the result of the ListAutoMLJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoMLJobs

      default CompletableFuture<ListAutoMlJobsResponse> listAutoMLJobs(Consumer<ListAutoMlJobsRequest.Builder> listAutoMlJobsRequest)

      Request a list of jobs.


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

      Parameters:
      listAutoMlJobsRequest - A Consumer that will call methods on ListAutoMlJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAutoMLJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoMLJobsPaginator

      default ListAutoMLJobsPublisher listAutoMLJobsPaginator(ListAutoMlJobsRequest listAutoMlJobsRequest)

      This is a variant of listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsPublisher publisher = client.listAutoMLJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsPublisher publisher = client.listAutoMLJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest) operation.

      Parameters:
      listAutoMlJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoMLJobsPaginator

      default ListAutoMLJobsPublisher listAutoMLJobsPaginator(Consumer<ListAutoMlJobsRequest.Builder> listAutoMlJobsRequest)

      This is a variant of listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsPublisher publisher = client.listAutoMLJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsPublisher publisher = client.listAutoMLJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest) operation.


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

      Parameters:
      listAutoMlJobsRequest - A Consumer that will call methods on ListAutoMlJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCandidatesForAutoMLJob

      default CompletableFuture<ListCandidatesForAutoMlJobResponse> listCandidatesForAutoMLJob(ListCandidatesForAutoMlJobRequest listCandidatesForAutoMlJobRequest)

      List the candidates created for the job.

      Parameters:
      listCandidatesForAutoMlJobRequest -
      Returns:
      A Java Future containing the result of the ListCandidatesForAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCandidatesForAutoMLJob

      default CompletableFuture<ListCandidatesForAutoMlJobResponse> listCandidatesForAutoMLJob(Consumer<ListCandidatesForAutoMlJobRequest.Builder> listCandidatesForAutoMlJobRequest)

      List the candidates created for the job.


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

      Parameters:
      listCandidatesForAutoMlJobRequest - A Consumer that will call methods on ListCandidatesForAutoMlJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCandidatesForAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCandidatesForAutoMLJobPaginator

      default ListCandidatesForAutoMLJobPublisher listCandidatesForAutoMLJobPaginator(ListCandidatesForAutoMlJobRequest listCandidatesForAutoMlJobRequest)

      This is a variant of listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobPublisher publisher = client.listCandidatesForAutoMLJobPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobPublisher publisher = client.listCandidatesForAutoMLJobPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest) operation.

      Parameters:
      listCandidatesForAutoMlJobRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCandidatesForAutoMLJobPaginator

      default ListCandidatesForAutoMLJobPublisher listCandidatesForAutoMLJobPaginator(Consumer<ListCandidatesForAutoMlJobRequest.Builder> listCandidatesForAutoMlJobRequest)

      This is a variant of listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobPublisher publisher = client.listCandidatesForAutoMLJobPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobPublisher publisher = client.listCandidatesForAutoMLJobPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest) operation.


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

      Parameters:
      listCandidatesForAutoMlJobRequest - A Consumer that will call methods on ListCandidatesForAutoMlJobRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterNodes

      default CompletableFuture<ListClusterNodesResponse> listClusterNodes(ListClusterNodesRequest listClusterNodesRequest)

      Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

      Parameters:
      listClusterNodesRequest -
      Returns:
      A Java Future containing the result of the ListClusterNodes 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterNodes

      default CompletableFuture<ListClusterNodesResponse> listClusterNodes(Consumer<ListClusterNodesRequest.Builder> listClusterNodesRequest)

      Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.


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

      Parameters:
      listClusterNodesRequest - A Consumer that will call methods on ListClusterNodesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusterNodes 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterNodesPaginator

      default ListClusterNodesPublisher listClusterNodesPaginator(ListClusterNodesRequest listClusterNodesRequest)

      This is a variant of listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesPublisher publisher = client.listClusterNodesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesPublisher publisher = client.listClusterNodesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest) operation.

      Parameters:
      listClusterNodesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusterNodesPaginator

      default ListClusterNodesPublisher listClusterNodesPaginator(Consumer<ListClusterNodesRequest.Builder> listClusterNodesRequest)

      This is a variant of listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesPublisher publisher = client.listClusterNodesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesPublisher publisher = client.listClusterNodesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest) operation.


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

      Parameters:
      listClusterNodesRequest - A Consumer that will call methods on ListClusterNodesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

      Retrieves the list of SageMaker HyperPod clusters.

      Parameters:
      listClustersRequest -
      Returns:
      A Java Future containing the result of the ListClusters 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

      Retrieves the list of SageMaker HyperPod clusters.


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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusters 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest) operation.

      Parameters:
      listClustersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest) operation.


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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositories

      default CompletableFuture<ListCodeRepositoriesResponse> listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest)

      Gets a list of the Git repositories in your account.

      Parameters:
      listCodeRepositoriesRequest -
      Returns:
      A Java Future containing the result of the ListCodeRepositories 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositories

      default CompletableFuture<ListCodeRepositoriesResponse> listCodeRepositories(Consumer<ListCodeRepositoriesRequest.Builder> listCodeRepositoriesRequest)

      Gets a list of the Git repositories in your account.


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

      Parameters:
      listCodeRepositoriesRequest - A Consumer that will call methods on ListCodeRepositoriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCodeRepositories 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositories

      default CompletableFuture<ListCodeRepositoriesResponse> listCodeRepositories()

      Gets a list of the Git repositories in your account.

      Returns:
      A Java Future containing the result of the ListCodeRepositories 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositoriesPaginator

      default ListCodeRepositoriesPublisher listCodeRepositoriesPaginator()

      This is a variant of listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositoriesPaginator

      default ListCodeRepositoriesPublisher listCodeRepositoriesPaginator(ListCodeRepositoriesRequest listCodeRepositoriesRequest)

      This is a variant of listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation.

      Parameters:
      listCodeRepositoriesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCodeRepositoriesPaginator

      default ListCodeRepositoriesPublisher listCodeRepositoriesPaginator(Consumer<ListCodeRepositoriesRequest.Builder> listCodeRepositoriesRequest)

      This is a variant of listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesPublisher publisher = client.listCodeRepositoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest) operation.


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

      Parameters:
      listCodeRepositoriesRequest - A Consumer that will call methods on ListCodeRepositoriesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobs

      default CompletableFuture<ListCompilationJobsResponse> listCompilationJobs(ListCompilationJobsRequest listCompilationJobsRequest)

      Lists model compilation jobs that satisfy various filters.

      To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

      Parameters:
      listCompilationJobsRequest -
      Returns:
      A Java Future containing the result of the ListCompilationJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobs

      default CompletableFuture<ListCompilationJobsResponse> listCompilationJobs(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest)

      Lists model compilation jobs that satisfy various filters.

      To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.


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

      Parameters:
      listCompilationJobsRequest - A Consumer that will call methods on ListCompilationJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCompilationJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobs

      default CompletableFuture<ListCompilationJobsResponse> listCompilationJobs()

      Lists model compilation jobs that satisfy various filters.

      To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

      Returns:
      A Java Future containing the result of the ListCompilationJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobsPaginator

      default ListCompilationJobsPublisher listCompilationJobsPaginator()

      This is a variant of listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobsPaginator

      default ListCompilationJobsPublisher listCompilationJobsPaginator(ListCompilationJobsRequest listCompilationJobsRequest)

      This is a variant of listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation.

      Parameters:
      listCompilationJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCompilationJobsPaginator

      default ListCompilationJobsPublisher listCompilationJobsPaginator(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest)

      This is a variant of listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsPublisher publisher = client.listCompilationJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest) operation.


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

      Parameters:
      listCompilationJobsRequest - A Consumer that will call methods on ListCompilationJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContexts

      default CompletableFuture<ListContextsResponse> listContexts(ListContextsRequest listContextsRequest)

      Lists the contexts in your account and their properties.

      Parameters:
      listContextsRequest -
      Returns:
      A Java Future containing the result of the ListContexts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContexts

      default CompletableFuture<ListContextsResponse> listContexts(Consumer<ListContextsRequest.Builder> listContextsRequest)

      Lists the contexts in your account and their properties.


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

      Parameters:
      listContextsRequest - A Consumer that will call methods on ListContextsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContexts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContextsPaginator

      default ListContextsPublisher listContextsPaginator(ListContextsRequest listContextsRequest)

      This is a variant of listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListContextsPublisher publisher = client.listContextsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListContextsPublisher publisher = client.listContextsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListContextsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListContextsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest) operation.

      Parameters:
      listContextsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContextsPaginator

      default ListContextsPublisher listContextsPaginator(Consumer<ListContextsRequest.Builder> listContextsRequest)

      This is a variant of listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListContextsPublisher publisher = client.listContextsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListContextsPublisher publisher = client.listContextsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListContextsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListContextsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest) operation.


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

      Parameters:
      listContextsRequest - A Consumer that will call methods on ListContextsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataQualityJobDefinitions

      default CompletableFuture<ListDataQualityJobDefinitionsResponse> listDataQualityJobDefinitions(ListDataQualityJobDefinitionsRequest listDataQualityJobDefinitionsRequest)

      Lists the data quality job definitions in your account.

      Parameters:
      listDataQualityJobDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListDataQualityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataQualityJobDefinitions

      default CompletableFuture<ListDataQualityJobDefinitionsResponse> listDataQualityJobDefinitions(Consumer<ListDataQualityJobDefinitionsRequest.Builder> listDataQualityJobDefinitionsRequest)

      Lists the data quality job definitions in your account.


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

      Parameters:
      listDataQualityJobDefinitionsRequest - A Consumer that will call methods on ListDataQualityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataQualityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataQualityJobDefinitionsPaginator

      default ListDataQualityJobDefinitionsPublisher listDataQualityJobDefinitionsPaginator(ListDataQualityJobDefinitionsRequest listDataQualityJobDefinitionsRequest)

      This is a variant of listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsPublisher publisher = client.listDataQualityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsPublisher publisher = client.listDataQualityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest) operation.

      Parameters:
      listDataQualityJobDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataQualityJobDefinitionsPaginator

      default ListDataQualityJobDefinitionsPublisher listDataQualityJobDefinitionsPaginator(Consumer<ListDataQualityJobDefinitionsRequest.Builder> listDataQualityJobDefinitionsRequest)

      This is a variant of listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsPublisher publisher = client.listDataQualityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsPublisher publisher = client.listDataQualityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest) operation.


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

      Parameters:
      listDataQualityJobDefinitionsRequest - A Consumer that will call methods on ListDataQualityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceFleets

      default CompletableFuture<ListDeviceFleetsResponse> listDeviceFleets(ListDeviceFleetsRequest listDeviceFleetsRequest)

      Returns a list of devices in the fleet.

      Parameters:
      listDeviceFleetsRequest -
      Returns:
      A Java Future containing the result of the ListDeviceFleets 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceFleets

      default CompletableFuture<ListDeviceFleetsResponse> listDeviceFleets(Consumer<ListDeviceFleetsRequest.Builder> listDeviceFleetsRequest)

      Returns a list of devices in the fleet.


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

      Parameters:
      listDeviceFleetsRequest - A Consumer that will call methods on ListDeviceFleetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDeviceFleets 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceFleetsPaginator

      default ListDeviceFleetsPublisher listDeviceFleetsPaginator(ListDeviceFleetsRequest listDeviceFleetsRequest)

      This is a variant of listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsPublisher publisher = client.listDeviceFleetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsPublisher publisher = client.listDeviceFleetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest) operation.

      Parameters:
      listDeviceFleetsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceFleetsPaginator

      default ListDeviceFleetsPublisher listDeviceFleetsPaginator(Consumer<ListDeviceFleetsRequest.Builder> listDeviceFleetsRequest)

      This is a variant of listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsPublisher publisher = client.listDeviceFleetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsPublisher publisher = client.listDeviceFleetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest) operation.


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

      Parameters:
      listDeviceFleetsRequest - A Consumer that will call methods on ListDeviceFleetsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevices

      default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)

      A list of devices.

      Parameters:
      listDevicesRequest -
      Returns:
      A Java Future containing the result of the ListDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevices

      default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)

      A list of devices.


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

      Parameters:
      listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevicesPaginator

      default ListDevicesPublisher listDevicesPaginator(ListDevicesRequest listDevicesRequest)

      This is a variant of listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest) operation.

      Parameters:
      listDevicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevicesPaginator

      default ListDevicesPublisher listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)

      This is a variant of listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest) operation.


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

      Parameters:
      listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)

      Lists the domains.

      Parameters:
      listDomainsRequest -
      Returns:
      A Java Future containing the result of the ListDomains 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      Lists the domains.


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDomains 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest) operation.

      Parameters:
      listDomainsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest) operation.


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgeDeploymentPlans

      default CompletableFuture<ListEdgeDeploymentPlansResponse> listEdgeDeploymentPlans(ListEdgeDeploymentPlansRequest listEdgeDeploymentPlansRequest)

      Lists all edge deployment plans.

      Parameters:
      listEdgeDeploymentPlansRequest -
      Returns:
      A Java Future containing the result of the ListEdgeDeploymentPlans 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgeDeploymentPlans

      default CompletableFuture<ListEdgeDeploymentPlansResponse> listEdgeDeploymentPlans(Consumer<ListEdgeDeploymentPlansRequest.Builder> listEdgeDeploymentPlansRequest)

      Lists all edge deployment plans.


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

      Parameters:
      listEdgeDeploymentPlansRequest - A Consumer that will call methods on ListEdgeDeploymentPlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEdgeDeploymentPlans 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgeDeploymentPlansPaginator

      default ListEdgeDeploymentPlansPublisher listEdgeDeploymentPlansPaginator(ListEdgeDeploymentPlansRequest listEdgeDeploymentPlansRequest)

      This is a variant of listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansPublisher publisher = client.listEdgeDeploymentPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansPublisher publisher = client.listEdgeDeploymentPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest) operation.

      Parameters:
      listEdgeDeploymentPlansRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgeDeploymentPlansPaginator

      default ListEdgeDeploymentPlansPublisher listEdgeDeploymentPlansPaginator(Consumer<ListEdgeDeploymentPlansRequest.Builder> listEdgeDeploymentPlansRequest)

      This is a variant of listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansPublisher publisher = client.listEdgeDeploymentPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansPublisher publisher = client.listEdgeDeploymentPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest) operation.


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

      Parameters:
      listEdgeDeploymentPlansRequest - A Consumer that will call methods on ListEdgeDeploymentPlansRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgePackagingJobs

      default CompletableFuture<ListEdgePackagingJobsResponse> listEdgePackagingJobs(ListEdgePackagingJobsRequest listEdgePackagingJobsRequest)

      Returns a list of edge packaging jobs.

      Parameters:
      listEdgePackagingJobsRequest -
      Returns:
      A Java Future containing the result of the ListEdgePackagingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgePackagingJobs

      default CompletableFuture<ListEdgePackagingJobsResponse> listEdgePackagingJobs(Consumer<ListEdgePackagingJobsRequest.Builder> listEdgePackagingJobsRequest)

      Returns a list of edge packaging jobs.


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

      Parameters:
      listEdgePackagingJobsRequest - A Consumer that will call methods on ListEdgePackagingJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEdgePackagingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgePackagingJobsPaginator

      default ListEdgePackagingJobsPublisher listEdgePackagingJobsPaginator(ListEdgePackagingJobsRequest listEdgePackagingJobsRequest)

      This is a variant of listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsPublisher publisher = client.listEdgePackagingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsPublisher publisher = client.listEdgePackagingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest) operation.

      Parameters:
      listEdgePackagingJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEdgePackagingJobsPaginator

      default ListEdgePackagingJobsPublisher listEdgePackagingJobsPaginator(Consumer<ListEdgePackagingJobsRequest.Builder> listEdgePackagingJobsRequest)

      This is a variant of listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsPublisher publisher = client.listEdgePackagingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsPublisher publisher = client.listEdgePackagingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest) operation.


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

      Parameters:
      listEdgePackagingJobsRequest - A Consumer that will call methods on ListEdgePackagingJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigs

      default CompletableFuture<ListEndpointConfigsResponse> listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest)

      Lists endpoint configurations.

      Parameters:
      listEndpointConfigsRequest -
      Returns:
      A Java Future containing the result of the ListEndpointConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigs

      default CompletableFuture<ListEndpointConfigsResponse> listEndpointConfigs(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest)

      Lists endpoint configurations.


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

      Parameters:
      listEndpointConfigsRequest - A Consumer that will call methods on ListEndpointConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEndpointConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigs

      default CompletableFuture<ListEndpointConfigsResponse> listEndpointConfigs()

      Lists endpoint configurations.

      Returns:
      A Java Future containing the result of the ListEndpointConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigsPaginator

      default ListEndpointConfigsPublisher listEndpointConfigsPaginator()

      This is a variant of listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigsPaginator

      default ListEndpointConfigsPublisher listEndpointConfigsPaginator(ListEndpointConfigsRequest listEndpointConfigsRequest)

      This is a variant of listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation.

      Parameters:
      listEndpointConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointConfigsPaginator

      default ListEndpointConfigsPublisher listEndpointConfigsPaginator(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest)

      This is a variant of listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsPublisher publisher = client.listEndpointConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest) operation.


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

      Parameters:
      listEndpointConfigsRequest - A Consumer that will call methods on ListEndpointConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(ListEndpointsRequest listEndpointsRequest)

      Lists endpoints.

      Parameters:
      listEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListEndpoints 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      Lists endpoints.


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEndpoints 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpoints

      default CompletableFuture<ListEndpointsResponse> listEndpoints()

      Lists endpoints.

      Returns:
      A Java Future containing the result of the ListEndpoints 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator()

      This is a variant of listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation.

      Parameters:
      listEndpointsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEndpointsPaginator

      default ListEndpointsPublisher listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)

      This is a variant of listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest) operation.


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

      Parameters:
      listEndpointsRequest - A Consumer that will call methods on ListEndpointsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiments

      default CompletableFuture<ListExperimentsResponse> listExperiments(ListExperimentsRequest listExperimentsRequest)

      Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

      Parameters:
      listExperimentsRequest -
      Returns:
      A Java Future containing the result of the ListExperiments 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperiments

      default CompletableFuture<ListExperimentsResponse> listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)

      Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.


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

      Parameters:
      listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExperiments 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperimentsPaginator

      default ListExperimentsPublisher listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest)

      This is a variant of listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsPublisher publisher = client.listExperimentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsPublisher publisher = client.listExperimentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest) operation.

      Parameters:
      listExperimentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExperimentsPaginator

      default ListExperimentsPublisher listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)

      This is a variant of listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsPublisher publisher = client.listExperimentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsPublisher publisher = client.listExperimentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest) operation.


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

      Parameters:
      listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeatureGroups

      default CompletableFuture<ListFeatureGroupsResponse> listFeatureGroups(ListFeatureGroupsRequest listFeatureGroupsRequest)

      List FeatureGroups based on given filter and order.

      Parameters:
      listFeatureGroupsRequest -
      Returns:
      A Java Future containing the result of the ListFeatureGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeatureGroups

      default CompletableFuture<ListFeatureGroupsResponse> listFeatureGroups(Consumer<ListFeatureGroupsRequest.Builder> listFeatureGroupsRequest)

      List FeatureGroups based on given filter and order.


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

      Parameters:
      listFeatureGroupsRequest - A Consumer that will call methods on ListFeatureGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFeatureGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeatureGroupsPaginator

      default ListFeatureGroupsPublisher listFeatureGroupsPaginator(ListFeatureGroupsRequest listFeatureGroupsRequest)

      This is a variant of listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsPublisher publisher = client.listFeatureGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsPublisher publisher = client.listFeatureGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest) operation.

      Parameters:
      listFeatureGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFeatureGroupsPaginator

      default ListFeatureGroupsPublisher listFeatureGroupsPaginator(Consumer<ListFeatureGroupsRequest.Builder> listFeatureGroupsRequest)

      This is a variant of listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsPublisher publisher = client.listFeatureGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsPublisher publisher = client.listFeatureGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest) operation.


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

      Parameters:
      listFeatureGroupsRequest - A Consumer that will call methods on ListFeatureGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowDefinitions

      default CompletableFuture<ListFlowDefinitionsResponse> listFlowDefinitions(ListFlowDefinitionsRequest listFlowDefinitionsRequest)

      Returns information about the flow definitions in your account.

      Parameters:
      listFlowDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListFlowDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowDefinitions

      default CompletableFuture<ListFlowDefinitionsResponse> listFlowDefinitions(Consumer<ListFlowDefinitionsRequest.Builder> listFlowDefinitionsRequest)

      Returns information about the flow definitions in your account.


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

      Parameters:
      listFlowDefinitionsRequest - A Consumer that will call methods on ListFlowDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlowDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowDefinitionsPaginator

      default ListFlowDefinitionsPublisher listFlowDefinitionsPaginator(ListFlowDefinitionsRequest listFlowDefinitionsRequest)

      This is a variant of listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsPublisher publisher = client.listFlowDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsPublisher publisher = client.listFlowDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest) operation.

      Parameters:
      listFlowDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowDefinitionsPaginator

      default ListFlowDefinitionsPublisher listFlowDefinitionsPaginator(Consumer<ListFlowDefinitionsRequest.Builder> listFlowDefinitionsRequest)

      This is a variant of listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsPublisher publisher = client.listFlowDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsPublisher publisher = client.listFlowDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest) operation.


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

      Parameters:
      listFlowDefinitionsRequest - A Consumer that will call methods on ListFlowDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubContentVersions

      default CompletableFuture<ListHubContentVersionsResponse> listHubContentVersions(ListHubContentVersionsRequest listHubContentVersionsRequest)

      List hub content versions.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      listHubContentVersionsRequest -
      Returns:
      A Java Future containing the result of the ListHubContentVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubContentVersions

      default CompletableFuture<ListHubContentVersionsResponse> listHubContentVersions(Consumer<ListHubContentVersionsRequest.Builder> listHubContentVersionsRequest)

      List hub content versions.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      listHubContentVersionsRequest - A Consumer that will call methods on ListHubContentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHubContentVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubContents

      default CompletableFuture<ListHubContentsResponse> listHubContents(ListHubContentsRequest listHubContentsRequest)

      List the contents of a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      listHubContentsRequest -
      Returns:
      A Java Future containing the result of the ListHubContents 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubContents

      default CompletableFuture<ListHubContentsResponse> listHubContents(Consumer<ListHubContentsRequest.Builder> listHubContentsRequest)

      List the contents of a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      listHubContentsRequest - A Consumer that will call methods on ListHubContentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHubContents 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubs

      default CompletableFuture<ListHubsResponse> listHubs(ListHubsRequest listHubsRequest)

      List all existing hubs.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      listHubsRequest -
      Returns:
      A Java Future containing the result of the ListHubs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHubs

      default CompletableFuture<ListHubsResponse> listHubs(Consumer<ListHubsRequest.Builder> listHubsRequest)

      List all existing hubs.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      listHubsRequest - A Consumer that will call methods on ListHubsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHubs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHumanTaskUis

      default CompletableFuture<ListHumanTaskUisResponse> listHumanTaskUis(ListHumanTaskUisRequest listHumanTaskUisRequest)

      Returns information about the human task user interfaces in your account.

      Parameters:
      listHumanTaskUisRequest -
      Returns:
      A Java Future containing the result of the ListHumanTaskUis 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHumanTaskUis

      default CompletableFuture<ListHumanTaskUisResponse> listHumanTaskUis(Consumer<ListHumanTaskUisRequest.Builder> listHumanTaskUisRequest)

      Returns information about the human task user interfaces in your account.


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

      Parameters:
      listHumanTaskUisRequest - A Consumer that will call methods on ListHumanTaskUisRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHumanTaskUis 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHumanTaskUisPaginator

      default ListHumanTaskUisPublisher listHumanTaskUisPaginator(ListHumanTaskUisRequest listHumanTaskUisRequest)

      This is a variant of listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisPublisher publisher = client.listHumanTaskUisPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisPublisher publisher = client.listHumanTaskUisPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest) operation.

      Parameters:
      listHumanTaskUisRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHumanTaskUisPaginator

      default ListHumanTaskUisPublisher listHumanTaskUisPaginator(Consumer<ListHumanTaskUisRequest.Builder> listHumanTaskUisRequest)

      This is a variant of listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisPublisher publisher = client.listHumanTaskUisPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisPublisher publisher = client.listHumanTaskUisPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest) operation.


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

      Parameters:
      listHumanTaskUisRequest - A Consumer that will call methods on ListHumanTaskUisRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobs

      default CompletableFuture<ListHyperParameterTuningJobsResponse> listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)

      Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

      Parameters:
      listHyperParameterTuningJobsRequest -
      Returns:
      A Java Future containing the result of the ListHyperParameterTuningJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobs

      default CompletableFuture<ListHyperParameterTuningJobsResponse> listHyperParameterTuningJobs(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest)

      Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.


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

      Parameters:
      listHyperParameterTuningJobsRequest - A Consumer that will call methods on ListHyperParameterTuningJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHyperParameterTuningJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobs

      default CompletableFuture<ListHyperParameterTuningJobsResponse> listHyperParameterTuningJobs()

      Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

      Returns:
      A Java Future containing the result of the ListHyperParameterTuningJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobsPaginator

      default ListHyperParameterTuningJobsPublisher listHyperParameterTuningJobsPaginator()

      This is a variant of listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobsPaginator

      default ListHyperParameterTuningJobsPublisher listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)

      This is a variant of listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation.

      Parameters:
      listHyperParameterTuningJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHyperParameterTuningJobsPaginator

      default ListHyperParameterTuningJobsPublisher listHyperParameterTuningJobsPaginator(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest)

      This is a variant of listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsPublisher publisher = client.listHyperParameterTuningJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest) operation.


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

      Parameters:
      listHyperParameterTuningJobsRequest - A Consumer that will call methods on ListHyperParameterTuningJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageVersions

      default CompletableFuture<ListImageVersionsResponse> listImageVersions(ListImageVersionsRequest listImageVersionsRequest)

      Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

      Parameters:
      listImageVersionsRequest -
      Returns:
      A Java Future containing the result of the ListImageVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageVersions

      default CompletableFuture<ListImageVersionsResponse> listImageVersions(Consumer<ListImageVersionsRequest.Builder> listImageVersionsRequest)

      Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.


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

      Parameters:
      listImageVersionsRequest - A Consumer that will call methods on ListImageVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImageVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageVersionsPaginator

      default ListImageVersionsPublisher listImageVersionsPaginator(ListImageVersionsRequest listImageVersionsRequest)

      This is a variant of listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsPublisher publisher = client.listImageVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsPublisher publisher = client.listImageVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest) operation.

      Parameters:
      listImageVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImageVersionsPaginator

      default ListImageVersionsPublisher listImageVersionsPaginator(Consumer<ListImageVersionsRequest.Builder> listImageVersionsRequest)

      This is a variant of listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsPublisher publisher = client.listImageVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsPublisher publisher = client.listImageVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest) operation.


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

      Parameters:
      listImageVersionsRequest - A Consumer that will call methods on ListImageVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImages

      default CompletableFuture<ListImagesResponse> listImages(ListImagesRequest listImagesRequest)

      Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

      Parameters:
      listImagesRequest -
      Returns:
      A Java Future containing the result of the ListImages 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImages

      default CompletableFuture<ListImagesResponse> listImages(Consumer<ListImagesRequest.Builder> listImagesRequest)

      Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.


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

      Parameters:
      listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImages 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagesPaginator

      default ListImagesPublisher listImagesPaginator(ListImagesRequest listImagesRequest)

      This is a variant of listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest) operation.

      Parameters:
      listImagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImagesPaginator

      default ListImagesPublisher listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest)

      This is a variant of listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListImagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListImagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest) operation.


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

      Parameters:
      listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceComponents

      default CompletableFuture<ListInferenceComponentsResponse> listInferenceComponents(ListInferenceComponentsRequest listInferenceComponentsRequest)

      Lists the inference components in your account and their properties.

      Parameters:
      listInferenceComponentsRequest -
      Returns:
      A Java Future containing the result of the ListInferenceComponents 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceComponents

      default CompletableFuture<ListInferenceComponentsResponse> listInferenceComponents(Consumer<ListInferenceComponentsRequest.Builder> listInferenceComponentsRequest)

      Lists the inference components in your account and their properties.


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

      Parameters:
      listInferenceComponentsRequest - A Consumer that will call methods on ListInferenceComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInferenceComponents 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceComponentsPaginator

      default ListInferenceComponentsPublisher listInferenceComponentsPaginator(ListInferenceComponentsRequest listInferenceComponentsRequest)

      This is a variant of listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsPublisher publisher = client.listInferenceComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsPublisher publisher = client.listInferenceComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest) operation.

      Parameters:
      listInferenceComponentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceComponentsPaginator

      default ListInferenceComponentsPublisher listInferenceComponentsPaginator(Consumer<ListInferenceComponentsRequest.Builder> listInferenceComponentsRequest)

      This is a variant of listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsPublisher publisher = client.listInferenceComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsPublisher publisher = client.listInferenceComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest) operation.


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

      Parameters:
      listInferenceComponentsRequest - A Consumer that will call methods on ListInferenceComponentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceExperiments

      default CompletableFuture<ListInferenceExperimentsResponse> listInferenceExperiments(ListInferenceExperimentsRequest listInferenceExperimentsRequest)

      Returns the list of all inference experiments.

      Parameters:
      listInferenceExperimentsRequest -
      Returns:
      A Java Future containing the result of the ListInferenceExperiments 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceExperiments

      default CompletableFuture<ListInferenceExperimentsResponse> listInferenceExperiments(Consumer<ListInferenceExperimentsRequest.Builder> listInferenceExperimentsRequest)

      Returns the list of all inference experiments.


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

      Parameters:
      listInferenceExperimentsRequest - A Consumer that will call methods on ListInferenceExperimentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInferenceExperiments 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceExperimentsPaginator

      default ListInferenceExperimentsPublisher listInferenceExperimentsPaginator(ListInferenceExperimentsRequest listInferenceExperimentsRequest)

      This is a variant of listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsPublisher publisher = client.listInferenceExperimentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsPublisher publisher = client.listInferenceExperimentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest) operation.

      Parameters:
      listInferenceExperimentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceExperimentsPaginator

      default ListInferenceExperimentsPublisher listInferenceExperimentsPaginator(Consumer<ListInferenceExperimentsRequest.Builder> listInferenceExperimentsRequest)

      This is a variant of listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsPublisher publisher = client.listInferenceExperimentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsPublisher publisher = client.listInferenceExperimentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest) operation.


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

      Parameters:
      listInferenceExperimentsRequest - A Consumer that will call methods on ListInferenceExperimentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobSteps

      default CompletableFuture<ListInferenceRecommendationsJobStepsResponse> listInferenceRecommendationsJobSteps(ListInferenceRecommendationsJobStepsRequest listInferenceRecommendationsJobStepsRequest)

      Returns a list of the subtasks for an Inference Recommender job.

      The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

      Parameters:
      listInferenceRecommendationsJobStepsRequest -
      Returns:
      A Java Future containing the result of the ListInferenceRecommendationsJobSteps 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobSteps

      default CompletableFuture<ListInferenceRecommendationsJobStepsResponse> listInferenceRecommendationsJobSteps(Consumer<ListInferenceRecommendationsJobStepsRequest.Builder> listInferenceRecommendationsJobStepsRequest)

      Returns a list of the subtasks for an Inference Recommender job.

      The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.


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

      Parameters:
      listInferenceRecommendationsJobStepsRequest - A Consumer that will call methods on ListInferenceRecommendationsJobStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInferenceRecommendationsJobSteps 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobStepsPaginator

      default ListInferenceRecommendationsJobStepsPublisher listInferenceRecommendationsJobStepsPaginator(ListInferenceRecommendationsJobStepsRequest listInferenceRecommendationsJobStepsRequest)

      This is a variant of listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsPublisher publisher = client.listInferenceRecommendationsJobStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsPublisher publisher = client.listInferenceRecommendationsJobStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest) operation.

      Parameters:
      listInferenceRecommendationsJobStepsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobStepsPaginator

      default ListInferenceRecommendationsJobStepsPublisher listInferenceRecommendationsJobStepsPaginator(Consumer<ListInferenceRecommendationsJobStepsRequest.Builder> listInferenceRecommendationsJobStepsRequest)

      This is a variant of listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsPublisher publisher = client.listInferenceRecommendationsJobStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsPublisher publisher = client.listInferenceRecommendationsJobStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest) operation.


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

      Parameters:
      listInferenceRecommendationsJobStepsRequest - A Consumer that will call methods on ListInferenceRecommendationsJobStepsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobs

      default CompletableFuture<ListInferenceRecommendationsJobsResponse> listInferenceRecommendationsJobs(ListInferenceRecommendationsJobsRequest listInferenceRecommendationsJobsRequest)

      Lists recommendation jobs that satisfy various filters.

      Parameters:
      listInferenceRecommendationsJobsRequest -
      Returns:
      A Java Future containing the result of the ListInferenceRecommendationsJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobs

      default CompletableFuture<ListInferenceRecommendationsJobsResponse> listInferenceRecommendationsJobs(Consumer<ListInferenceRecommendationsJobsRequest.Builder> listInferenceRecommendationsJobsRequest)

      Lists recommendation jobs that satisfy various filters.


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

      Parameters:
      listInferenceRecommendationsJobsRequest - A Consumer that will call methods on ListInferenceRecommendationsJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInferenceRecommendationsJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobsPaginator

      default ListInferenceRecommendationsJobsPublisher listInferenceRecommendationsJobsPaginator(ListInferenceRecommendationsJobsRequest listInferenceRecommendationsJobsRequest)

      This is a variant of listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsPublisher publisher = client.listInferenceRecommendationsJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsPublisher publisher = client.listInferenceRecommendationsJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest) operation.

      Parameters:
      listInferenceRecommendationsJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInferenceRecommendationsJobsPaginator

      default ListInferenceRecommendationsJobsPublisher listInferenceRecommendationsJobsPaginator(Consumer<ListInferenceRecommendationsJobsRequest.Builder> listInferenceRecommendationsJobsRequest)

      This is a variant of listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsPublisher publisher = client.listInferenceRecommendationsJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsPublisher publisher = client.listInferenceRecommendationsJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest) operation.


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

      Parameters:
      listInferenceRecommendationsJobsRequest - A Consumer that will call methods on ListInferenceRecommendationsJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobs

      default CompletableFuture<ListLabelingJobsResponse> listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest)

      Gets a list of labeling jobs.

      Parameters:
      listLabelingJobsRequest -
      Returns:
      A Java Future containing the result of the ListLabelingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobs

      default CompletableFuture<ListLabelingJobsResponse> listLabelingJobs(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest)

      Gets a list of labeling jobs.


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

      Parameters:
      listLabelingJobsRequest - A Consumer that will call methods on ListLabelingJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLabelingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobs

      default CompletableFuture<ListLabelingJobsResponse> listLabelingJobs()

      Gets a list of labeling jobs.

      Returns:
      A Java Future containing the result of the ListLabelingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsForWorkteam

      default CompletableFuture<ListLabelingJobsForWorkteamResponse> listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)

      Gets a list of labeling jobs assigned to a specified work team.

      Parameters:
      listLabelingJobsForWorkteamRequest -
      Returns:
      A Java Future containing the result of the ListLabelingJobsForWorkteam 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsForWorkteam

      default CompletableFuture<ListLabelingJobsForWorkteamResponse> listLabelingJobsForWorkteam(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest)

      Gets a list of labeling jobs assigned to a specified work team.


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

      Parameters:
      listLabelingJobsForWorkteamRequest - A Consumer that will call methods on ListLabelingJobsForWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLabelingJobsForWorkteam 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsForWorkteamPaginator

      default ListLabelingJobsForWorkteamPublisher listLabelingJobsForWorkteamPaginator(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)

      This is a variant of listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamPublisher publisher = client.listLabelingJobsForWorkteamPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamPublisher publisher = client.listLabelingJobsForWorkteamPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest) operation.

      Parameters:
      listLabelingJobsForWorkteamRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsForWorkteamPaginator

      default ListLabelingJobsForWorkteamPublisher listLabelingJobsForWorkteamPaginator(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest)

      This is a variant of listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamPublisher publisher = client.listLabelingJobsForWorkteamPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamPublisher publisher = client.listLabelingJobsForWorkteamPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest) operation.


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

      Parameters:
      listLabelingJobsForWorkteamRequest - A Consumer that will call methods on ListLabelingJobsForWorkteamRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsPaginator

      default ListLabelingJobsPublisher listLabelingJobsPaginator()

      This is a variant of listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsPaginator

      default ListLabelingJobsPublisher listLabelingJobsPaginator(ListLabelingJobsRequest listLabelingJobsRequest)

      This is a variant of listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation.

      Parameters:
      listLabelingJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLabelingJobsPaginator

      default ListLabelingJobsPublisher listLabelingJobsPaginator(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest)

      This is a variant of listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsPublisher publisher = client.listLabelingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest) operation.


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

      Parameters:
      listLabelingJobsRequest - A Consumer that will call methods on ListLabelingJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLineageGroups

      default CompletableFuture<ListLineageGroupsResponse> listLineageGroups(ListLineageGroupsRequest listLineageGroupsRequest)

      A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

      Parameters:
      listLineageGroupsRequest -
      Returns:
      A Java Future containing the result of the ListLineageGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLineageGroups

      default CompletableFuture<ListLineageGroupsResponse> listLineageGroups(Consumer<ListLineageGroupsRequest.Builder> listLineageGroupsRequest)

      A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.


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

      Parameters:
      listLineageGroupsRequest - A Consumer that will call methods on ListLineageGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLineageGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLineageGroupsPaginator

      default ListLineageGroupsPublisher listLineageGroupsPaginator(ListLineageGroupsRequest listLineageGroupsRequest)

      This is a variant of listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsPublisher publisher = client.listLineageGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsPublisher publisher = client.listLineageGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest) operation.

      Parameters:
      listLineageGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLineageGroupsPaginator

      default ListLineageGroupsPublisher listLineageGroupsPaginator(Consumer<ListLineageGroupsRequest.Builder> listLineageGroupsRequest)

      This is a variant of listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsPublisher publisher = client.listLineageGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsPublisher publisher = client.listLineageGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest) operation.


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

      Parameters:
      listLineageGroupsRequest - A Consumer that will call methods on ListLineageGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelBiasJobDefinitions

      default CompletableFuture<ListModelBiasJobDefinitionsResponse> listModelBiasJobDefinitions(ListModelBiasJobDefinitionsRequest listModelBiasJobDefinitionsRequest)

      Lists model bias jobs definitions that satisfy various filters.

      Parameters:
      listModelBiasJobDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListModelBiasJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelBiasJobDefinitions

      default CompletableFuture<ListModelBiasJobDefinitionsResponse> listModelBiasJobDefinitions(Consumer<ListModelBiasJobDefinitionsRequest.Builder> listModelBiasJobDefinitionsRequest)

      Lists model bias jobs definitions that satisfy various filters.


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

      Parameters:
      listModelBiasJobDefinitionsRequest - A Consumer that will call methods on ListModelBiasJobDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelBiasJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelBiasJobDefinitionsPaginator

      default ListModelBiasJobDefinitionsPublisher listModelBiasJobDefinitionsPaginator(ListModelBiasJobDefinitionsRequest listModelBiasJobDefinitionsRequest)

      This is a variant of listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsPublisher publisher = client.listModelBiasJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsPublisher publisher = client.listModelBiasJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest) operation.

      Parameters:
      listModelBiasJobDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelBiasJobDefinitionsPaginator

      default ListModelBiasJobDefinitionsPublisher listModelBiasJobDefinitionsPaginator(Consumer<ListModelBiasJobDefinitionsRequest.Builder> listModelBiasJobDefinitionsRequest)

      This is a variant of listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsPublisher publisher = client.listModelBiasJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsPublisher publisher = client.listModelBiasJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest) operation.


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

      Parameters:
      listModelBiasJobDefinitionsRequest - A Consumer that will call methods on ListModelBiasJobDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardExportJobs

      default CompletableFuture<ListModelCardExportJobsResponse> listModelCardExportJobs(ListModelCardExportJobsRequest listModelCardExportJobsRequest)

      List the export jobs for the Amazon SageMaker Model Card.

      Parameters:
      listModelCardExportJobsRequest -
      Returns:
      A Java Future containing the result of the ListModelCardExportJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardExportJobs

      default CompletableFuture<ListModelCardExportJobsResponse> listModelCardExportJobs(Consumer<ListModelCardExportJobsRequest.Builder> listModelCardExportJobsRequest)

      List the export jobs for the Amazon SageMaker Model Card.


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

      Parameters:
      listModelCardExportJobsRequest - A Consumer that will call methods on ListModelCardExportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelCardExportJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardExportJobsPaginator

      default ListModelCardExportJobsPublisher listModelCardExportJobsPaginator(ListModelCardExportJobsRequest listModelCardExportJobsRequest)

      This is a variant of listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsPublisher publisher = client.listModelCardExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsPublisher publisher = client.listModelCardExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest) operation.

      Parameters:
      listModelCardExportJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardExportJobsPaginator

      default ListModelCardExportJobsPublisher listModelCardExportJobsPaginator(Consumer<ListModelCardExportJobsRequest.Builder> listModelCardExportJobsRequest)

      This is a variant of listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsPublisher publisher = client.listModelCardExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsPublisher publisher = client.listModelCardExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest) operation.


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

      Parameters:
      listModelCardExportJobsRequest - A Consumer that will call methods on ListModelCardExportJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardVersions

      default CompletableFuture<ListModelCardVersionsResponse> listModelCardVersions(ListModelCardVersionsRequest listModelCardVersionsRequest)

      List existing versions of an Amazon SageMaker Model Card.

      Parameters:
      listModelCardVersionsRequest -
      Returns:
      A Java Future containing the result of the ListModelCardVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardVersions

      default CompletableFuture<ListModelCardVersionsResponse> listModelCardVersions(Consumer<ListModelCardVersionsRequest.Builder> listModelCardVersionsRequest)

      List existing versions of an Amazon SageMaker Model Card.


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

      Parameters:
      listModelCardVersionsRequest - A Consumer that will call methods on ListModelCardVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelCardVersions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardVersionsPaginator

      default ListModelCardVersionsPublisher listModelCardVersionsPaginator(ListModelCardVersionsRequest listModelCardVersionsRequest)

      This is a variant of listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsPublisher publisher = client.listModelCardVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsPublisher publisher = client.listModelCardVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest) operation.

      Parameters:
      listModelCardVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardVersionsPaginator

      default ListModelCardVersionsPublisher listModelCardVersionsPaginator(Consumer<ListModelCardVersionsRequest.Builder> listModelCardVersionsRequest)

      This is a variant of listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsPublisher publisher = client.listModelCardVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsPublisher publisher = client.listModelCardVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest) operation.


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

      Parameters:
      listModelCardVersionsRequest - A Consumer that will call methods on ListModelCardVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCards

      default CompletableFuture<ListModelCardsResponse> listModelCards(ListModelCardsRequest listModelCardsRequest)

      List existing model cards.

      Parameters:
      listModelCardsRequest -
      Returns:
      A Java Future containing the result of the ListModelCards 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCards

      default CompletableFuture<ListModelCardsResponse> listModelCards(Consumer<ListModelCardsRequest.Builder> listModelCardsRequest)

      List existing model cards.


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

      Parameters:
      listModelCardsRequest - A Consumer that will call methods on ListModelCardsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelCards 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardsPaginator

      default ListModelCardsPublisher listModelCardsPaginator(ListModelCardsRequest listModelCardsRequest)

      This is a variant of listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsPublisher publisher = client.listModelCardsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsPublisher publisher = client.listModelCardsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest) operation.

      Parameters:
      listModelCardsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelCardsPaginator

      default ListModelCardsPublisher listModelCardsPaginator(Consumer<ListModelCardsRequest.Builder> listModelCardsRequest)

      This is a variant of listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsPublisher publisher = client.listModelCardsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsPublisher publisher = client.listModelCardsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest) operation.


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

      Parameters:
      listModelCardsRequest - A Consumer that will call methods on ListModelCardsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelExplainabilityJobDefinitions

      default CompletableFuture<ListModelExplainabilityJobDefinitionsResponse> listModelExplainabilityJobDefinitions(ListModelExplainabilityJobDefinitionsRequest listModelExplainabilityJobDefinitionsRequest)

      Lists model explainability job definitions that satisfy various filters.

      Parameters:
      listModelExplainabilityJobDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListModelExplainabilityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelExplainabilityJobDefinitions

      default CompletableFuture<ListModelExplainabilityJobDefinitionsResponse> listModelExplainabilityJobDefinitions(Consumer<ListModelExplainabilityJobDefinitionsRequest.Builder> listModelExplainabilityJobDefinitionsRequest)

      Lists model explainability job definitions that satisfy various filters.


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

      Parameters:
      listModelExplainabilityJobDefinitionsRequest - A Consumer that will call methods on ListModelExplainabilityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelExplainabilityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelExplainabilityJobDefinitionsPaginator

      default ListModelExplainabilityJobDefinitionsPublisher listModelExplainabilityJobDefinitionsPaginator(ListModelExplainabilityJobDefinitionsRequest listModelExplainabilityJobDefinitionsRequest)

      This is a variant of listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsPublisher publisher = client.listModelExplainabilityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsPublisher publisher = client.listModelExplainabilityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest) operation.

      Parameters:
      listModelExplainabilityJobDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelExplainabilityJobDefinitionsPaginator

      default ListModelExplainabilityJobDefinitionsPublisher listModelExplainabilityJobDefinitionsPaginator(Consumer<ListModelExplainabilityJobDefinitionsRequest.Builder> listModelExplainabilityJobDefinitionsRequest)

      This is a variant of listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsPublisher publisher = client.listModelExplainabilityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsPublisher publisher = client.listModelExplainabilityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest) operation.


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

      Parameters:
      listModelExplainabilityJobDefinitionsRequest - A Consumer that will call methods on ListModelExplainabilityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelMetadata

      default CompletableFuture<ListModelMetadataResponse> listModelMetadata(ListModelMetadataRequest listModelMetadataRequest)

      Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

      Parameters:
      listModelMetadataRequest -
      Returns:
      A Java Future containing the result of the ListModelMetadata 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelMetadata

      default CompletableFuture<ListModelMetadataResponse> listModelMetadata(Consumer<ListModelMetadataRequest.Builder> listModelMetadataRequest)

      Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.


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

      Parameters:
      listModelMetadataRequest - A Consumer that will call methods on ListModelMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelMetadata 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelMetadataPaginator

      default ListModelMetadataPublisher listModelMetadataPaginator(ListModelMetadataRequest listModelMetadataRequest)

      This is a variant of listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataPublisher publisher = client.listModelMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataPublisher publisher = client.listModelMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest) operation.

      Parameters:
      listModelMetadataRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelMetadataPaginator

      default ListModelMetadataPublisher listModelMetadataPaginator(Consumer<ListModelMetadataRequest.Builder> listModelMetadataRequest)

      This is a variant of listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataPublisher publisher = client.listModelMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataPublisher publisher = client.listModelMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest) operation.


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

      Parameters:
      listModelMetadataRequest - A Consumer that will call methods on ListModelMetadataRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackageGroups

      default CompletableFuture<ListModelPackageGroupsResponse> listModelPackageGroups(ListModelPackageGroupsRequest listModelPackageGroupsRequest)

      Gets a list of the model groups in your Amazon Web Services account.

      Parameters:
      listModelPackageGroupsRequest -
      Returns:
      A Java Future containing the result of the ListModelPackageGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackageGroups

      default CompletableFuture<ListModelPackageGroupsResponse> listModelPackageGroups(Consumer<ListModelPackageGroupsRequest.Builder> listModelPackageGroupsRequest)

      Gets a list of the model groups in your Amazon Web Services account.


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

      Parameters:
      listModelPackageGroupsRequest - A Consumer that will call methods on ListModelPackageGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelPackageGroups 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackageGroupsPaginator

      default ListModelPackageGroupsPublisher listModelPackageGroupsPaginator(ListModelPackageGroupsRequest listModelPackageGroupsRequest)

      This is a variant of listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsPublisher publisher = client.listModelPackageGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsPublisher publisher = client.listModelPackageGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest) operation.

      Parameters:
      listModelPackageGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackageGroupsPaginator

      default ListModelPackageGroupsPublisher listModelPackageGroupsPaginator(Consumer<ListModelPackageGroupsRequest.Builder> listModelPackageGroupsRequest)

      This is a variant of listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsPublisher publisher = client.listModelPackageGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsPublisher publisher = client.listModelPackageGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest) operation.


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

      Parameters:
      listModelPackageGroupsRequest - A Consumer that will call methods on ListModelPackageGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackages

      default CompletableFuture<ListModelPackagesResponse> listModelPackages(ListModelPackagesRequest listModelPackagesRequest)

      Lists the model packages that have been created.

      Parameters:
      listModelPackagesRequest -
      Returns:
      A Java Future containing the result of the ListModelPackages 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackages

      default CompletableFuture<ListModelPackagesResponse> listModelPackages(Consumer<ListModelPackagesRequest.Builder> listModelPackagesRequest)

      Lists the model packages that have been created.


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

      Parameters:
      listModelPackagesRequest - A Consumer that will call methods on ListModelPackagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelPackages 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackages

      default CompletableFuture<ListModelPackagesResponse> listModelPackages()

      Lists the model packages that have been created.

      Returns:
      A Java Future containing the result of the ListModelPackages 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackagesPaginator

      default ListModelPackagesPublisher listModelPackagesPaginator()

      This is a variant of listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackagesPaginator

      default ListModelPackagesPublisher listModelPackagesPaginator(ListModelPackagesRequest listModelPackagesRequest)

      This is a variant of listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation.

      Parameters:
      listModelPackagesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelPackagesPaginator

      default ListModelPackagesPublisher listModelPackagesPaginator(Consumer<ListModelPackagesRequest.Builder> listModelPackagesRequest)

      This is a variant of listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesPublisher publisher = client.listModelPackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest) operation.


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

      Parameters:
      listModelPackagesRequest - A Consumer that will call methods on ListModelPackagesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelQualityJobDefinitions

      default CompletableFuture<ListModelQualityJobDefinitionsResponse> listModelQualityJobDefinitions(ListModelQualityJobDefinitionsRequest listModelQualityJobDefinitionsRequest)

      Gets a list of model quality monitoring job definitions in your account.

      Parameters:
      listModelQualityJobDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListModelQualityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelQualityJobDefinitions

      default CompletableFuture<ListModelQualityJobDefinitionsResponse> listModelQualityJobDefinitions(Consumer<ListModelQualityJobDefinitionsRequest.Builder> listModelQualityJobDefinitionsRequest)

      Gets a list of model quality monitoring job definitions in your account.


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

      Parameters:
      listModelQualityJobDefinitionsRequest - A Consumer that will call methods on ListModelQualityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModelQualityJobDefinitions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelQualityJobDefinitionsPaginator

      default ListModelQualityJobDefinitionsPublisher listModelQualityJobDefinitionsPaginator(ListModelQualityJobDefinitionsRequest listModelQualityJobDefinitionsRequest)

      This is a variant of listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsPublisher publisher = client.listModelQualityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsPublisher publisher = client.listModelQualityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest) operation.

      Parameters:
      listModelQualityJobDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelQualityJobDefinitionsPaginator

      default ListModelQualityJobDefinitionsPublisher listModelQualityJobDefinitionsPaginator(Consumer<ListModelQualityJobDefinitionsRequest.Builder> listModelQualityJobDefinitionsRequest)

      This is a variant of listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsPublisher publisher = client.listModelQualityJobDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsPublisher publisher = client.listModelQualityJobDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest) operation.


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

      Parameters:
      listModelQualityJobDefinitionsRequest - A Consumer that will call methods on ListModelQualityJobDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModels

      default CompletableFuture<ListModelsResponse> listModels(ListModelsRequest listModelsRequest)

      Lists models created with the CreateModel API.

      Parameters:
      listModelsRequest -
      Returns:
      A Java Future containing the result of the ListModels 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModels

      default CompletableFuture<ListModelsResponse> listModels(Consumer<ListModelsRequest.Builder> listModelsRequest)

      Lists models created with the CreateModel API.


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

      Parameters:
      listModelsRequest - A Consumer that will call methods on ListModelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListModels 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModels

      default CompletableFuture<ListModelsResponse> listModels()

      Lists models created with the CreateModel API.

      Returns:
      A Java Future containing the result of the ListModels 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelsPaginator

      default ListModelsPublisher listModelsPaginator()

      This is a variant of listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelsPaginator

      default ListModelsPublisher listModelsPaginator(ListModelsRequest listModelsRequest)

      This is a variant of listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation.

      Parameters:
      listModelsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listModelsPaginator

      default ListModelsPublisher listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest)

      This is a variant of listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListModelsPublisher publisher = client.listModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest) operation.


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

      Parameters:
      listModelsRequest - A Consumer that will call methods on ListModelsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertHistory

      default CompletableFuture<ListMonitoringAlertHistoryResponse> listMonitoringAlertHistory(ListMonitoringAlertHistoryRequest listMonitoringAlertHistoryRequest)

      Gets a list of past alerts in a model monitoring schedule.

      Parameters:
      listMonitoringAlertHistoryRequest -
      Returns:
      A Java Future containing the result of the ListMonitoringAlertHistory 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertHistory

      default CompletableFuture<ListMonitoringAlertHistoryResponse> listMonitoringAlertHistory(Consumer<ListMonitoringAlertHistoryRequest.Builder> listMonitoringAlertHistoryRequest)

      Gets a list of past alerts in a model monitoring schedule.


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

      Parameters:
      listMonitoringAlertHistoryRequest - A Consumer that will call methods on ListMonitoringAlertHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitoringAlertHistory 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertHistoryPaginator

      default ListMonitoringAlertHistoryPublisher listMonitoringAlertHistoryPaginator(ListMonitoringAlertHistoryRequest listMonitoringAlertHistoryRequest)

      This is a variant of listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryPublisher publisher = client.listMonitoringAlertHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryPublisher publisher = client.listMonitoringAlertHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest) operation.

      Parameters:
      listMonitoringAlertHistoryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertHistoryPaginator

      default ListMonitoringAlertHistoryPublisher listMonitoringAlertHistoryPaginator(Consumer<ListMonitoringAlertHistoryRequest.Builder> listMonitoringAlertHistoryRequest)

      This is a variant of listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryPublisher publisher = client.listMonitoringAlertHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryPublisher publisher = client.listMonitoringAlertHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest) operation.


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

      Parameters:
      listMonitoringAlertHistoryRequest - A Consumer that will call methods on ListMonitoringAlertHistoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlerts

      default CompletableFuture<ListMonitoringAlertsResponse> listMonitoringAlerts(ListMonitoringAlertsRequest listMonitoringAlertsRequest)

      Gets the alerts for a single monitoring schedule.

      Parameters:
      listMonitoringAlertsRequest -
      Returns:
      A Java Future containing the result of the ListMonitoringAlerts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlerts

      default CompletableFuture<ListMonitoringAlertsResponse> listMonitoringAlerts(Consumer<ListMonitoringAlertsRequest.Builder> listMonitoringAlertsRequest)

      Gets the alerts for a single monitoring schedule.


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

      Parameters:
      listMonitoringAlertsRequest - A Consumer that will call methods on ListMonitoringAlertsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitoringAlerts 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertsPaginator

      default ListMonitoringAlertsPublisher listMonitoringAlertsPaginator(ListMonitoringAlertsRequest listMonitoringAlertsRequest)

      This is a variant of listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsPublisher publisher = client.listMonitoringAlertsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsPublisher publisher = client.listMonitoringAlertsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest) operation.

      Parameters:
      listMonitoringAlertsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringAlertsPaginator

      default ListMonitoringAlertsPublisher listMonitoringAlertsPaginator(Consumer<ListMonitoringAlertsRequest.Builder> listMonitoringAlertsRequest)

      This is a variant of listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsPublisher publisher = client.listMonitoringAlertsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsPublisher publisher = client.listMonitoringAlertsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest) operation.


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

      Parameters:
      listMonitoringAlertsRequest - A Consumer that will call methods on ListMonitoringAlertsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringExecutions

      default CompletableFuture<ListMonitoringExecutionsResponse> listMonitoringExecutions(ListMonitoringExecutionsRequest listMonitoringExecutionsRequest)

      Returns list of all monitoring job executions.

      Parameters:
      listMonitoringExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListMonitoringExecutions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringExecutions

      default CompletableFuture<ListMonitoringExecutionsResponse> listMonitoringExecutions(Consumer<ListMonitoringExecutionsRequest.Builder> listMonitoringExecutionsRequest)

      Returns list of all monitoring job executions.


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

      Parameters:
      listMonitoringExecutionsRequest - A Consumer that will call methods on ListMonitoringExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitoringExecutions 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringExecutionsPaginator

      default ListMonitoringExecutionsPublisher listMonitoringExecutionsPaginator(ListMonitoringExecutionsRequest listMonitoringExecutionsRequest)

      This is a variant of listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsPublisher publisher = client.listMonitoringExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsPublisher publisher = client.listMonitoringExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest) operation.

      Parameters:
      listMonitoringExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringExecutionsPaginator

      default ListMonitoringExecutionsPublisher listMonitoringExecutionsPaginator(Consumer<ListMonitoringExecutionsRequest.Builder> listMonitoringExecutionsRequest)

      This is a variant of listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsPublisher publisher = client.listMonitoringExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsPublisher publisher = client.listMonitoringExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest) operation.


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

      Parameters:
      listMonitoringExecutionsRequest - A Consumer that will call methods on ListMonitoringExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringSchedules

      default CompletableFuture<ListMonitoringSchedulesResponse> listMonitoringSchedules(ListMonitoringSchedulesRequest listMonitoringSchedulesRequest)

      Returns list of all monitoring schedules.

      Parameters:
      listMonitoringSchedulesRequest -
      Returns:
      A Java Future containing the result of the ListMonitoringSchedules 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringSchedules

      default CompletableFuture<ListMonitoringSchedulesResponse> listMonitoringSchedules(Consumer<ListMonitoringSchedulesRequest.Builder> listMonitoringSchedulesRequest)

      Returns list of all monitoring schedules.


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

      Parameters:
      listMonitoringSchedulesRequest - A Consumer that will call methods on ListMonitoringSchedulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMonitoringSchedules 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringSchedulesPaginator

      default ListMonitoringSchedulesPublisher listMonitoringSchedulesPaginator(ListMonitoringSchedulesRequest listMonitoringSchedulesRequest)

      This is a variant of listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesPublisher publisher = client.listMonitoringSchedulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesPublisher publisher = client.listMonitoringSchedulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest) operation.

      Parameters:
      listMonitoringSchedulesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMonitoringSchedulesPaginator

      default ListMonitoringSchedulesPublisher listMonitoringSchedulesPaginator(Consumer<ListMonitoringSchedulesRequest.Builder> listMonitoringSchedulesRequest)

      This is a variant of listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesPublisher publisher = client.listMonitoringSchedulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesPublisher publisher = client.listMonitoringSchedulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest) operation.


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

      Parameters:
      listMonitoringSchedulesRequest - A Consumer that will call methods on ListMonitoringSchedulesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigs

      default CompletableFuture<ListNotebookInstanceLifecycleConfigsResponse> listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)

      Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

      Parameters:
      listNotebookInstanceLifecycleConfigsRequest -
      Returns:
      A Java Future containing the result of the ListNotebookInstanceLifecycleConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigs

      default CompletableFuture<ListNotebookInstanceLifecycleConfigsResponse> listNotebookInstanceLifecycleConfigs(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest)

      Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.


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

      Parameters:
      listNotebookInstanceLifecycleConfigsRequest - A Consumer that will call methods on ListNotebookInstanceLifecycleConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNotebookInstanceLifecycleConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigs

      default CompletableFuture<ListNotebookInstanceLifecycleConfigsResponse> listNotebookInstanceLifecycleConfigs()

      Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

      Returns:
      A Java Future containing the result of the ListNotebookInstanceLifecycleConfigs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigsPaginator

      default ListNotebookInstanceLifecycleConfigsPublisher listNotebookInstanceLifecycleConfigsPaginator()

      This is a variant of listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigsPaginator

      default ListNotebookInstanceLifecycleConfigsPublisher listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)

      This is a variant of listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation.

      Parameters:
      listNotebookInstanceLifecycleConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstanceLifecycleConfigsPaginator

      default ListNotebookInstanceLifecycleConfigsPublisher listNotebookInstanceLifecycleConfigsPaginator(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest)

      This is a variant of listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsPublisher publisher = client.listNotebookInstanceLifecycleConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest) operation.


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

      Parameters:
      listNotebookInstanceLifecycleConfigsRequest - A Consumer that will call methods on ListNotebookInstanceLifecycleConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstances

      default CompletableFuture<ListNotebookInstancesResponse> listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest)

      Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

      Parameters:
      listNotebookInstancesRequest -
      Returns:
      A Java Future containing the result of the ListNotebookInstances 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstances

      default CompletableFuture<ListNotebookInstancesResponse> listNotebookInstances(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest)

      Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.


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

      Parameters:
      listNotebookInstancesRequest - A Consumer that will call methods on ListNotebookInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNotebookInstances 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstances

      default CompletableFuture<ListNotebookInstancesResponse> listNotebookInstances()

      Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

      Returns:
      A Java Future containing the result of the ListNotebookInstances 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstancesPaginator

      default ListNotebookInstancesPublisher listNotebookInstancesPaginator()

      This is a variant of listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstancesPaginator

      default ListNotebookInstancesPublisher listNotebookInstancesPaginator(ListNotebookInstancesRequest listNotebookInstancesRequest)

      This is a variant of listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation.

      Parameters:
      listNotebookInstancesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookInstancesPaginator

      default ListNotebookInstancesPublisher listNotebookInstancesPaginator(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest)

      This is a variant of listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesPublisher publisher = client.listNotebookInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest) operation.


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

      Parameters:
      listNotebookInstancesRequest - A Consumer that will call methods on ListNotebookInstancesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionSteps

      default CompletableFuture<ListPipelineExecutionStepsResponse> listPipelineExecutionSteps(ListPipelineExecutionStepsRequest listPipelineExecutionStepsRequest)

      Gets a list of PipeLineExecutionStep objects.

      Parameters:
      listPipelineExecutionStepsRequest -
      Returns:
      A Java Future containing the result of the ListPipelineExecutionSteps 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionSteps

      default CompletableFuture<ListPipelineExecutionStepsResponse> listPipelineExecutionSteps(Consumer<ListPipelineExecutionStepsRequest.Builder> listPipelineExecutionStepsRequest)

      Gets a list of PipeLineExecutionStep objects.


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

      Parameters:
      listPipelineExecutionStepsRequest - A Consumer that will call methods on ListPipelineExecutionStepsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelineExecutionSteps 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionStepsPaginator

      default ListPipelineExecutionStepsPublisher listPipelineExecutionStepsPaginator(ListPipelineExecutionStepsRequest listPipelineExecutionStepsRequest)

      This is a variant of listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsPublisher publisher = client.listPipelineExecutionStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsPublisher publisher = client.listPipelineExecutionStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest) operation.

      Parameters:
      listPipelineExecutionStepsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionStepsPaginator

      default ListPipelineExecutionStepsPublisher listPipelineExecutionStepsPaginator(Consumer<ListPipelineExecutionStepsRequest.Builder> listPipelineExecutionStepsRequest)

      This is a variant of listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsPublisher publisher = client.listPipelineExecutionStepsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsPublisher publisher = client.listPipelineExecutionStepsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest) operation.


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

      Parameters:
      listPipelineExecutionStepsRequest - A Consumer that will call methods on ListPipelineExecutionStepsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutions

      default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest)

      Gets a list of the pipeline executions.

      Parameters:
      listPipelineExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListPipelineExecutions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutions

      default CompletableFuture<ListPipelineExecutionsResponse> listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)

      Gets a list of the pipeline executions.


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

      Parameters:
      listPipelineExecutionsRequest - A Consumer that will call methods on ListPipelineExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelineExecutions 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionsPaginator

      default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest)

      This is a variant of listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest) operation.

      Parameters:
      listPipelineExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineExecutionsPaginator

      default ListPipelineExecutionsPublisher listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest)

      This is a variant of listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsPublisher publisher = client.listPipelineExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest) operation.


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

      Parameters:
      listPipelineExecutionsRequest - A Consumer that will call methods on ListPipelineExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineParametersForExecution

      default CompletableFuture<ListPipelineParametersForExecutionResponse> listPipelineParametersForExecution(ListPipelineParametersForExecutionRequest listPipelineParametersForExecutionRequest)

      Gets a list of parameters for a pipeline execution.

      Parameters:
      listPipelineParametersForExecutionRequest -
      Returns:
      A Java Future containing the result of the ListPipelineParametersForExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineParametersForExecution

      default CompletableFuture<ListPipelineParametersForExecutionResponse> listPipelineParametersForExecution(Consumer<ListPipelineParametersForExecutionRequest.Builder> listPipelineParametersForExecutionRequest)

      Gets a list of parameters for a pipeline execution.


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

      Parameters:
      listPipelineParametersForExecutionRequest - A Consumer that will call methods on ListPipelineParametersForExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelineParametersForExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineParametersForExecutionPaginator

      default ListPipelineParametersForExecutionPublisher listPipelineParametersForExecutionPaginator(ListPipelineParametersForExecutionRequest listPipelineParametersForExecutionRequest)

      This is a variant of listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionPublisher publisher = client.listPipelineParametersForExecutionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionPublisher publisher = client.listPipelineParametersForExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest) operation.

      Parameters:
      listPipelineParametersForExecutionRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineParametersForExecutionPaginator

      default ListPipelineParametersForExecutionPublisher listPipelineParametersForExecutionPaginator(Consumer<ListPipelineParametersForExecutionRequest.Builder> listPipelineParametersForExecutionRequest)

      This is a variant of listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionPublisher publisher = client.listPipelineParametersForExecutionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionPublisher publisher = client.listPipelineParametersForExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest) operation.


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

      Parameters:
      listPipelineParametersForExecutionRequest - A Consumer that will call methods on ListPipelineParametersForExecutionRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)

      Gets a list of pipelines.

      Parameters:
      listPipelinesRequest -
      Returns:
      A Java Future containing the result of the ListPipelines 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      Gets a list of pipelines.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelines 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest) operation.

      Parameters:
      listPipelinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest) operation.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProcessingJobs

      default CompletableFuture<ListProcessingJobsResponse> listProcessingJobs(ListProcessingJobsRequest listProcessingJobsRequest)

      Lists processing jobs that satisfy various filters.

      Parameters:
      listProcessingJobsRequest -
      Returns:
      A Java Future containing the result of the ListProcessingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProcessingJobs

      default CompletableFuture<ListProcessingJobsResponse> listProcessingJobs(Consumer<ListProcessingJobsRequest.Builder> listProcessingJobsRequest)

      Lists processing jobs that satisfy various filters.


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

      Parameters:
      listProcessingJobsRequest - A Consumer that will call methods on ListProcessingJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProcessingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProcessingJobsPaginator

      default ListProcessingJobsPublisher listProcessingJobsPaginator(ListProcessingJobsRequest listProcessingJobsRequest)

      This is a variant of listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsPublisher publisher = client.listProcessingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsPublisher publisher = client.listProcessingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest) operation.

      Parameters:
      listProcessingJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProcessingJobsPaginator

      default ListProcessingJobsPublisher listProcessingJobsPaginator(Consumer<ListProcessingJobsRequest.Builder> listProcessingJobsRequest)

      This is a variant of listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsPublisher publisher = client.listProcessingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsPublisher publisher = client.listProcessingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest) operation.


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

      Parameters:
      listProcessingJobsRequest - A Consumer that will call methods on ListProcessingJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)

      Gets a list of the projects in an Amazon Web Services account.

      Parameters:
      listProjectsRequest -
      Returns:
      A Java Future containing the result of the ListProjects 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjects

      default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

      Gets a list of the projects in an Amazon Web Services account.


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

      Parameters:
      listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListProjects 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectsPaginator

      default ListProjectsPublisher listProjectsPaginator(ListProjectsRequest listProjectsRequest)

      This is a variant of listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest) operation.

      Parameters:
      listProjectsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listProjectsPaginator

      default ListProjectsPublisher listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)

      This is a variant of listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest) operation.


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

      Parameters:
      listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceCatalogs

      default CompletableFuture<ListResourceCatalogsResponse> listResourceCatalogs(ListResourceCatalogsRequest listResourceCatalogsRequest)

      Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.

      Parameters:
      listResourceCatalogsRequest -
      Returns:
      A Java Future containing the result of the ListResourceCatalogs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceCatalogs

      default CompletableFuture<ListResourceCatalogsResponse> listResourceCatalogs(Consumer<ListResourceCatalogsRequest.Builder> listResourceCatalogsRequest)

      Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.


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

      Parameters:
      listResourceCatalogsRequest - A Consumer that will call methods on ListResourceCatalogsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListResourceCatalogs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceCatalogsPaginator

      default ListResourceCatalogsPublisher listResourceCatalogsPaginator(ListResourceCatalogsRequest listResourceCatalogsRequest)

      This is a variant of listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsPublisher publisher = client.listResourceCatalogsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsPublisher publisher = client.listResourceCatalogsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest) operation.

      Parameters:
      listResourceCatalogsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourceCatalogsPaginator

      default ListResourceCatalogsPublisher listResourceCatalogsPaginator(Consumer<ListResourceCatalogsRequest.Builder> listResourceCatalogsRequest)

      This is a variant of listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsPublisher publisher = client.listResourceCatalogsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsPublisher publisher = client.listResourceCatalogsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest) operation.


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

      Parameters:
      listResourceCatalogsRequest - A Consumer that will call methods on ListResourceCatalogsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSpaces

      default CompletableFuture<ListSpacesResponse> listSpaces(ListSpacesRequest listSpacesRequest)

      Lists spaces.

      Parameters:
      listSpacesRequest -
      Returns:
      A Java Future containing the result of the ListSpaces 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSpaces

      default CompletableFuture<ListSpacesResponse> listSpaces(Consumer<ListSpacesRequest.Builder> listSpacesRequest)

      Lists spaces.


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

      Parameters:
      listSpacesRequest - A Consumer that will call methods on ListSpacesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSpaces 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSpacesPaginator

      default ListSpacesPublisher listSpacesPaginator(ListSpacesRequest listSpacesRequest)

      This is a variant of listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest) operation.

      Parameters:
      listSpacesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSpacesPaginator

      default ListSpacesPublisher listSpacesPaginator(Consumer<ListSpacesRequest.Builder> listSpacesRequest)

      This is a variant of listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest) operation.


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

      Parameters:
      listSpacesRequest - A Consumer that will call methods on ListSpacesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStageDevices

      default CompletableFuture<ListStageDevicesResponse> listStageDevices(ListStageDevicesRequest listStageDevicesRequest)

      Lists devices allocated to the stage, containing detailed device information and deployment status.

      Parameters:
      listStageDevicesRequest -
      Returns:
      A Java Future containing the result of the ListStageDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStageDevices

      default CompletableFuture<ListStageDevicesResponse> listStageDevices(Consumer<ListStageDevicesRequest.Builder> listStageDevicesRequest)

      Lists devices allocated to the stage, containing detailed device information and deployment status.


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

      Parameters:
      listStageDevicesRequest - A Consumer that will call methods on ListStageDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStageDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStageDevicesPaginator

      default ListStageDevicesPublisher listStageDevicesPaginator(ListStageDevicesRequest listStageDevicesRequest)

      This is a variant of listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesPublisher publisher = client.listStageDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesPublisher publisher = client.listStageDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest) operation.

      Parameters:
      listStageDevicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStageDevicesPaginator

      default ListStageDevicesPublisher listStageDevicesPaginator(Consumer<ListStageDevicesRequest.Builder> listStageDevicesRequest)

      This is a variant of listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesPublisher publisher = client.listStageDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesPublisher publisher = client.listStageDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest) operation.


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

      Parameters:
      listStageDevicesRequest - A Consumer that will call methods on ListStageDevicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStudioLifecycleConfigs

      default CompletableFuture<ListStudioLifecycleConfigsResponse> listStudioLifecycleConfigs(ListStudioLifecycleConfigsRequest listStudioLifecycleConfigsRequest)

      Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

      Parameters:
      listStudioLifecycleConfigsRequest -
      Returns:
      A Java Future containing the result of the ListStudioLifecycleConfigs 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStudioLifecycleConfigs

      default CompletableFuture<ListStudioLifecycleConfigsResponse> listStudioLifecycleConfigs(Consumer<ListStudioLifecycleConfigsRequest.Builder> listStudioLifecycleConfigsRequest)

      Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.


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

      Parameters:
      listStudioLifecycleConfigsRequest - A Consumer that will call methods on ListStudioLifecycleConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStudioLifecycleConfigs 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStudioLifecycleConfigsPaginator

      default ListStudioLifecycleConfigsPublisher listStudioLifecycleConfigsPaginator(ListStudioLifecycleConfigsRequest listStudioLifecycleConfigsRequest)

      This is a variant of listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsPublisher publisher = client.listStudioLifecycleConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsPublisher publisher = client.listStudioLifecycleConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest) operation.

      Parameters:
      listStudioLifecycleConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStudioLifecycleConfigsPaginator

      default ListStudioLifecycleConfigsPublisher listStudioLifecycleConfigsPaginator(Consumer<ListStudioLifecycleConfigsRequest.Builder> listStudioLifecycleConfigsRequest)

      This is a variant of listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsPublisher publisher = client.listStudioLifecycleConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsPublisher publisher = client.listStudioLifecycleConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest) operation.


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

      Parameters:
      listStudioLifecycleConfigsRequest - A Consumer that will call methods on ListStudioLifecycleConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteams

      default CompletableFuture<ListSubscribedWorkteamsResponse> listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)

      Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

      Parameters:
      listSubscribedWorkteamsRequest -
      Returns:
      A Java Future containing the result of the ListSubscribedWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteams

      default CompletableFuture<ListSubscribedWorkteamsResponse> listSubscribedWorkteams(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest)

      Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.


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

      Parameters:
      listSubscribedWorkteamsRequest - A Consumer that will call methods on ListSubscribedWorkteamsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSubscribedWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteams

      default CompletableFuture<ListSubscribedWorkteamsResponse> listSubscribedWorkteams()

      Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

      Returns:
      A Java Future containing the result of the ListSubscribedWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteamsPaginator

      default ListSubscribedWorkteamsPublisher listSubscribedWorkteamsPaginator()

      This is a variant of listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteamsPaginator

      default ListSubscribedWorkteamsPublisher listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)

      This is a variant of listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation.

      Parameters:
      listSubscribedWorkteamsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSubscribedWorkteamsPaginator

      default ListSubscribedWorkteamsPublisher listSubscribedWorkteamsPaginator(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest)

      This is a variant of listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsPublisher publisher = client.listSubscribedWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest) operation.


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

      Parameters:
      listSubscribedWorkteamsRequest - A Consumer that will call methods on ListSubscribedWorkteamsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

      Returns the tags for the specified SageMaker resource.

      Parameters:
      listTagsRequest -
      Returns:
      A Java Future containing the result of the ListTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)

      Returns the tags for the specified SageMaker resource.


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

      Parameters:
      listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTags 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsPaginator

      default ListTagsPublisher listTagsPaginator(ListTagsRequest listTagsRequest)

      This is a variant of listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTagsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest) operation.

      Parameters:
      listTagsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsPaginator

      default ListTagsPublisher listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)

      This is a variant of listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTagsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest) operation.


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

      Parameters:
      listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobs

      default CompletableFuture<ListTrainingJobsResponse> listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest)

      Lists training jobs.

      When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

      For example, if ListTrainingJobs is invoked with the following parameters:

      { ... MaxResults: 100, StatusEquals: InProgress ... }

      First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

      You can quickly test the API using the following Amazon Web Services CLI code.

      aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

      Parameters:
      listTrainingJobsRequest -
      Returns:
      A Java Future containing the result of the ListTrainingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobs

      default CompletableFuture<ListTrainingJobsResponse> listTrainingJobs(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest)

      Lists training jobs.

      When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

      For example, if ListTrainingJobs is invoked with the following parameters:

      { ... MaxResults: 100, StatusEquals: InProgress ... }

      First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

      You can quickly test the API using the following Amazon Web Services CLI code.

      aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress


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

      Parameters:
      listTrainingJobsRequest - A Consumer that will call methods on ListTrainingJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrainingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobs

      default CompletableFuture<ListTrainingJobsResponse> listTrainingJobs()

      Lists training jobs.

      When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

      For example, if ListTrainingJobs is invoked with the following parameters:

      { ... MaxResults: 100, StatusEquals: InProgress ... }

      First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

      You can quickly test the API using the following Amazon Web Services CLI code.

      aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

      Returns:
      A Java Future containing the result of the ListTrainingJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsForHyperParameterTuningJob

      default CompletableFuture<ListTrainingJobsForHyperParameterTuningJobResponse> listTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)

      Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

      Parameters:
      listTrainingJobsForHyperParameterTuningJobRequest -
      Returns:
      A Java Future containing the result of the ListTrainingJobsForHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsForHyperParameterTuningJob

      default CompletableFuture<ListTrainingJobsForHyperParameterTuningJobResponse> listTrainingJobsForHyperParameterTuningJob(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest)

      Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.


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

      Parameters:
      listTrainingJobsForHyperParameterTuningJobRequest - A Consumer that will call methods on ListTrainingJobsForHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrainingJobsForHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsForHyperParameterTuningJobPaginator

      default ListTrainingJobsForHyperParameterTuningJobPublisher listTrainingJobsForHyperParameterTuningJobPaginator(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)

      This is a variant of listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobPublisher publisher = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobPublisher publisher = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest) operation.

      Parameters:
      listTrainingJobsForHyperParameterTuningJobRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsForHyperParameterTuningJobPaginator

      default ListTrainingJobsForHyperParameterTuningJobPublisher listTrainingJobsForHyperParameterTuningJobPaginator(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest)

      This is a variant of listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobPublisher publisher = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobPublisher publisher = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest) operation.


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

      Parameters:
      listTrainingJobsForHyperParameterTuningJobRequest - A Consumer that will call methods on ListTrainingJobsForHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsPaginator

      default ListTrainingJobsPublisher listTrainingJobsPaginator()

      This is a variant of listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsPaginator

      default ListTrainingJobsPublisher listTrainingJobsPaginator(ListTrainingJobsRequest listTrainingJobsRequest)

      This is a variant of listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation.

      Parameters:
      listTrainingJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrainingJobsPaginator

      default ListTrainingJobsPublisher listTrainingJobsPaginator(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest)

      This is a variant of listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsPublisher publisher = client.listTrainingJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest) operation.


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

      Parameters:
      listTrainingJobsRequest - A Consumer that will call methods on ListTrainingJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobs

      default CompletableFuture<ListTransformJobsResponse> listTransformJobs(ListTransformJobsRequest listTransformJobsRequest)

      Lists transform jobs.

      Parameters:
      listTransformJobsRequest -
      Returns:
      A Java Future containing the result of the ListTransformJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobs

      default CompletableFuture<ListTransformJobsResponse> listTransformJobs(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest)

      Lists transform jobs.


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

      Parameters:
      listTransformJobsRequest - A Consumer that will call methods on ListTransformJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTransformJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobs

      default CompletableFuture<ListTransformJobsResponse> listTransformJobs()

      Lists transform jobs.

      Returns:
      A Java Future containing the result of the ListTransformJobs 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobsPaginator

      default ListTransformJobsPublisher listTransformJobsPaginator()

      This is a variant of listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobsPaginator

      default ListTransformJobsPublisher listTransformJobsPaginator(ListTransformJobsRequest listTransformJobsRequest)

      This is a variant of listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation.

      Parameters:
      listTransformJobsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTransformJobsPaginator

      default ListTransformJobsPublisher listTransformJobsPaginator(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest)

      This is a variant of listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsPublisher publisher = client.listTransformJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest) operation.


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

      Parameters:
      listTransformJobsRequest - A Consumer that will call methods on ListTransformJobsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialComponents

      default CompletableFuture<ListTrialComponentsResponse> listTrialComponents(ListTrialComponentsRequest listTrialComponentsRequest)

      Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

      • ExperimentName

      • SourceArn

      • TrialName

      Parameters:
      listTrialComponentsRequest -
      Returns:
      A Java Future containing the result of the ListTrialComponents 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialComponents

      default CompletableFuture<ListTrialComponentsResponse> listTrialComponents(Consumer<ListTrialComponentsRequest.Builder> listTrialComponentsRequest)

      Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

      • ExperimentName

      • SourceArn

      • TrialName


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

      Parameters:
      listTrialComponentsRequest - A Consumer that will call methods on ListTrialComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrialComponents 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialComponentsPaginator

      default ListTrialComponentsPublisher listTrialComponentsPaginator(ListTrialComponentsRequest listTrialComponentsRequest)

      This is a variant of listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsPublisher publisher = client.listTrialComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsPublisher publisher = client.listTrialComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest) operation.

      Parameters:
      listTrialComponentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialComponentsPaginator

      default ListTrialComponentsPublisher listTrialComponentsPaginator(Consumer<ListTrialComponentsRequest.Builder> listTrialComponentsRequest)

      This is a variant of listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsPublisher publisher = client.listTrialComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsPublisher publisher = client.listTrialComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest) operation.


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

      Parameters:
      listTrialComponentsRequest - A Consumer that will call methods on ListTrialComponentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrials

      default CompletableFuture<ListTrialsResponse> listTrials(ListTrialsRequest listTrialsRequest)

      Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

      Parameters:
      listTrialsRequest -
      Returns:
      A Java Future containing the result of the ListTrials 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrials

      default CompletableFuture<ListTrialsResponse> listTrials(Consumer<ListTrialsRequest.Builder> listTrialsRequest)

      Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.


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

      Parameters:
      listTrialsRequest - A Consumer that will call methods on ListTrialsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrials 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialsPaginator

      default ListTrialsPublisher listTrialsPaginator(ListTrialsRequest listTrialsRequest)

      This is a variant of listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialsPublisher publisher = client.listTrialsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialsPublisher publisher = client.listTrialsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest) operation.

      Parameters:
      listTrialsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrialsPaginator

      default ListTrialsPublisher listTrialsPaginator(Consumer<ListTrialsRequest.Builder> listTrialsRequest)

      This is a variant of listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialsPublisher publisher = client.listTrialsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListTrialsPublisher publisher = client.listTrialsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest) operation.


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

      Parameters:
      listTrialsRequest - A Consumer that will call methods on ListTrialsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProfiles

      default CompletableFuture<ListUserProfilesResponse> listUserProfiles(ListUserProfilesRequest listUserProfilesRequest)

      Lists user profiles.

      Parameters:
      listUserProfilesRequest -
      Returns:
      A Java Future containing the result of the ListUserProfiles 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProfiles

      default CompletableFuture<ListUserProfilesResponse> listUserProfiles(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest)

      Lists user profiles.


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

      Parameters:
      listUserProfilesRequest - A Consumer that will call methods on ListUserProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUserProfiles 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProfilesPaginator

      default ListUserProfilesPublisher listUserProfilesPaginator(ListUserProfilesRequest listUserProfilesRequest)

      This is a variant of listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesPublisher publisher = client.listUserProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesPublisher publisher = client.listUserProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest) operation.

      Parameters:
      listUserProfilesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProfilesPaginator

      default ListUserProfilesPublisher listUserProfilesPaginator(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest)

      This is a variant of listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesPublisher publisher = client.listUserProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesPublisher publisher = client.listUserProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest) operation.


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

      Parameters:
      listUserProfilesRequest - A Consumer that will call methods on ListUserProfilesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkforces

      default CompletableFuture<ListWorkforcesResponse> listWorkforces(ListWorkforcesRequest listWorkforcesRequest)

      Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

      Parameters:
      listWorkforcesRequest -
      Returns:
      A Java Future containing the result of the ListWorkforces 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkforces

      default CompletableFuture<ListWorkforcesResponse> listWorkforces(Consumer<ListWorkforcesRequest.Builder> listWorkforcesRequest)

      Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.


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

      Parameters:
      listWorkforcesRequest - A Consumer that will call methods on ListWorkforcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkforces 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkforcesPaginator

      default ListWorkforcesPublisher listWorkforcesPaginator(ListWorkforcesRequest listWorkforcesRequest)

      This is a variant of listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesPublisher publisher = client.listWorkforcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesPublisher publisher = client.listWorkforcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest) operation.

      Parameters:
      listWorkforcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkforcesPaginator

      default ListWorkforcesPublisher listWorkforcesPaginator(Consumer<ListWorkforcesRequest.Builder> listWorkforcesRequest)

      This is a variant of listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesPublisher publisher = client.listWorkforcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesPublisher publisher = client.listWorkforcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest) operation.


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

      Parameters:
      listWorkforcesRequest - A Consumer that will call methods on ListWorkforcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteams

      default CompletableFuture<ListWorkteamsResponse> listWorkteams(ListWorkteamsRequest listWorkteamsRequest)

      Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

      Parameters:
      listWorkteamsRequest -
      Returns:
      A Java Future containing the result of the ListWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteams

      default CompletableFuture<ListWorkteamsResponse> listWorkteams(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest)

      Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.


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

      Parameters:
      listWorkteamsRequest - A Consumer that will call methods on ListWorkteamsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteams

      default CompletableFuture<ListWorkteamsResponse> listWorkteams()

      Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

      Returns:
      A Java Future containing the result of the ListWorkteams 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteamsPaginator

      default ListWorkteamsPublisher listWorkteamsPaginator()

      This is a variant of listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteamsPaginator

      default ListWorkteamsPublisher listWorkteamsPaginator(ListWorkteamsRequest listWorkteamsRequest)

      This is a variant of listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation.

      Parameters:
      listWorkteamsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkteamsPaginator

      default ListWorkteamsPublisher listWorkteamsPaginator(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest)

      This is a variant of listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsPublisher publisher = client.listWorkteamsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest) operation.


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

      Parameters:
      listWorkteamsRequest - A Consumer that will call methods on ListWorkteamsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putModelPackageGroupPolicy

      default CompletableFuture<PutModelPackageGroupPolicyResponse> putModelPackageGroupPolicy(PutModelPackageGroupPolicyRequest putModelPackageGroupPolicyRequest)

      Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

      Parameters:
      putModelPackageGroupPolicyRequest -
      Returns:
      A Java Future containing the result of the PutModelPackageGroupPolicy 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putModelPackageGroupPolicy

      default CompletableFuture<PutModelPackageGroupPolicyResponse> putModelPackageGroupPolicy(Consumer<PutModelPackageGroupPolicyRequest.Builder> putModelPackageGroupPolicyRequest)

      Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..


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

      Parameters:
      putModelPackageGroupPolicyRequest - A Consumer that will call methods on PutModelPackageGroupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutModelPackageGroupPolicy 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryLineage

      default CompletableFuture<QueryLineageResponse> queryLineage(QueryLineageRequest queryLineageRequest)

      Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

      Parameters:
      queryLineageRequest -
      Returns:
      A Java Future containing the result of the QueryLineage 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryLineage

      default CompletableFuture<QueryLineageResponse> queryLineage(Consumer<QueryLineageRequest.Builder> queryLineageRequest)

      Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.


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

      Parameters:
      queryLineageRequest - A Consumer that will call methods on QueryLineageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the QueryLineage 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryLineagePaginator

      default QueryLineagePublisher queryLineagePaginator(QueryLineageRequest queryLineageRequest)

      This is a variant of queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.QueryLineagePublisher publisher = client.queryLineagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.QueryLineagePublisher publisher = client.queryLineagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest) operation.

      Parameters:
      queryLineageRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryLineagePaginator

      default QueryLineagePublisher queryLineagePaginator(Consumer<QueryLineageRequest.Builder> queryLineageRequest)

      This is a variant of queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.QueryLineagePublisher publisher = client.queryLineagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.QueryLineagePublisher publisher = client.queryLineagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest) operation.


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

      Parameters:
      queryLineageRequest - A Consumer that will call methods on QueryLineageRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerDevices

      default CompletableFuture<RegisterDevicesResponse> registerDevices(RegisterDevicesRequest registerDevicesRequest)

      Register devices.

      Parameters:
      registerDevicesRequest -
      Returns:
      A Java Future containing the result of the RegisterDevices 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerDevices

      default CompletableFuture<RegisterDevicesResponse> registerDevices(Consumer<RegisterDevicesRequest.Builder> registerDevicesRequest)

      Register devices.


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

      Parameters:
      registerDevicesRequest - A Consumer that will call methods on RegisterDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterDevices 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • renderUiTemplate

      default CompletableFuture<RenderUiTemplateResponse> renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest)

      Renders the UI template so that you can preview the worker's experience.

      Parameters:
      renderUiTemplateRequest -
      Returns:
      A Java Future containing the result of the RenderUiTemplate 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • renderUiTemplate

      default CompletableFuture<RenderUiTemplateResponse> renderUiTemplate(Consumer<RenderUiTemplateRequest.Builder> renderUiTemplateRequest)

      Renders the UI template so that you can preview the worker's experience.


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

      Parameters:
      renderUiTemplateRequest - A Consumer that will call methods on RenderUiTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RenderUiTemplate 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retryPipelineExecution

      default CompletableFuture<RetryPipelineExecutionResponse> retryPipelineExecution(RetryPipelineExecutionRequest retryPipelineExecutionRequest)

      Retry the execution of the pipeline.

      Parameters:
      retryPipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the RetryPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • retryPipelineExecution

      default CompletableFuture<RetryPipelineExecutionResponse> retryPipelineExecution(Consumer<RetryPipelineExecutionRequest.Builder> retryPipelineExecutionRequest)

      Retry the execution of the pipeline.


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

      Parameters:
      retryPipelineExecutionRequest - A Consumer that will call methods on RetryPipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RetryPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • search

      default CompletableFuture<SearchResponse> search(SearchRequest searchRequest)

      Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

      You can query against the following value types: numeric, text, Boolean, and timestamp.

      The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

      Parameters:
      searchRequest -
      Returns:
      A Java Future containing the result of the Search 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • search

      default CompletableFuture<SearchResponse> search(Consumer<SearchRequest.Builder> searchRequest)

      Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

      You can query against the following value types: numeric, text, Boolean, and timestamp.

      The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.


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

      Parameters:
      searchRequest - A Consumer that will call methods on SearchRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Search 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPaginator

      default SearchPublisher searchPaginator(SearchRequest searchRequest)

      This is a variant of search(software.amazon.awssdk.services.sagemaker.model.SearchRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.SearchPublisher publisher = client.searchPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.SearchPublisher publisher = client.searchPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.SearchResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.SearchResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the search(software.amazon.awssdk.services.sagemaker.model.SearchRequest) operation.

      Parameters:
      searchRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPaginator

      default SearchPublisher searchPaginator(Consumer<SearchRequest.Builder> searchRequest)

      This is a variant of search(software.amazon.awssdk.services.sagemaker.model.SearchRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sagemaker.paginators.SearchPublisher publisher = client.searchPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sagemaker.paginators.SearchPublisher publisher = client.searchPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemaker.model.SearchResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sagemaker.model.SearchResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the search(software.amazon.awssdk.services.sagemaker.model.SearchRequest) operation.


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

      Parameters:
      searchRequest - A Consumer that will call methods on SearchRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendPipelineExecutionStepFailure

      default CompletableFuture<SendPipelineExecutionStepFailureResponse> sendPipelineExecutionStepFailure(SendPipelineExecutionStepFailureRequest sendPipelineExecutionStepFailureRequest)

      Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

      Parameters:
      sendPipelineExecutionStepFailureRequest -
      Returns:
      A Java Future containing the result of the SendPipelineExecutionStepFailure 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendPipelineExecutionStepFailure

      default CompletableFuture<SendPipelineExecutionStepFailureResponse> sendPipelineExecutionStepFailure(Consumer<SendPipelineExecutionStepFailureRequest.Builder> sendPipelineExecutionStepFailureRequest)

      Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).


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

      Parameters:
      sendPipelineExecutionStepFailureRequest - A Consumer that will call methods on SendPipelineExecutionStepFailureRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendPipelineExecutionStepFailure 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendPipelineExecutionStepSuccess

      default CompletableFuture<SendPipelineExecutionStepSuccessResponse> sendPipelineExecutionStepSuccess(SendPipelineExecutionStepSuccessRequest sendPipelineExecutionStepSuccessRequest)

      Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

      Parameters:
      sendPipelineExecutionStepSuccessRequest -
      Returns:
      A Java Future containing the result of the SendPipelineExecutionStepSuccess 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendPipelineExecutionStepSuccess

      default CompletableFuture<SendPipelineExecutionStepSuccessResponse> sendPipelineExecutionStepSuccess(Consumer<SendPipelineExecutionStepSuccessRequest.Builder> sendPipelineExecutionStepSuccessRequest)

      Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).


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

      Parameters:
      sendPipelineExecutionStepSuccessRequest - A Consumer that will call methods on SendPipelineExecutionStepSuccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendPipelineExecutionStepSuccess 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEdgeDeploymentStage

      default CompletableFuture<StartEdgeDeploymentStageResponse> startEdgeDeploymentStage(StartEdgeDeploymentStageRequest startEdgeDeploymentStageRequest)

      Starts a stage in an edge deployment plan.

      Parameters:
      startEdgeDeploymentStageRequest -
      Returns:
      A Java Future containing the result of the StartEdgeDeploymentStage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEdgeDeploymentStage

      default CompletableFuture<StartEdgeDeploymentStageResponse> startEdgeDeploymentStage(Consumer<StartEdgeDeploymentStageRequest.Builder> startEdgeDeploymentStageRequest)

      Starts a stage in an edge deployment plan.


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

      Parameters:
      startEdgeDeploymentStageRequest - A Consumer that will call methods on StartEdgeDeploymentStageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartEdgeDeploymentStage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startInferenceExperiment

      default CompletableFuture<StartInferenceExperimentResponse> startInferenceExperiment(StartInferenceExperimentRequest startInferenceExperimentRequest)

      Starts an inference experiment.

      Parameters:
      startInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the StartInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startInferenceExperiment

      default CompletableFuture<StartInferenceExperimentResponse> startInferenceExperiment(Consumer<StartInferenceExperimentRequest.Builder> startInferenceExperimentRequest)

      Starts an inference experiment.


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

      Parameters:
      startInferenceExperimentRequest - A Consumer that will call methods on StartInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMonitoringSchedule

      default CompletableFuture<StartMonitoringScheduleResponse> startMonitoringSchedule(StartMonitoringScheduleRequest startMonitoringScheduleRequest)

      Starts a previously stopped monitoring schedule.

      By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

      Parameters:
      startMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the StartMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMonitoringSchedule

      default CompletableFuture<StartMonitoringScheduleResponse> startMonitoringSchedule(Consumer<StartMonitoringScheduleRequest.Builder> startMonitoringScheduleRequest)

      Starts a previously stopped monitoring schedule.

      By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.


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

      Parameters:
      startMonitoringScheduleRequest - A Consumer that will call methods on StartMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startNotebookInstance

      default CompletableFuture<StartNotebookInstanceResponse> startNotebookInstance(StartNotebookInstanceRequest startNotebookInstanceRequest)

      Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

      Parameters:
      startNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the StartNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startNotebookInstance

      default CompletableFuture<StartNotebookInstanceResponse> startNotebookInstance(Consumer<StartNotebookInstanceRequest.Builder> startNotebookInstanceRequest)

      Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.


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

      Parameters:
      startNotebookInstanceRequest - A Consumer that will call methods on StartNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipelineExecution

      default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest)

      Starts a pipeline execution.

      Parameters:
      startPipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the StartPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipelineExecution

      default CompletableFuture<StartPipelineExecutionResponse> startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest)

      Starts a pipeline execution.


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

      Parameters:
      startPipelineExecutionRequest - A Consumer that will call methods on StartPipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopAutoMLJob

      default CompletableFuture<StopAutoMlJobResponse> stopAutoMLJob(StopAutoMlJobRequest stopAutoMlJobRequest)

      A method for forcing a running job to shut down.

      Parameters:
      stopAutoMlJobRequest -
      Returns:
      A Java Future containing the result of the StopAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopAutoMLJob

      default CompletableFuture<StopAutoMlJobResponse> stopAutoMLJob(Consumer<StopAutoMlJobRequest.Builder> stopAutoMlJobRequest)

      A method for forcing a running job to shut down.


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

      Parameters:
      stopAutoMlJobRequest - A Consumer that will call methods on StopAutoMlJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopAutoMLJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopCompilationJob

      default CompletableFuture<StopCompilationJobResponse> stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest)

      Stops a model compilation job.

      To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

      When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.

      Parameters:
      stopCompilationJobRequest -
      Returns:
      A Java Future containing the result of the StopCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopCompilationJob

      default CompletableFuture<StopCompilationJobResponse> stopCompilationJob(Consumer<StopCompilationJobRequest.Builder> stopCompilationJobRequest)

      Stops a model compilation job.

      To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

      When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.


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

      Parameters:
      stopCompilationJobRequest - A Consumer that will call methods on StopCompilationJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopCompilationJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEdgeDeploymentStage

      default CompletableFuture<StopEdgeDeploymentStageResponse> stopEdgeDeploymentStage(StopEdgeDeploymentStageRequest stopEdgeDeploymentStageRequest)

      Stops a stage in an edge deployment plan.

      Parameters:
      stopEdgeDeploymentStageRequest -
      Returns:
      A Java Future containing the result of the StopEdgeDeploymentStage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEdgeDeploymentStage

      default CompletableFuture<StopEdgeDeploymentStageResponse> stopEdgeDeploymentStage(Consumer<StopEdgeDeploymentStageRequest.Builder> stopEdgeDeploymentStageRequest)

      Stops a stage in an edge deployment plan.


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

      Parameters:
      stopEdgeDeploymentStageRequest - A Consumer that will call methods on StopEdgeDeploymentStageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopEdgeDeploymentStage 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEdgePackagingJob

      default CompletableFuture<StopEdgePackagingJobResponse> stopEdgePackagingJob(StopEdgePackagingJobRequest stopEdgePackagingJobRequest)

      Request to stop an edge packaging job.

      Parameters:
      stopEdgePackagingJobRequest -
      Returns:
      A Java Future containing the result of the StopEdgePackagingJob 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEdgePackagingJob

      default CompletableFuture<StopEdgePackagingJobResponse> stopEdgePackagingJob(Consumer<StopEdgePackagingJobRequest.Builder> stopEdgePackagingJobRequest)

      Request to stop an edge packaging job.


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

      Parameters:
      stopEdgePackagingJobRequest - A Consumer that will call methods on StopEdgePackagingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopEdgePackagingJob 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopHyperParameterTuningJob

      default CompletableFuture<StopHyperParameterTuningJobResponse> stopHyperParameterTuningJob(StopHyperParameterTuningJobRequest stopHyperParameterTuningJobRequest)

      Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

      All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

      Parameters:
      stopHyperParameterTuningJobRequest -
      Returns:
      A Java Future containing the result of the StopHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopHyperParameterTuningJob

      default CompletableFuture<StopHyperParameterTuningJobResponse> stopHyperParameterTuningJob(Consumer<StopHyperParameterTuningJobRequest.Builder> stopHyperParameterTuningJobRequest)

      Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

      All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.


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

      Parameters:
      stopHyperParameterTuningJobRequest - A Consumer that will call methods on StopHyperParameterTuningJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopHyperParameterTuningJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInferenceExperiment

      default CompletableFuture<StopInferenceExperimentResponse> stopInferenceExperiment(StopInferenceExperimentRequest stopInferenceExperimentRequest)

      Stops an inference experiment.

      Parameters:
      stopInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the StopInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInferenceExperiment

      default CompletableFuture<StopInferenceExperimentResponse> stopInferenceExperiment(Consumer<StopInferenceExperimentRequest.Builder> stopInferenceExperimentRequest)

      Stops an inference experiment.


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

      Parameters:
      stopInferenceExperimentRequest - A Consumer that will call methods on StopInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInferenceRecommendationsJob

      default CompletableFuture<StopInferenceRecommendationsJobResponse> stopInferenceRecommendationsJob(StopInferenceRecommendationsJobRequest stopInferenceRecommendationsJobRequest)

      Stops an Inference Recommender job.

      Parameters:
      stopInferenceRecommendationsJobRequest -
      Returns:
      A Java Future containing the result of the StopInferenceRecommendationsJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInferenceRecommendationsJob

      default CompletableFuture<StopInferenceRecommendationsJobResponse> stopInferenceRecommendationsJob(Consumer<StopInferenceRecommendationsJobRequest.Builder> stopInferenceRecommendationsJobRequest)

      Stops an Inference Recommender job.


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

      Parameters:
      stopInferenceRecommendationsJobRequest - A Consumer that will call methods on StopInferenceRecommendationsJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopInferenceRecommendationsJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopLabelingJob

      default CompletableFuture<StopLabelingJobResponse> stopLabelingJob(StopLabelingJobRequest stopLabelingJobRequest)

      Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

      Parameters:
      stopLabelingJobRequest -
      Returns:
      A Java Future containing the result of the StopLabelingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopLabelingJob

      default CompletableFuture<StopLabelingJobResponse> stopLabelingJob(Consumer<StopLabelingJobRequest.Builder> stopLabelingJobRequest)

      Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.


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

      Parameters:
      stopLabelingJobRequest - A Consumer that will call methods on StopLabelingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopLabelingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopMonitoringSchedule

      default CompletableFuture<StopMonitoringScheduleResponse> stopMonitoringSchedule(StopMonitoringScheduleRequest stopMonitoringScheduleRequest)

      Stops a previously started monitoring schedule.

      Parameters:
      stopMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the StopMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopMonitoringSchedule

      default CompletableFuture<StopMonitoringScheduleResponse> stopMonitoringSchedule(Consumer<StopMonitoringScheduleRequest.Builder> stopMonitoringScheduleRequest)

      Stops a previously started monitoring schedule.


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

      Parameters:
      stopMonitoringScheduleRequest - A Consumer that will call methods on StopMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopMonitoringSchedule 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopNotebookInstance

      default CompletableFuture<StopNotebookInstanceResponse> stopNotebookInstance(StopNotebookInstanceRequest stopNotebookInstanceRequest)

      Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

      To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

      Parameters:
      stopNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the StopNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopNotebookInstance

      default CompletableFuture<StopNotebookInstanceResponse> stopNotebookInstance(Consumer<StopNotebookInstanceRequest.Builder> stopNotebookInstanceRequest)

      Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

      To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.


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

      Parameters:
      stopNotebookInstanceRequest - A Consumer that will call methods on StopNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopNotebookInstance 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipelineExecution

      default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest)

      Stops a pipeline execution.

      Callback Step

      A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

      You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

      Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

      Lambda Step

      A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

      Parameters:
      stopPipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the StopPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipelineExecution

      default CompletableFuture<StopPipelineExecutionResponse> stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest)

      Stops a pipeline execution.

      Callback Step

      A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping".

      You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

      Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

      Lambda Step

      A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.


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

      Parameters:
      stopPipelineExecutionRequest - A Consumer that will call methods on StopPipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopPipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopProcessingJob

      default CompletableFuture<StopProcessingJobResponse> stopProcessingJob(StopProcessingJobRequest stopProcessingJobRequest)

      Stops a processing job.

      Parameters:
      stopProcessingJobRequest -
      Returns:
      A Java Future containing the result of the StopProcessingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopProcessingJob

      default CompletableFuture<StopProcessingJobResponse> stopProcessingJob(Consumer<StopProcessingJobRequest.Builder> stopProcessingJobRequest)

      Stops a processing job.


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

      Parameters:
      stopProcessingJobRequest - A Consumer that will call methods on StopProcessingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopProcessingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingJob

      default CompletableFuture<StopTrainingJobResponse> stopTrainingJob(StopTrainingJobRequest stopTrainingJobRequest)

      Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

      When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

      Parameters:
      stopTrainingJobRequest -
      Returns:
      A Java Future containing the result of the StopTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTrainingJob

      default CompletableFuture<StopTrainingJobResponse> stopTrainingJob(Consumer<StopTrainingJobRequest.Builder> stopTrainingJobRequest)

      Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

      When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.


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

      Parameters:
      stopTrainingJobRequest - A Consumer that will call methods on StopTrainingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTransformJob

      default CompletableFuture<StopTransformJobResponse> stopTransformJob(StopTransformJobRequest stopTransformJobRequest)

      Stops a batch transform job.

      When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

      Parameters:
      stopTransformJobRequest -
      Returns:
      A Java Future containing the result of the StopTransformJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopTransformJob

      default CompletableFuture<StopTransformJobResponse> stopTransformJob(Consumer<StopTransformJobRequest.Builder> stopTransformJobRequest)

      Stops a batch transform job.

      When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.


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

      Parameters:
      stopTransformJobRequest - A Consumer that will call methods on StopTransformJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTransformJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAction

      default CompletableFuture<UpdateActionResponse> updateAction(UpdateActionRequest updateActionRequest)

      Updates an action.

      Parameters:
      updateActionRequest -
      Returns:
      A Java Future containing the result of the UpdateAction 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAction

      default CompletableFuture<UpdateActionResponse> updateAction(Consumer<UpdateActionRequest.Builder> updateActionRequest)

      Updates an action.


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

      Parameters:
      updateActionRequest - A Consumer that will call methods on UpdateActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAction 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAppImageConfig

      default CompletableFuture<UpdateAppImageConfigResponse> updateAppImageConfig(UpdateAppImageConfigRequest updateAppImageConfigRequest)

      Updates the properties of an AppImageConfig.

      Parameters:
      updateAppImageConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAppImageConfig

      default CompletableFuture<UpdateAppImageConfigResponse> updateAppImageConfig(Consumer<UpdateAppImageConfigRequest.Builder> updateAppImageConfigRequest)

      Updates the properties of an AppImageConfig.


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

      Parameters:
      updateAppImageConfigRequest - A Consumer that will call methods on UpdateAppImageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAppImageConfig 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateArtifact

      default CompletableFuture<UpdateArtifactResponse> updateArtifact(UpdateArtifactRequest updateArtifactRequest)

      Updates an artifact.

      Parameters:
      updateArtifactRequest -
      Returns:
      A Java Future containing the result of the UpdateArtifact 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateArtifact

      default CompletableFuture<UpdateArtifactResponse> updateArtifact(Consumer<UpdateArtifactRequest.Builder> updateArtifactRequest)

      Updates an artifact.


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

      Parameters:
      updateArtifactRequest - A Consumer that will call methods on UpdateArtifactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateArtifact 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

      Updates a SageMaker HyperPod cluster.

      Parameters:
      updateClusterRequest -
      Returns:
      A Java Future containing the result of the UpdateCluster 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)

      Updates a SageMaker HyperPod cluster.


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

      Parameters:
      updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCluster 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateClusterSoftware

      default CompletableFuture<UpdateClusterSoftwareResponse> updateClusterSoftware(UpdateClusterSoftwareRequest updateClusterSoftwareRequest)

      Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

      Parameters:
      updateClusterSoftwareRequest -
      Returns:
      A Java Future containing the result of the UpdateClusterSoftware 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateClusterSoftware

      default CompletableFuture<UpdateClusterSoftwareResponse> updateClusterSoftware(Consumer<UpdateClusterSoftwareRequest.Builder> updateClusterSoftwareRequest)

      Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.


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

      Parameters:
      updateClusterSoftwareRequest - A Consumer that will call methods on UpdateClusterSoftwareRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateClusterSoftware 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCodeRepository

      default CompletableFuture<UpdateCodeRepositoryResponse> updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest)

      Updates the specified Git repository with the specified values.

      Parameters:
      updateCodeRepositoryRequest -
      Returns:
      A Java Future containing the result of the UpdateCodeRepository 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCodeRepository

      default CompletableFuture<UpdateCodeRepositoryResponse> updateCodeRepository(Consumer<UpdateCodeRepositoryRequest.Builder> updateCodeRepositoryRequest)

      Updates the specified Git repository with the specified values.


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

      Parameters:
      updateCodeRepositoryRequest - A Consumer that will call methods on UpdateCodeRepositoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCodeRepository 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContext

      default CompletableFuture<UpdateContextResponse> updateContext(UpdateContextRequest updateContextRequest)

      Updates a context.

      Parameters:
      updateContextRequest -
      Returns:
      A Java Future containing the result of the UpdateContext 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContext

      default CompletableFuture<UpdateContextResponse> updateContext(Consumer<UpdateContextRequest.Builder> updateContextRequest)

      Updates a context.


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

      Parameters:
      updateContextRequest - A Consumer that will call methods on UpdateContextRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContext 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDeviceFleet

      default CompletableFuture<UpdateDeviceFleetResponse> updateDeviceFleet(UpdateDeviceFleetRequest updateDeviceFleetRequest)

      Updates a fleet of devices.

      Parameters:
      updateDeviceFleetRequest -
      Returns:
      A Java Future containing the result of the UpdateDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDeviceFleet

      default CompletableFuture<UpdateDeviceFleetResponse> updateDeviceFleet(Consumer<UpdateDeviceFleetRequest.Builder> updateDeviceFleetRequest)

      Updates a fleet of devices.


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

      Parameters:
      updateDeviceFleetRequest - A Consumer that will call methods on UpdateDeviceFleetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDeviceFleet 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.
      • ResourceInUseException Resource being accessed is in use.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDevices

      default CompletableFuture<UpdateDevicesResponse> updateDevices(UpdateDevicesRequest updateDevicesRequest)

      Updates one or more devices in a fleet.

      Parameters:
      updateDevicesRequest -
      Returns:
      A Java Future containing the result of the UpdateDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDevices

      default CompletableFuture<UpdateDevicesResponse> updateDevices(Consumer<UpdateDevicesRequest.Builder> updateDevicesRequest)

      Updates one or more devices in a fleet.


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

      Parameters:
      updateDevicesRequest - A Consumer that will call methods on UpdateDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDevices 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.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDomain

      default CompletableFuture<UpdateDomainResponse> updateDomain(UpdateDomainRequest updateDomainRequest)

      Updates the default settings for new user profiles in the domain.

      Parameters:
      updateDomainRequest -
      Returns:
      A Java Future containing the result of the UpdateDomain 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDomain

      default CompletableFuture<UpdateDomainResponse> updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest)

      Updates the default settings for new user profiles in the domain.


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

      Parameters:
      updateDomainRequest - A Consumer that will call methods on UpdateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDomain 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

      Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

      When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

      You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

      If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

      Parameters:
      updateEndpointRequest -
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest)

      Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

      When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

      You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

      If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.


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

      Parameters:
      updateEndpointRequest - A Consumer that will call methods on UpdateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpointWeightsAndCapacities

      default CompletableFuture<UpdateEndpointWeightsAndCapacitiesResponse> updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest updateEndpointWeightsAndCapacitiesRequest)

      Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

      Parameters:
      updateEndpointWeightsAndCapacitiesRequest -
      Returns:
      A Java Future containing the result of the UpdateEndpointWeightsAndCapacities 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpointWeightsAndCapacities

      default CompletableFuture<UpdateEndpointWeightsAndCapacitiesResponse> updateEndpointWeightsAndCapacities(Consumer<UpdateEndpointWeightsAndCapacitiesRequest.Builder> updateEndpointWeightsAndCapacitiesRequest)

      Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.


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

      Parameters:
      updateEndpointWeightsAndCapacitiesRequest - A Consumer that will call methods on UpdateEndpointWeightsAndCapacitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEndpointWeightsAndCapacities 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExperiment

      default CompletableFuture<UpdateExperimentResponse> updateExperiment(UpdateExperimentRequest updateExperimentRequest)

      Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

      Parameters:
      updateExperimentRequest -
      Returns:
      A Java Future containing the result of the UpdateExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExperiment

      default CompletableFuture<UpdateExperimentResponse> updateExperiment(Consumer<UpdateExperimentRequest.Builder> updateExperimentRequest)

      Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.


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

      Parameters:
      updateExperimentRequest - A Consumer that will call methods on UpdateExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeatureGroup

      default CompletableFuture<UpdateFeatureGroupResponse> updateFeatureGroup(UpdateFeatureGroupRequest updateFeatureGroupRequest)

      Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

      You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

      You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.

      Parameters:
      updateFeatureGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeatureGroup

      default CompletableFuture<UpdateFeatureGroupResponse> updateFeatureGroup(Consumer<UpdateFeatureGroupRequest.Builder> updateFeatureGroupRequest)

      Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API.

      You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group.

      You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration. To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null.


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

      Parameters:
      updateFeatureGroupRequest - A Consumer that will call methods on UpdateFeatureGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFeatureGroup 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeatureMetadata

      default CompletableFuture<UpdateFeatureMetadataResponse> updateFeatureMetadata(UpdateFeatureMetadataRequest updateFeatureMetadataRequest)

      Updates the description and parameters of the feature group.

      Parameters:
      updateFeatureMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateFeatureMetadata 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFeatureMetadata

      default CompletableFuture<UpdateFeatureMetadataResponse> updateFeatureMetadata(Consumer<UpdateFeatureMetadataRequest.Builder> updateFeatureMetadataRequest)

      Updates the description and parameters of the feature group.


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

      Parameters:
      updateFeatureMetadataRequest - A Consumer that will call methods on UpdateFeatureMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFeatureMetadata 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHub

      default CompletableFuture<UpdateHubResponse> updateHub(UpdateHubRequest updateHubRequest)

      Update a hub.

      Hub APIs are only callable through SageMaker Studio.

      Parameters:
      updateHubRequest -
      Returns:
      A Java Future containing the result of the UpdateHub 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHub

      default CompletableFuture<UpdateHubResponse> updateHub(Consumer<UpdateHubRequest.Builder> updateHubRequest)

      Update a hub.

      Hub APIs are only callable through SageMaker Studio.


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

      Parameters:
      updateHubRequest - A Consumer that will call methods on UpdateHubRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHub 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.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImage

      default CompletableFuture<UpdateImageResponse> updateImage(UpdateImageRequest updateImageRequest)

      Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

      Parameters:
      updateImageRequest -
      Returns:
      A Java Future containing the result of the UpdateImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImage

      default CompletableFuture<UpdateImageResponse> updateImage(Consumer<UpdateImageRequest.Builder> updateImageRequest)

      Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.


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

      Parameters:
      updateImageRequest - A Consumer that will call methods on UpdateImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateImage 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImageVersion

      default CompletableFuture<UpdateImageVersionResponse> updateImageVersion(UpdateImageVersionRequest updateImageVersionRequest)

      Updates the properties of a SageMaker image version.

      Parameters:
      updateImageVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateImageVersion

      default CompletableFuture<UpdateImageVersionResponse> updateImageVersion(Consumer<UpdateImageVersionRequest.Builder> updateImageVersionRequest)

      Updates the properties of a SageMaker image version.


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

      Parameters:
      updateImageVersionRequest - A Consumer that will call methods on UpdateImageVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateImageVersion 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.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceComponent

      default CompletableFuture<UpdateInferenceComponentResponse> updateInferenceComponent(UpdateInferenceComponentRequest updateInferenceComponentRequest)

      Updates an inference component.

      Parameters:
      updateInferenceComponentRequest -
      Returns:
      A Java Future containing the result of the UpdateInferenceComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceComponent

      default CompletableFuture<UpdateInferenceComponentResponse> updateInferenceComponent(Consumer<UpdateInferenceComponentRequest.Builder> updateInferenceComponentRequest)

      Updates an inference component.


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

      Parameters:
      updateInferenceComponentRequest - A Consumer that will call methods on UpdateInferenceComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInferenceComponent 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceComponentRuntimeConfig

      default CompletableFuture<UpdateInferenceComponentRuntimeConfigResponse> updateInferenceComponentRuntimeConfig(UpdateInferenceComponentRuntimeConfigRequest updateInferenceComponentRuntimeConfigRequest)

      Runtime settings for a model that is deployed with an inference component.

      Parameters:
      updateInferenceComponentRuntimeConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateInferenceComponentRuntimeConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceComponentRuntimeConfig

      default CompletableFuture<UpdateInferenceComponentRuntimeConfigResponse> updateInferenceComponentRuntimeConfig(Consumer<UpdateInferenceComponentRuntimeConfigRequest.Builder> updateInferenceComponentRuntimeConfigRequest)

      Runtime settings for a model that is deployed with an inference component.


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

      Parameters:
      updateInferenceComponentRuntimeConfigRequest - A Consumer that will call methods on UpdateInferenceComponentRuntimeConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInferenceComponentRuntimeConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceExperiment

      default CompletableFuture<UpdateInferenceExperimentResponse> updateInferenceExperiment(UpdateInferenceExperimentRequest updateInferenceExperimentRequest)

      Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.

      Parameters:
      updateInferenceExperimentRequest -
      Returns:
      A Java Future containing the result of the UpdateInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInferenceExperiment

      default CompletableFuture<UpdateInferenceExperimentResponse> updateInferenceExperiment(Consumer<UpdateInferenceExperimentRequest.Builder> updateInferenceExperimentRequest)

      Updates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.


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

      Parameters:
      updateInferenceExperimentRequest - A Consumer that will call methods on UpdateInferenceExperimentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInferenceExperiment 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateModelCard

      default CompletableFuture<UpdateModelCardResponse> updateModelCard(UpdateModelCardRequest updateModelCardRequest)

      Update an Amazon SageMaker Model Card.

      You cannot update both model card content and model card status in a single call.

      Parameters:
      updateModelCardRequest -
      Returns:
      A Java Future containing the result of the UpdateModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateModelCard

      default CompletableFuture<UpdateModelCardResponse> updateModelCard(Consumer<UpdateModelCardRequest.Builder> updateModelCardRequest)

      Update an Amazon SageMaker Model Card.

      You cannot update both model card content and model card status in a single call.


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

      Parameters:
      updateModelCardRequest - A Consumer that will call methods on UpdateModelCardRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateModelCard 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateModelPackage

      default CompletableFuture<UpdateModelPackageResponse> updateModelPackage(UpdateModelPackageRequest updateModelPackageRequest)

      Updates a versioned model.

      Parameters:
      updateModelPackageRequest -
      Returns:
      A Java Future containing the result of the UpdateModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateModelPackage

      default CompletableFuture<UpdateModelPackageResponse> updateModelPackage(Consumer<UpdateModelPackageRequest.Builder> updateModelPackageRequest)

      Updates a versioned model.


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

      Parameters:
      updateModelPackageRequest - A Consumer that will call methods on UpdateModelPackageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateModelPackage 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMonitoringAlert

      default CompletableFuture<UpdateMonitoringAlertResponse> updateMonitoringAlert(UpdateMonitoringAlertRequest updateMonitoringAlertRequest)

      Update the parameters of a model monitor alert.

      Parameters:
      updateMonitoringAlertRequest -
      Returns:
      A Java Future containing the result of the UpdateMonitoringAlert 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMonitoringAlert

      default CompletableFuture<UpdateMonitoringAlertResponse> updateMonitoringAlert(Consumer<UpdateMonitoringAlertRequest.Builder> updateMonitoringAlertRequest)

      Update the parameters of a model monitor alert.


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

      Parameters:
      updateMonitoringAlertRequest - A Consumer that will call methods on UpdateMonitoringAlertRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMonitoringAlert 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMonitoringSchedule

      default CompletableFuture<UpdateMonitoringScheduleResponse> updateMonitoringSchedule(UpdateMonitoringScheduleRequest updateMonitoringScheduleRequest)

      Updates a previously created schedule.

      Parameters:
      updateMonitoringScheduleRequest -
      Returns:
      A Java Future containing the result of the UpdateMonitoringSchedule 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMonitoringSchedule

      default CompletableFuture<UpdateMonitoringScheduleResponse> updateMonitoringSchedule(Consumer<UpdateMonitoringScheduleRequest.Builder> updateMonitoringScheduleRequest)

      Updates a previously created schedule.


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

      Parameters:
      updateMonitoringScheduleRequest - A Consumer that will call methods on UpdateMonitoringScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMonitoringSchedule 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookInstance

      default CompletableFuture<UpdateNotebookInstanceResponse> updateNotebookInstance(UpdateNotebookInstanceRequest updateNotebookInstanceRequest)

      Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

      Parameters:
      updateNotebookInstanceRequest -
      Returns:
      A Java Future containing the result of the UpdateNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookInstance

      default CompletableFuture<UpdateNotebookInstanceResponse> updateNotebookInstance(Consumer<UpdateNotebookInstanceRequest.Builder> updateNotebookInstanceRequest)

      Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.


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

      Parameters:
      updateNotebookInstanceRequest - A Consumer that will call methods on UpdateNotebookInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotebookInstance 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookInstanceLifecycleConfig

      default CompletableFuture<UpdateNotebookInstanceLifecycleConfigResponse> updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest)

      Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

      Parameters:
      updateNotebookInstanceLifecycleConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateNotebookInstanceLifecycleConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookInstanceLifecycleConfig

      default CompletableFuture<UpdateNotebookInstanceLifecycleConfigResponse> updateNotebookInstanceLifecycleConfig(Consumer<UpdateNotebookInstanceLifecycleConfigRequest.Builder> updateNotebookInstanceLifecycleConfigRequest)

      Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.


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

      Parameters:
      updateNotebookInstanceLifecycleConfigRequest - A Consumer that will call methods on UpdateNotebookInstanceLifecycleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotebookInstanceLifecycleConfig 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)

      Updates a pipeline.

      Parameters:
      updatePipelineRequest -
      Returns:
      A Java Future containing the result of the UpdatePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)

      Updates a pipeline.


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

      Parameters:
      updatePipelineRequest - A Consumer that will call methods on UpdatePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePipeline 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipelineExecution

      default CompletableFuture<UpdatePipelineExecutionResponse> updatePipelineExecution(UpdatePipelineExecutionRequest updatePipelineExecutionRequest)

      Updates a pipeline execution.

      Parameters:
      updatePipelineExecutionRequest -
      Returns:
      A Java Future containing the result of the UpdatePipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipelineExecution

      default CompletableFuture<UpdatePipelineExecutionResponse> updatePipelineExecution(Consumer<UpdatePipelineExecutionRequest.Builder> updatePipelineExecutionRequest)

      Updates a pipeline execution.


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

      Parameters:
      updatePipelineExecutionRequest - A Consumer that will call methods on UpdatePipelineExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePipelineExecution 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.
      • ResourceNotFoundException Resource being access is not found.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateProject

      default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)

      Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

      You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

      Parameters:
      updateProjectRequest -
      Returns:
      A Java Future containing the result of the UpdateProject 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateProject

      default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)

      Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.

      You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.


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

      Parameters:
      updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateProject 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSpace

      default CompletableFuture<UpdateSpaceResponse> updateSpace(UpdateSpaceRequest updateSpaceRequest)

      Updates the settings of a space.

      Parameters:
      updateSpaceRequest -
      Returns:
      A Java Future containing the result of the UpdateSpace 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSpace

      default CompletableFuture<UpdateSpaceResponse> updateSpace(Consumer<UpdateSpaceRequest.Builder> updateSpaceRequest)

      Updates the settings of a space.


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

      Parameters:
      updateSpaceRequest - A Consumer that will call methods on UpdateSpaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSpace 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrainingJob

      default CompletableFuture<UpdateTrainingJobResponse> updateTrainingJob(UpdateTrainingJobRequest updateTrainingJobRequest)

      Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

      Parameters:
      updateTrainingJobRequest -
      Returns:
      A Java Future containing the result of the UpdateTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrainingJob

      default CompletableFuture<UpdateTrainingJobResponse> updateTrainingJob(Consumer<UpdateTrainingJobRequest.Builder> updateTrainingJobRequest)

      Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.


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

      Parameters:
      updateTrainingJobRequest - A Consumer that will call methods on UpdateTrainingJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrainingJob 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.
      • ResourceNotFoundException Resource being access is not found.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrial

      default CompletableFuture<UpdateTrialResponse> updateTrial(UpdateTrialRequest updateTrialRequest)

      Updates the display name of a trial.

      Parameters:
      updateTrialRequest -
      Returns:
      A Java Future containing the result of the UpdateTrial 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrial

      default CompletableFuture<UpdateTrialResponse> updateTrial(Consumer<UpdateTrialRequest.Builder> updateTrialRequest)

      Updates the display name of a trial.


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

      Parameters:
      updateTrialRequest - A Consumer that will call methods on UpdateTrialRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrial 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrialComponent

      default CompletableFuture<UpdateTrialComponentResponse> updateTrialComponent(UpdateTrialComponentRequest updateTrialComponentRequest)

      Updates one or more properties of a trial component.

      Parameters:
      updateTrialComponentRequest -
      Returns:
      A Java Future containing the result of the UpdateTrialComponent 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrialComponent

      default CompletableFuture<UpdateTrialComponentResponse> updateTrialComponent(Consumer<UpdateTrialComponentRequest.Builder> updateTrialComponentRequest)

      Updates one or more properties of a trial component.


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

      Parameters:
      updateTrialComponentRequest - A Consumer that will call methods on UpdateTrialComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrialComponent 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserProfile

      default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest)

      Updates a user profile.

      Parameters:
      updateUserProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateUserProfile 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserProfile

      default CompletableFuture<UpdateUserProfileResponse> updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest)

      Updates a user profile.


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

      Parameters:
      updateUserProfileRequest - A Consumer that will call methods on UpdateUserProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserProfile 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • ResourceInUseException Resource being accessed is in use.
      • ResourceNotFoundException Resource being access is not found.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkforce

      default CompletableFuture<UpdateWorkforceResponse> updateWorkforce(UpdateWorkforceRequest updateWorkforceRequest)

      Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

      The worker portal is now supported in VPC and public internet.

      Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

      To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

      Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

      Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

      You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

      After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

      This operation only applies to private workforces.

      Parameters:
      updateWorkforceRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkforce 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkforce

      default CompletableFuture<UpdateWorkforceResponse> updateWorkforce(Consumer<UpdateWorkforceRequest.Builder> updateWorkforceRequest)

      Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

      The worker portal is now supported in VPC and public internet.

      Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

      To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16".

      Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

      Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

      You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

      After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

      This operation only applies to private workforces.


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

      Parameters:
      updateWorkforceRequest - A Consumer that will call methods on UpdateWorkforceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkforce 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.
      • ConflictException There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkteam

      default CompletableFuture<UpdateWorkteamResponse> updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest)

      Updates an existing work team with new member definitions or description.

      Parameters:
      updateWorkteamRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkteam 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkteam

      default CompletableFuture<UpdateWorkteamResponse> updateWorkteam(Consumer<UpdateWorkteamRequest.Builder> updateWorkteamRequest)

      Updates an existing work team with new member definitions or description.


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

      Parameters:
      updateWorkteamRequest - A Consumer that will call methods on UpdateWorkteamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkteam 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.
      • ResourceLimitExceededException You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
      • 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.
      • SageMakerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default SageMakerAsyncWaiter waiter()
      Create an instance of SageMakerAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of SageMakerAsyncWaiter

    • serviceClientConfiguration

      default SageMakerServiceClientConfiguration 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 SageMakerAsyncClient create()
      Create a SageMakerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SageMakerAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SageMakerAsyncClient.