Interface SageMakerClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SageMakerClient extends AwsClient
Service client for accessing SageMaker. This can be created using the staticbuilder()
method.Provides APIs for creating and managing SageMaker resources.
Other Resources:
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
addAssociation
default AddAssociationResponse addAssociation(AddAssociationRequest addAssociationRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the AddAssociation operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
addAssociation
default AddAssociationResponse addAssociation(Consumer<AddAssociationRequest.Builder> addAssociationRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaAddAssociationRequest.builder()
- Parameters:
addAssociationRequest
- AConsumer
that will call methods onAddAssociationRequest.Builder
to create a request.- Returns:
- Result of the AddAssociation operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
addTags
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 CreateHyperParameterTuningJobTags 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:
- Result of the AddTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
addTags
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 CreateHyperParameterTuningJobTags 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 viaAddTagsRequest.builder()
- Parameters:
addTagsRequest
- AConsumer
that will call methods onAddTagsRequest.Builder
to create a request.- Returns:
- Result of the AddTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateTrialComponent
default AssociateTrialComponentResponse associateTrialComponent(AssociateTrialComponentRequest associateTrialComponentRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the AssociateTrialComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
associateTrialComponent
default AssociateTrialComponentResponse associateTrialComponent(Consumer<AssociateTrialComponentRequest.Builder> associateTrialComponentRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaAssociateTrialComponentRequest.builder()
- Parameters:
associateTrialComponentRequest
- AConsumer
that will call methods onAssociateTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the AssociateTrialComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
batchDeleteClusterNodes
default BatchDeleteClusterNodesResponse batchDeleteClusterNodes(BatchDeleteClusterNodesRequest batchDeleteClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes specific nodes within a SageMaker HyperPod cluster.
BatchDeleteClusterNodes
accepts a cluster name and a list of node IDs.-
To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
-
If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.
- Parameters:
batchDeleteClusterNodesRequest
-- Returns:
- Result of the BatchDeleteClusterNodes operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
batchDeleteClusterNodes
default BatchDeleteClusterNodesResponse batchDeleteClusterNodes(Consumer<BatchDeleteClusterNodesRequest.Builder> batchDeleteClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes specific nodes within a SageMaker HyperPod cluster.
BatchDeleteClusterNodes
accepts a cluster name and a list of node IDs.-
To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.
-
If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.
This is a convenience which creates an instance of the
BatchDeleteClusterNodesRequest.Builder
avoiding the need to create one manually viaBatchDeleteClusterNodesRequest.builder()
- Parameters:
batchDeleteClusterNodesRequest
- AConsumer
that will call methods onBatchDeleteClusterNodesRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteClusterNodes operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
batchDescribeModelPackage
default BatchDescribeModelPackageResponse batchDescribeModelPackage(BatchDescribeModelPackageRequest batchDescribeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
This action batch describes a list of versioned model packages
- Parameters:
batchDescribeModelPackageRequest
-- Returns:
- Result of the BatchDescribeModelPackage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
batchDescribeModelPackage
default BatchDescribeModelPackageResponse batchDescribeModelPackage(Consumer<BatchDescribeModelPackageRequest.Builder> batchDescribeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaBatchDescribeModelPackageRequest.builder()
- Parameters:
batchDescribeModelPackageRequest
- AConsumer
that will call methods onBatchDescribeModelPackageRequest.Builder
to create a request.- Returns:
- Result of the BatchDescribeModelPackage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createAction
default CreateActionResponse createAction(CreateActionRequest createActionRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateAction operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAction
default CreateActionResponse createAction(Consumer<CreateActionRequest.Builder> createActionRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateActionRequest.builder()
- Parameters:
createActionRequest
- AConsumer
that will call methods onCreateActionRequest.Builder
to create a request.- Returns:
- Result of the CreateAction operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAlgorithm
default CreateAlgorithmResponse createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
- Parameters:
createAlgorithmRequest
-- Returns:
- Result of the CreateAlgorithm operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createAlgorithm
default CreateAlgorithmResponse createAlgorithm(Consumer<CreateAlgorithmRequest.Builder> createAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaCreateAlgorithmRequest.builder()
- Parameters:
createAlgorithmRequest
- AConsumer
that will call methods onCreateAlgorithmRequest.Builder
to create a request.- Returns:
- Result of the CreateAlgorithm operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createApp
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI 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:
- Result of the CreateApp operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createApp
default CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI 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 viaCreateAppRequest.builder()
- Parameters:
createAppRequest
- AConsumer
that will call methods onCreateAppRequest.Builder
to create a request.- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAppImageConfig
default CreateAppImageConfigResponse createAppImageConfig(CreateAppImageConfigRequest createAppImageConfigRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a configuration for running a SageMaker AI 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:
- Result of the CreateAppImageConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAppImageConfig
default CreateAppImageConfigResponse createAppImageConfig(Consumer<CreateAppImageConfigRequest.Builder> createAppImageConfigRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a configuration for running a SageMaker AI 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 viaCreateAppImageConfigRequest.builder()
- Parameters:
createAppImageConfigRequest
- AConsumer
that will call methods onCreateAppImageConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateAppImageConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createArtifact
default CreateArtifactResponse createArtifact(CreateArtifactRequest createArtifactRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateArtifact operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createArtifact
default CreateArtifactResponse createArtifact(Consumer<CreateArtifactRequest.Builder> createArtifactRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateArtifactRequest.builder()
- Parameters:
createArtifactRequest
- AConsumer
that will call methods onCreateArtifactRequest.Builder
to create a request.- Returns:
- Result of the CreateArtifact operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAutoMLJob
default CreateAutoMlJobResponse createAutoMLJob(CreateAutoMlJobRequest createAutoMlJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
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 versionCreateAutoMLJob
, 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
toCreateAutoMLJobV2
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:
- Result of the CreateAutoMLJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAutoMLJob
default CreateAutoMlJobResponse createAutoMLJob(Consumer<CreateAutoMlJobRequest.Builder> createAutoMlJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
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 versionCreateAutoMLJob
, 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
toCreateAutoMLJobV2
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 viaCreateAutoMlJobRequest.builder()
- Parameters:
createAutoMlJobRequest
- AConsumer
that will call methods onCreateAutoMlJobRequest.Builder
to create a request.- Returns:
- Result of the CreateAutoMLJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAutoMLJobV2
default CreateAutoMlJobV2Response createAutoMLJobV2(CreateAutoMlJobV2Request createAutoMlJobV2Request) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.
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 versionCreateAutoMLJob
, 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
toCreateAutoMLJobV2
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:
- Result of the CreateAutoMLJobV2 operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createAutoMLJobV2
default CreateAutoMlJobV2Response createAutoMLJobV2(Consumer<CreateAutoMlJobV2Request.Builder> createAutoMlJobV2Request) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoML jobs are designed to simplify and accelerate the model building process by automating various tasks and exploring different combinations of machine learning algorithms, data preprocessing techniques, and hyperparameter values. The output of an AutoML job comprises one or more trained models ready for deployment and inference. Additionally, SageMaker AI AutoML jobs generate a candidate model leaderboard, allowing you to select the best-performing model for deployment.
For more information about AutoML jobs, see https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html in the SageMaker AI developer guide.
AutoML jobs V2 support various problem types such as regression, binary, and multiclass classification with tabular data, text and image classification, time-series forecasting, and fine-tuning of large language models (LLMs) for text generation.
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 versionCreateAutoMLJob
, 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
toCreateAutoMLJobV2
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 viaCreateAutoMlJobV2Request.builder()
- Parameters:
createAutoMlJobV2Request
- AConsumer
that will call methods onCreateAutoMlJobV2Request.Builder
to create a request.- Returns:
- Result of the CreateAutoMLJobV2 operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateCluster operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createClusterSchedulerConfig
default CreateClusterSchedulerConfigResponse createClusterSchedulerConfig(CreateClusterSchedulerConfigRequest createClusterSchedulerConfigRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
- Parameters:
createClusterSchedulerConfigRequest
-- Returns:
- Result of the CreateClusterSchedulerConfig operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createClusterSchedulerConfig
default CreateClusterSchedulerConfigResponse createClusterSchedulerConfig(Consumer<CreateClusterSchedulerConfigRequest.Builder> createClusterSchedulerConfigRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
This is a convenience which creates an instance of the
CreateClusterSchedulerConfigRequest.Builder
avoiding the need to create one manually viaCreateClusterSchedulerConfigRequest.builder()
- Parameters:
createClusterSchedulerConfigRequest
- AConsumer
that will call methods onCreateClusterSchedulerConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateClusterSchedulerConfig operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createCodeRepository
default CreateCodeRepositoryResponse createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Creates a Git repository as a resource in your SageMaker AI 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 AI 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:
- Result of the CreateCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createCodeRepository
default CreateCodeRepositoryResponse createCodeRepository(Consumer<CreateCodeRepositoryRequest.Builder> createCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Creates a Git repository as a resource in your SageMaker AI 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 AI 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 viaCreateCodeRepositoryRequest.builder()
- Parameters:
createCodeRepositoryRequest
- AConsumer
that will call methods onCreateCodeRepositoryRequest.Builder
to create a request.- Returns:
- Result of the CreateCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createCompilationJob
default CreateCompilationJobResponse createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI 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 AI 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 AI 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 theCompilationJobArn
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:
- Result of the CreateCompilationJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createCompilationJob
default CreateCompilationJobResponse createCompilationJob(Consumer<CreateCompilationJobRequest.Builder> createCompilationJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a model compilation job. After the model has been compiled, Amazon SageMaker AI 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 AI 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 AI 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 theCompilationJobArn
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 viaCreateCompilationJobRequest.builder()
- Parameters:
createCompilationJobRequest
- AConsumer
that will call methods onCreateCompilationJobRequest.Builder
to create a request.- Returns:
- Result of the CreateCompilationJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createComputeQuota
default CreateComputeQuotaResponse createComputeQuota(CreateComputeQuotaRequest createComputeQuotaRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.
- Parameters:
createComputeQuotaRequest
-- Returns:
- Result of the CreateComputeQuota operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createComputeQuota
default CreateComputeQuotaResponse createComputeQuota(Consumer<CreateComputeQuotaRequest.Builder> createComputeQuotaRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.
This is a convenience which creates an instance of the
CreateComputeQuotaRequest.Builder
avoiding the need to create one manually viaCreateComputeQuotaRequest.builder()
- Parameters:
createComputeQuotaRequest
- AConsumer
that will call methods onCreateComputeQuotaRequest.Builder
to create a request.- Returns:
- Result of the CreateComputeQuota operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createContext
default CreateContextResponse createContext(CreateContextRequest createContextRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateContext operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createContext
default CreateContextResponse createContext(Consumer<CreateContextRequest.Builder> createContextRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateContextRequest.builder()
- Parameters:
createContextRequest
- AConsumer
that will call methods onCreateContextRequest.Builder
to create a request.- Returns:
- Result of the CreateContext operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createDataQualityJobDefinition
default CreateDataQualityJobDefinitionResponse createDataQualityJobDefinition(CreateDataQualityJobDefinitionRequest createDataQualityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
- Parameters:
createDataQualityJobDefinitionRequest
-- Returns:
- Result of the CreateDataQualityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createDataQualityJobDefinition
default CreateDataQualityJobDefinitionResponse createDataQualityJobDefinition(Consumer<CreateDataQualityJobDefinitionRequest.Builder> createDataQualityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
This is a convenience which creates an instance of the
CreateDataQualityJobDefinitionRequest.Builder
avoiding the need to create one manually viaCreateDataQualityJobDefinitionRequest.builder()
- Parameters:
createDataQualityJobDefinitionRequest
- AConsumer
that will call methods onCreateDataQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateDataQualityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createDeviceFleet
default CreateDeviceFleetResponse createDeviceFleet(CreateDeviceFleetRequest createDeviceFleetRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a device fleet.
- Parameters:
createDeviceFleetRequest
-- Returns:
- Result of the CreateDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createDeviceFleet
default CreateDeviceFleetResponse createDeviceFleet(Consumer<CreateDeviceFleetRequest.Builder> createDeviceFleetRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a device fleet.
This is a convenience which creates an instance of the
CreateDeviceFleetRequest.Builder
avoiding the need to create one manually viaCreateDeviceFleetRequest.builder()
- Parameters:
createDeviceFleetRequest
- AConsumer
that will call methods onCreateDeviceFleetRequest.Builder
to create a request.- Returns:
- Result of the CreateDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 AI 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 AI, 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 AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI 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 AI Studio app successfully.
For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
- Parameters:
createDomainRequest
-- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 AI 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 AI, 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 AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI 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 AI Studio app successfully.
For more information, see Connect Amazon SageMaker AI 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 viaCreateDomainRequest.builder()
- Parameters:
createDomainRequest
- AConsumer
that will call methods onCreateDomainRequest.Builder
to create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createEdgeDeploymentPlan
default CreateEdgeDeploymentPlanResponse createEdgeDeploymentPlan(CreateEdgeDeploymentPlanRequest createEdgeDeploymentPlanRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
- Parameters:
createEdgeDeploymentPlanRequest
-- Returns:
- Result of the CreateEdgeDeploymentPlan operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEdgeDeploymentPlan
default CreateEdgeDeploymentPlanResponse createEdgeDeploymentPlan(Consumer<CreateEdgeDeploymentPlanRequest.Builder> createEdgeDeploymentPlanRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateEdgeDeploymentPlanRequest.builder()
- Parameters:
createEdgeDeploymentPlanRequest
- AConsumer
that will call methods onCreateEdgeDeploymentPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateEdgeDeploymentPlan operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEdgeDeploymentStage
default CreateEdgeDeploymentStageResponse createEdgeDeploymentStage(CreateEdgeDeploymentStageRequest createEdgeDeploymentStageRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a new stage in an existing edge deployment plan.
- Parameters:
createEdgeDeploymentStageRequest
-- Returns:
- Result of the CreateEdgeDeploymentStage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEdgeDeploymentStage
default CreateEdgeDeploymentStageResponse createEdgeDeploymentStage(Consumer<CreateEdgeDeploymentStageRequest.Builder> createEdgeDeploymentStageRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateEdgeDeploymentStageRequest.builder()
- Parameters:
createEdgeDeploymentStageRequest
- AConsumer
that will call methods onCreateEdgeDeploymentStageRequest.Builder
to create a request.- Returns:
- Result of the CreateEdgeDeploymentStage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEdgePackagingJob
default CreateEdgePackagingJobResponse createEdgePackagingJob(CreateEdgePackagingJobRequest createEdgePackagingJobRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateEdgePackagingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEdgePackagingJob
default CreateEdgePackagingJobResponse createEdgePackagingJob(Consumer<CreateEdgePackagingJobRequest.Builder> createEdgePackagingJobRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateEdgePackagingJobRequest.builder()
- Parameters:
createEdgePackagingJobRequest
- AConsumer
that will call methods onCreateEdgePackagingJobRequest.Builder
to create a request.- Returns:
- Result of the CreateEdgePackagingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEndpoint
default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a newEndpointConfig
.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 toInService
. 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:
- Result of the CreateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createEndpoint
default CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a newEndpointConfig
.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 toInService
. 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 viaCreateEndpointRequest.builder()
- Parameters:
createEndpointRequest
- AConsumer
that will call methods onCreateEndpointRequest.Builder
to create a request.- Returns:
- Result of the CreateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createEndpointConfig
default CreateEndpointConfigResponse createEndpointConfig(CreateEndpointConfigRequest createEndpointConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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. EachProductionVariant
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:
- Result of the CreateEndpointConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createEndpointConfig
default CreateEndpointConfigResponse createEndpointConfig(Consumer<CreateEndpointConfigRequest.Builder> createEndpointConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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. EachProductionVariant
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 viaCreateEndpointConfigRequest.builder()
- Parameters:
createEndpointConfigRequest
- AConsumer
that will call methods onCreateEndpointConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateEndpointConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createExperiment
default CreateExperimentResponse createExperiment(CreateExperimentRequest createExperimentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateExperiment operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createExperiment
default CreateExperimentResponse createExperiment(Consumer<CreateExperimentRequest.Builder> createExperimentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateExperimentRequest.builder()
- Parameters:
createExperimentRequest
- AConsumer
that will call methods onCreateExperimentRequest.Builder
to create a request.- Returns:
- Result of the CreateExperiment operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createFeatureGroup
default CreateFeatureGroupResponse createFeatureGroup(CreateFeatureGroupRequest createFeatureGroupRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a new
FeatureGroup
. AFeatureGroup
is a group ofFeatures
defined in theFeatureStore
to describe aRecord
.The
FeatureGroup
defines the schema and features contained in theFeatureGroup
. AFeatureGroup
definition is composed of a list ofFeatures
, aRecordIdentifierFeatureName
, anEventTimeFeatureName
and configurations for itsOnlineStore
andOfflineStore
. Check Amazon Web Services service quotas to see theFeatureGroup
s quota for your Amazon Web Services account.Note that it can take approximately 10-15 minutes to provision an
OnlineStore
FeatureGroup
with theInMemory
StorageType
.You must include at least one of
OnlineStoreConfig
andOfflineStoreConfig
to create aFeatureGroup
.- Parameters:
createFeatureGroupRequest
-- Returns:
- Result of the CreateFeatureGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createFeatureGroup
default CreateFeatureGroupResponse createFeatureGroup(Consumer<CreateFeatureGroupRequest.Builder> createFeatureGroupRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a new
FeatureGroup
. AFeatureGroup
is a group ofFeatures
defined in theFeatureStore
to describe aRecord
.The
FeatureGroup
defines the schema and features contained in theFeatureGroup
. AFeatureGroup
definition is composed of a list ofFeatures
, aRecordIdentifierFeatureName
, anEventTimeFeatureName
and configurations for itsOnlineStore
andOfflineStore
. Check Amazon Web Services service quotas to see theFeatureGroup
s quota for your Amazon Web Services account.Note that it can take approximately 10-15 minutes to provision an
OnlineStore
FeatureGroup
with theInMemory
StorageType
.You must include at least one of
OnlineStoreConfig
andOfflineStoreConfig
to create aFeatureGroup
.
This is a convenience which creates an instance of the
CreateFeatureGroupRequest.Builder
avoiding the need to create one manually viaCreateFeatureGroupRequest.builder()
- Parameters:
createFeatureGroupRequest
- AConsumer
that will call methods onCreateFeatureGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateFeatureGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createFlowDefinition
default CreateFlowDefinitionResponse createFlowDefinition(CreateFlowDefinitionRequest createFlowDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a flow definition.
- Parameters:
createFlowDefinitionRequest
-- Returns:
- Result of the CreateFlowDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createFlowDefinition
default CreateFlowDefinitionResponse createFlowDefinition(Consumer<CreateFlowDefinitionRequest.Builder> createFlowDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a flow definition.
This is a convenience which creates an instance of the
CreateFlowDefinitionRequest.Builder
avoiding the need to create one manually viaCreateFlowDefinitionRequest.builder()
- Parameters:
createFlowDefinitionRequest
- AConsumer
that will call methods onCreateFlowDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateFlowDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHub
default CreateHubResponse createHub(CreateHubRequest createHubRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a hub.
- Parameters:
createHubRequest
-- Returns:
- Result of the CreateHub operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHub
default CreateHubResponse createHub(Consumer<CreateHubRequest.Builder> createHubRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a hub.
This is a convenience which creates an instance of the
CreateHubRequest.Builder
avoiding the need to create one manually viaCreateHubRequest.builder()
- Parameters:
createHubRequest
- AConsumer
that will call methods onCreateHubRequest.Builder
to create a request.- Returns:
- Result of the CreateHub operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHubContentReference
default CreateHubContentReferenceResponse createHubContentReference(CreateHubContentReferenceRequest createHubContentReferenceRequest) throws ResourceNotFoundException, ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
- Parameters:
createHubContentReferenceRequest
-- Returns:
- Result of the CreateHubContentReference operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHubContentReference
default CreateHubContentReferenceResponse createHubContentReference(Consumer<CreateHubContentReferenceRequest.Builder> createHubContentReferenceRequest) throws ResourceNotFoundException, ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
This is a convenience which creates an instance of the
CreateHubContentReferenceRequest.Builder
avoiding the need to create one manually viaCreateHubContentReferenceRequest.builder()
- Parameters:
createHubContentReferenceRequest
- AConsumer
that will call methods onCreateHubContentReferenceRequest.Builder
to create a request.- Returns:
- Result of the CreateHubContentReference operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHumanTaskUi
default CreateHumanTaskUiResponse createHumanTaskUi(CreateHumanTaskUiRequest createHumanTaskUiRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateHumanTaskUi operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHumanTaskUi
default CreateHumanTaskUiResponse createHumanTaskUi(Consumer<CreateHumanTaskUiRequest.Builder> createHumanTaskUiRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateHumanTaskUiRequest.builder()
- Parameters:
createHumanTaskUiRequest
- AConsumer
that will call methods onCreateHumanTaskUiRequest.Builder
to create a request.- Returns:
- Result of the CreateHumanTaskUi operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHyperParameterTuningJob
default CreateHyperParameterTuningJobResponse createHyperParameterTuningJob(CreateHyperParameterTuningJobRequest createHyperParameterTuningJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateHyperParameterTuningJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createHyperParameterTuningJob
default CreateHyperParameterTuningJobResponse createHyperParameterTuningJob(Consumer<CreateHyperParameterTuningJobRequest.Builder> createHyperParameterTuningJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateHyperParameterTuningJobRequest.builder()
- Parameters:
createHyperParameterTuningJobRequest
- AConsumer
that will call methods onCreateHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- Result of the CreateHyperParameterTuningJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createImage
default CreateImageResponse createImage(CreateImageRequest createImageRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a custom SageMaker AI image. A SageMaker AI 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 AI image.
- Parameters:
createImageRequest
-- Returns:
- Result of the CreateImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createImage
default CreateImageResponse createImage(Consumer<CreateImageRequest.Builder> createImageRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a custom SageMaker AI image. A SageMaker AI 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 AI image.
This is a convenience which creates an instance of the
CreateImageRequest.Builder
avoiding the need to create one manually viaCreateImageRequest.builder()
- Parameters:
createImageRequest
- AConsumer
that will call methods onCreateImageRequest.Builder
to create a request.- Returns:
- Result of the CreateImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createImageVersion
default CreateImageVersionResponse createImageVersion(CreateImageVersionRequest createImageVersionRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a version of the SageMaker AI image specified by
ImageName
. The version represents the Amazon ECR container image specified byBaseImage
.- Parameters:
createImageVersionRequest
-- Returns:
- Result of the CreateImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createImageVersion
default CreateImageVersionResponse createImageVersion(Consumer<CreateImageVersionRequest.Builder> createImageVersionRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a version of the SageMaker AI image specified by
ImageName
. The version represents the Amazon ECR container image specified byBaseImage
.
This is a convenience which creates an instance of the
CreateImageVersionRequest.Builder
avoiding the need to create one manually viaCreateImageVersionRequest.builder()
- Parameters:
createImageVersionRequest
- AConsumer
that will call methods onCreateImageVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceComponent
default CreateInferenceComponentResponse createInferenceComponent(CreateInferenceComponentRequest createInferenceComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an inference component, which is a SageMaker AI 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:
- Result of the CreateInferenceComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceComponent
default CreateInferenceComponentResponse createInferenceComponent(Consumer<CreateInferenceComponentRequest.Builder> createInferenceComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an inference component, which is a SageMaker AI 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 viaCreateInferenceComponentRequest.builder()
- Parameters:
createInferenceComponentRequest
- AConsumer
that will call methods onCreateInferenceComponentRequest.Builder
to create a request.- Returns:
- Result of the CreateInferenceComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceExperiment
default CreateInferenceExperimentResponse createInferenceExperiment(CreateInferenceExperimentRequest createInferenceExperimentRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateInferenceExperiment operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceExperiment
default CreateInferenceExperimentResponse createInferenceExperiment(Consumer<CreateInferenceExperimentRequest.Builder> createInferenceExperimentRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateInferenceExperimentRequest.builder()
- Parameters:
createInferenceExperimentRequest
- AConsumer
that will call methods onCreateInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the CreateInferenceExperiment operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceRecommendationsJob
default CreateInferenceRecommendationsJobResponse createInferenceRecommendationsJob(CreateInferenceRecommendationsJobRequest createInferenceRecommendationsJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a recommendation job. You can create either an instance recommendation or load test job.
- Parameters:
createInferenceRecommendationsJobRequest
-- Returns:
- Result of the CreateInferenceRecommendationsJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createInferenceRecommendationsJob
default CreateInferenceRecommendationsJobResponse createInferenceRecommendationsJob(Consumer<CreateInferenceRecommendationsJobRequest.Builder> createInferenceRecommendationsJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateInferenceRecommendationsJobRequest.builder()
- Parameters:
createInferenceRecommendationsJobRequest
- AConsumer
that will call methods onCreateInferenceRecommendationsJobRequest.Builder
to create a request.- Returns:
- Result of the CreateInferenceRecommendationsJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createLabelingJob
default CreateLabelingJobResponse createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateLabelingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createLabelingJob
default CreateLabelingJobResponse createLabelingJob(Consumer<CreateLabelingJobRequest.Builder> createLabelingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateLabelingJobRequest.builder()
- Parameters:
createLabelingJobRequest
- AConsumer
that will call methods onCreateLabelingJobRequest.Builder
to create a request.- Returns:
- Result of the CreateLabelingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createMlflowTrackingServer
default CreateMlflowTrackingServerResponse createMlflowTrackingServer(CreateMlflowTrackingServerRequest createMlflowTrackingServerRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.
- Parameters:
createMlflowTrackingServerRequest
-- Returns:
- Result of the CreateMlflowTrackingServer operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createMlflowTrackingServer
default CreateMlflowTrackingServerResponse createMlflowTrackingServer(Consumer<CreateMlflowTrackingServerRequest.Builder> createMlflowTrackingServerRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.
This is a convenience which creates an instance of the
CreateMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaCreateMlflowTrackingServerRequest.builder()
- Parameters:
createMlflowTrackingServerRequest
- AConsumer
that will call methods onCreateMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the CreateMlflowTrackingServer operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModel
default CreateModelResponse createModel(CreateModelRequest createModelRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 theCreateEndpoint
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:
- Result of the CreateModel operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModel
default CreateModelResponse createModel(Consumer<CreateModelRequest.Builder> createModelRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 theCreateEndpoint
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 viaCreateModelRequest.builder()
- Parameters:
createModelRequest
- AConsumer
that will call methods onCreateModelRequest.Builder
to create a request.- Returns:
- Result of the CreateModel operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelBiasJobDefinition
default CreateModelBiasJobDefinitionResponse createModelBiasJobDefinition(CreateModelBiasJobDefinitionRequest createModelBiasJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates the definition for a model bias job.
- Parameters:
createModelBiasJobDefinitionRequest
-- Returns:
- Result of the CreateModelBiasJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelBiasJobDefinition
default CreateModelBiasJobDefinitionResponse createModelBiasJobDefinition(Consumer<CreateModelBiasJobDefinitionRequest.Builder> createModelBiasJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateModelBiasJobDefinitionRequest.builder()
- Parameters:
createModelBiasJobDefinitionRequest
- AConsumer
that will call methods onCreateModelBiasJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateModelBiasJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelCard
default CreateModelCardResponse createModelCard(CreateModelCardRequest createModelCardRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
- Parameters:
createModelCardRequest
-- Returns:
- Result of the CreateModelCard operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelCard
default CreateModelCardResponse createModelCard(Consumer<CreateModelCardRequest.Builder> createModelCardRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateModelCardRequest.builder()
- Parameters:
createModelCardRequest
- AConsumer
that will call methods onCreateModelCardRequest.Builder
to create a request.- Returns:
- Result of the CreateModelCard operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelCardExportJob
default CreateModelCardExportJobResponse createModelCardExportJob(CreateModelCardExportJobRequest createModelCardExportJobRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker Model Card export job.
- Parameters:
createModelCardExportJobRequest
-- Returns:
- Result of the CreateModelCardExportJob operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelCardExportJob
default CreateModelCardExportJobResponse createModelCardExportJob(Consumer<CreateModelCardExportJobRequest.Builder> createModelCardExportJobRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateModelCardExportJobRequest.builder()
- Parameters:
createModelCardExportJobRequest
- AConsumer
that will call methods onCreateModelCardExportJobRequest.Builder
to create a request.- Returns:
- Result of the CreateModelCardExportJob operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelExplainabilityJobDefinition
default CreateModelExplainabilityJobDefinitionResponse createModelExplainabilityJobDefinition(CreateModelExplainabilityJobDefinitionRequest createModelExplainabilityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates the definition for a model explainability job.
- Parameters:
createModelExplainabilityJobDefinitionRequest
-- Returns:
- Result of the CreateModelExplainabilityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelExplainabilityJobDefinition
default CreateModelExplainabilityJobDefinitionResponse createModelExplainabilityJobDefinition(Consumer<CreateModelExplainabilityJobDefinitionRequest.Builder> createModelExplainabilityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateModelExplainabilityJobDefinitionRequest.builder()
- Parameters:
createModelExplainabilityJobDefinitionRequest
- AConsumer
that will call methods onCreateModelExplainabilityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateModelExplainabilityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelPackage
default CreateModelPackageResponse createModelPackage(CreateModelPackageRequest createModelPackageRequest) throws ConflictException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 forSourceAlgorithmSpecification
.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:
- Result of the CreateModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createModelPackage
default CreateModelPackageResponse createModelPackage(Consumer<CreateModelPackageRequest.Builder> createModelPackageRequest) throws ConflictException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 forSourceAlgorithmSpecification
.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 viaCreateModelPackageRequest.builder()
- Parameters:
createModelPackageRequest
- AConsumer
that will call methods onCreateModelPackageRequest.Builder
to create a request.- Returns:
- Result of the CreateModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createModelPackageGroup
default CreateModelPackageGroupResponse createModelPackageGroup(CreateModelPackageGroupRequest createModelPackageGroupRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a model group. A model group contains a group of model versions.
- Parameters:
createModelPackageGroupRequest
-- Returns:
- Result of the CreateModelPackageGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelPackageGroup
default CreateModelPackageGroupResponse createModelPackageGroup(Consumer<CreateModelPackageGroupRequest.Builder> createModelPackageGroupRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateModelPackageGroupRequest.builder()
- Parameters:
createModelPackageGroupRequest
- AConsumer
that will call methods onCreateModelPackageGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateModelPackageGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelQualityJobDefinition
default CreateModelQualityJobDefinitionResponse createModelQualityJobDefinition(CreateModelQualityJobDefinitionRequest createModelQualityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
- Parameters:
createModelQualityJobDefinitionRequest
-- Returns:
- Result of the CreateModelQualityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createModelQualityJobDefinition
default CreateModelQualityJobDefinitionResponse createModelQualityJobDefinition(Consumer<CreateModelQualityJobDefinitionRequest.Builder> createModelQualityJobDefinitionRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
This is a convenience which creates an instance of the
CreateModelQualityJobDefinitionRequest.Builder
avoiding the need to create one manually viaCreateModelQualityJobDefinitionRequest.builder()
- Parameters:
createModelQualityJobDefinitionRequest
- AConsumer
that will call methods onCreateModelQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the CreateModelQualityJobDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createMonitoringSchedule
default CreateMonitoringScheduleResponse createMonitoringSchedule(CreateMonitoringScheduleRequest createMonitoringScheduleRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
- Parameters:
createMonitoringScheduleRequest
-- Returns:
- Result of the CreateMonitoringSchedule operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createMonitoringSchedule
default CreateMonitoringScheduleResponse createMonitoringSchedule(Consumer<CreateMonitoringScheduleRequest.Builder> createMonitoringScheduleRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
This is a convenience which creates an instance of the
CreateMonitoringScheduleRequest.Builder
avoiding the need to create one manually viaCreateMonitoringScheduleRequest.builder()
- Parameters:
createMonitoringScheduleRequest
- AConsumer
that will call methods onCreateMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the CreateMonitoringSchedule operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createNotebookInstance
default CreateNotebookInstanceResponse createNotebookInstance(CreateNotebookInstanceRequest createNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an SageMaker AI 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 AI 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 AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker AI does the following:
-
Creates a network interface in the SageMaker AI VPC.
-
(Option) If you specified
SubnetId
, SageMaker AI 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 AI attaches the security group that you specified in the request to the network interface that it creates in your VPC. -
Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified
SubnetId
of your VPC, SageMaker AI 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 AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker AI 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 AI endpoints, and validate hosted models.
For more information, see How It Works.
- Parameters:
createNotebookInstanceRequest
-- Returns:
- Result of the CreateNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createNotebookInstance
default CreateNotebookInstanceResponse createNotebookInstance(Consumer<CreateNotebookInstanceRequest.Builder> createNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an SageMaker AI 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 AI 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 AI also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker AI with a specific algorithm or with a machine learning framework.
After receiving the request, SageMaker AI does the following:
-
Creates a network interface in the SageMaker AI VPC.
-
(Option) If you specified
SubnetId
, SageMaker AI 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 AI attaches the security group that you specified in the request to the network interface that it creates in your VPC. -
Launches an EC2 instance of the type specified in the request in the SageMaker AI VPC. If you specified
SubnetId
of your VPC, SageMaker AI 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 AI returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After SageMaker AI 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 AI 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 viaCreateNotebookInstanceRequest.builder()
- Parameters:
createNotebookInstanceRequest
- AConsumer
that will call methods onCreateNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createNotebookInstanceLifecycleConfig
default CreateNotebookInstanceLifecycleConfigResponse createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest createNotebookInstanceLifecycleConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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
$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:
- Result of the CreateNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createNotebookInstanceLifecycleConfig
default CreateNotebookInstanceLifecycleConfigResponse createNotebookInstanceLifecycleConfig(Consumer<CreateNotebookInstanceLifecycleConfigRequest.Builder> createNotebookInstanceLifecycleConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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
$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 viaCreateNotebookInstanceLifecycleConfigRequest.builder()
- Parameters:
createNotebookInstanceLifecycleConfigRequest
- AConsumer
that will call methods onCreateNotebookInstanceLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createOptimizationJob
default CreateOptimizationJobResponse createOptimizationJob(CreateOptimizationJobRequest createOptimizationJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.
For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.
- Parameters:
createOptimizationJobRequest
-- Returns:
- Result of the CreateOptimizationJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createOptimizationJob
default CreateOptimizationJobResponse createOptimizationJob(Consumer<CreateOptimizationJobRequest.Builder> createOptimizationJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.
For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.
This is a convenience which creates an instance of the
CreateOptimizationJobRequest.Builder
avoiding the need to create one manually viaCreateOptimizationJobRequest.builder()
- Parameters:
createOptimizationJobRequest
- AConsumer
that will call methods onCreateOptimizationJobRequest.Builder
to create a request.- Returns:
- Result of the CreateOptimizationJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createPartnerApp
default CreatePartnerAppResponse createPartnerApp(CreatePartnerAppRequest createPartnerAppRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker Partner AI App.
- Parameters:
createPartnerAppRequest
-- Returns:
- Result of the CreatePartnerApp operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPartnerApp
default CreatePartnerAppResponse createPartnerApp(Consumer<CreatePartnerAppRequest.Builder> createPartnerAppRequest) throws ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker Partner AI App.
This is a convenience which creates an instance of the
CreatePartnerAppRequest.Builder
avoiding the need to create one manually viaCreatePartnerAppRequest.builder()
- Parameters:
createPartnerAppRequest
- AConsumer
that will call methods onCreatePartnerAppRequest.Builder
to create a request.- Returns:
- Result of the CreatePartnerApp operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPartnerAppPresignedUrl
default CreatePartnerAppPresignedUrlResponse createPartnerAppPresignedUrl(CreatePartnerAppPresignedUrlRequest createPartnerAppPresignedUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a presigned URL to access an Amazon SageMaker Partner AI App.
- Parameters:
createPartnerAppPresignedUrlRequest
-- Returns:
- Result of the CreatePartnerAppPresignedUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPartnerAppPresignedUrl
default CreatePartnerAppPresignedUrlResponse createPartnerAppPresignedUrl(Consumer<CreatePartnerAppPresignedUrlRequest.Builder> createPartnerAppPresignedUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a presigned URL to access an Amazon SageMaker Partner AI App.
This is a convenience which creates an instance of the
CreatePartnerAppPresignedUrlRequest.Builder
avoiding the need to create one manually viaCreatePartnerAppPresignedUrlRequest.builder()
- Parameters:
createPartnerAppPresignedUrlRequest
- AConsumer
that will call methods onCreatePartnerAppPresignedUrlRequest.Builder
to create a request.- Returns:
- Result of the CreatePartnerAppPresignedUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPipeline
default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Creates a pipeline using a JSON pipeline definition.
- Parameters:
createPipelineRequest
-- Returns:
- Result of the CreatePipeline operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPipeline
default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreatePipelineRequest.builder()
- Parameters:
createPipelineRequest
- AConsumer
that will call methods onCreatePipelineRequest.Builder
to create a request.- Returns:
- Result of the CreatePipeline operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPresignedDomainUrl
default CreatePresignedDomainUrlResponse createPresignedDomainUrl(CreatePresignedDomainUrlRequest createPresignedDomainUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 AI 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 usingExpiresInSeconds
. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. -
The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.
- Parameters:
createPresignedDomainUrlRequest
-- Returns:
- Result of the CreatePresignedDomainUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createPresignedDomainUrl
default CreatePresignedDomainUrlResponse createPresignedDomainUrl(Consumer<CreatePresignedDomainUrlRequest.Builder> createPresignedDomainUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 AI 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 usingExpiresInSeconds
. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. -
The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.
This is a convenience which creates an instance of the
CreatePresignedDomainUrlRequest.Builder
avoiding the need to create one manually viaCreatePresignedDomainUrlRequest.builder()
- Parameters:
createPresignedDomainUrlRequest
- AConsumer
that will call methods onCreatePresignedDomainUrlRequest.Builder
to create a request.- Returns:
- Result of the CreatePresignedDomainUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createPresignedMlflowTrackingServerUrl
default CreatePresignedMlflowTrackingServerUrlResponse createPresignedMlflowTrackingServerUrl(CreatePresignedMlflowTrackingServerUrlRequest createPresignedMlflowTrackingServerUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.
- Parameters:
createPresignedMlflowTrackingServerUrlRequest
-- Returns:
- Result of the CreatePresignedMlflowTrackingServerUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPresignedMlflowTrackingServerUrl
default CreatePresignedMlflowTrackingServerUrlResponse createPresignedMlflowTrackingServerUrl(Consumer<CreatePresignedMlflowTrackingServerUrlRequest.Builder> createPresignedMlflowTrackingServerUrlRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.
This is a convenience which creates an instance of the
CreatePresignedMlflowTrackingServerUrlRequest.Builder
avoiding the need to create one manually viaCreatePresignedMlflowTrackingServerUrlRequest.builder()
- Parameters:
createPresignedMlflowTrackingServerUrlRequest
- AConsumer
that will call methods onCreatePresignedMlflowTrackingServerUrlRequest.Builder
to create a request.- Returns:
- Result of the CreatePresignedMlflowTrackingServerUrl operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPresignedNotebookInstanceUrl
default CreatePresignedNotebookInstanceUrlResponse createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest createPresignedNotebookInstanceUrlRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose
Open
next to a notebook instance, SageMaker AI 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 theaws: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:
- Result of the CreatePresignedNotebookInstanceUrl operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPresignedNotebookInstanceUrl
default CreatePresignedNotebookInstanceUrlResponse createPresignedNotebookInstanceUrl(Consumer<CreatePresignedNotebookInstanceUrlRequest.Builder> createPresignedNotebookInstanceUrlRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose
Open
next to a notebook instance, SageMaker AI 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 theaws: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 viaCreatePresignedNotebookInstanceUrlRequest.builder()
- Parameters:
createPresignedNotebookInstanceUrlRequest
- AConsumer
that will call methods onCreatePresignedNotebookInstanceUrlRequest.Builder
to create a request.- Returns:
- Result of the CreatePresignedNotebookInstanceUrl operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createProcessingJob
default CreateProcessingJobResponse createProcessingJob(CreateProcessingJobRequest createProcessingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a processing job.
- Parameters:
createProcessingJobRequest
-- Returns:
- Result of the CreateProcessingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createProcessingJob
default CreateProcessingJobResponse createProcessingJob(Consumer<CreateProcessingJobRequest.Builder> createProcessingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Creates a processing job.
This is a convenience which creates an instance of the
CreateProcessingJobRequest.Builder
avoiding the need to create one manually viaCreateProcessingJobRequest.builder()
- Parameters:
createProcessingJobRequest
- AConsumer
that will call methods onCreateProcessingJobRequest.Builder
to create a request.- Returns:
- Result of the CreateProcessingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createProject
default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateProject operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createProject
default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateProjectRequest.builder()
- Parameters:
createProjectRequest
- AConsumer
that will call methods onCreateProjectRequest.Builder
to create a request.- Returns:
- Result of the CreateProject operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createSpace
default CreateSpaceResponse createSpace(CreateSpaceRequest createSpaceRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a private space or a space used for real time collaboration in a domain.
- Parameters:
createSpaceRequest
-- Returns:
- Result of the CreateSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createSpace
default CreateSpaceResponse createSpace(Consumer<CreateSpaceRequest.Builder> createSpaceRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateSpaceRequest.builder()
- Parameters:
createSpaceRequest
- AConsumer
that will call methods onCreateSpaceRequest.Builder
to create a request.- Returns:
- Result of the CreateSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createStudioLifecycleConfig
default CreateStudioLifecycleConfigResponse createStudioLifecycleConfig(CreateStudioLifecycleConfigRequest createStudioLifecycleConfigRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
- Parameters:
createStudioLifecycleConfigRequest
-- Returns:
- Result of the CreateStudioLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createStudioLifecycleConfig
default CreateStudioLifecycleConfigResponse createStudioLifecycleConfig(Consumer<CreateStudioLifecycleConfigRequest.Builder> createStudioLifecycleConfigRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
This is a convenience which creates an instance of the
CreateStudioLifecycleConfigRequest.Builder
avoiding the need to create one manually viaCreateStudioLifecycleConfigRequest.builder()
- Parameters:
createStudioLifecycleConfigRequest
- AConsumer
that will call methods onCreateStudioLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateStudioLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createTrainingJob
default CreateTrainingJobResponse createTrainingJob(CreateTrainingJobRequest createTrainingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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, useMaxRuntimeInSeconds
to set a time limit for training. UseMaxWaitTimeInSeconds
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 anInternalServerError
.
For more information about SageMaker, see How It Works.
- Parameters:
createTrainingJobRequest
-- Returns:
- Result of the CreateTrainingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTrainingJob
default CreateTrainingJobResponse createTrainingJob(Consumer<CreateTrainingJobRequest.Builder> createTrainingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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, useMaxRuntimeInSeconds
to set a time limit for training. UseMaxWaitTimeInSeconds
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 anInternalServerError
.
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 viaCreateTrainingJobRequest.builder()
- Parameters:
createTrainingJobRequest
- AConsumer
that will call methods onCreateTrainingJobRequest.Builder
to create a request.- Returns:
- Result of the CreateTrainingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTrainingPlan
default CreateTrainingPlanResponse createTrainingPlan(CreateTrainingPlanRequest createTrainingPlanRequest) throws ResourceLimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
-
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the
SearchTrainingPlanOfferings
API operation. -
They create a plan that best matches their needs using the ID of the plan offering they want to use.
-
After successful upfront payment, the plan's status becomes
Scheduled
. -
The plan can be used to:
-
Queue training jobs.
-
Allocate to an instance group of a SageMaker HyperPod cluster.
-
-
When the plan start date arrives, it becomes
Active
. Based on available reserved capacity:-
Training jobs are launched.
-
Instance groups are provisioned.
-
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see
ReservedCapacitySummary
.- Parameters:
createTrainingPlanRequest
-- Returns:
- Result of the CreateTrainingPlan operation returned by the service.
- Throws:
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.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTrainingPlan
default CreateTrainingPlanResponse createTrainingPlan(Consumer<CreateTrainingPlanRequest.Builder> createTrainingPlanRequest) throws ResourceLimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
-
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the
SearchTrainingPlanOfferings
API operation. -
They create a plan that best matches their needs using the ID of the plan offering they want to use.
-
After successful upfront payment, the plan's status becomes
Scheduled
. -
The plan can be used to:
-
Queue training jobs.
-
Allocate to an instance group of a SageMaker HyperPod cluster.
-
-
When the plan start date arrives, it becomes
Active
. Based on available reserved capacity:-
Training jobs are launched.
-
Instance groups are provisioned.
-
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see
ReservedCapacitySummary
.
This is a convenience which creates an instance of the
CreateTrainingPlanRequest.Builder
avoiding the need to create one manually viaCreateTrainingPlanRequest.builder()
- Parameters:
createTrainingPlanRequest
- AConsumer
that will call methods onCreateTrainingPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateTrainingPlan operation returned by the service.
- Throws:
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.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTransformJob
default CreateTransformJobResponse createTransformJob(CreateTransformJobRequest createTransformJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
- Parameters:
createTransformJobRequest
-- Returns:
- Result of the CreateTransformJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTransformJob
default CreateTransformJobResponse createTransformJob(Consumer<CreateTransformJobRequest.Builder> createTransformJobRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 and AMI image versions 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 viaCreateTransformJobRequest.builder()
- Parameters:
createTransformJobRequest
- AConsumer
that will call methods onCreateTransformJobRequest.Builder
to create a request.- Returns:
- Result of the CreateTransformJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createTrial
default CreateTrialResponse createTrial(CreateTrialRequest createTrialRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateTrial operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createTrial
default CreateTrialResponse createTrial(Consumer<CreateTrialRequest.Builder> createTrialRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateTrialRequest.builder()
- Parameters:
createTrialRequest
- AConsumer
that will call methods onCreateTrialRequest.Builder
to create a request.- Returns:
- Result of the CreateTrial operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createTrialComponent
default CreateTrialComponentResponse createTrialComponent(CreateTrialComponentRequest createTrialComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateTrialComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createTrialComponent
default CreateTrialComponentResponse createTrialComponent(Consumer<CreateTrialComponentRequest.Builder> createTrialComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateTrialComponentRequest.builder()
- Parameters:
createTrialComponentRequest
- AConsumer
that will call methods onCreateTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the CreateTrialComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createUserProfile
default CreateUserProfileResponse createUserProfile(CreateUserProfileRequest createUserProfileRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createUserProfile
default CreateUserProfileResponse createUserProfile(Consumer<CreateUserProfileRequest.Builder> createUserProfileRequest) throws ResourceLimitExceededException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateUserProfileRequest.builder()
- Parameters:
createUserProfileRequest
- AConsumer
that will call methods onCreateUserProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createWorkforce
default CreateWorkforceResponse createWorkforce(CreateWorkforceRequest createWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createWorkforce
default CreateWorkforceResponse createWorkforce(Consumer<CreateWorkforceRequest.Builder> createWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaCreateWorkforceRequest.builder()
- Parameters:
createWorkforceRequest
- AConsumer
that will call methods onCreateWorkforceRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createWorkteam
default CreateWorkteamResponse createWorkteam(CreateWorkteamRequest createWorkteamRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the CreateWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
createWorkteam
default CreateWorkteamResponse createWorkteam(Consumer<CreateWorkteamRequest.Builder> createWorkteamRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaCreateWorkteamRequest.builder()
- Parameters:
createWorkteamRequest
- AConsumer
that will call methods onCreateWorkteamRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAction
default DeleteActionResponse deleteAction(DeleteActionRequest deleteActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an action.
- Parameters:
deleteActionRequest
-- Returns:
- Result of the DeleteAction operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAction
default DeleteActionResponse deleteAction(Consumer<DeleteActionRequest.Builder> deleteActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an action.
This is a convenience which creates an instance of the
DeleteActionRequest.Builder
avoiding the need to create one manually viaDeleteActionRequest.builder()
- Parameters:
deleteActionRequest
- AConsumer
that will call methods onDeleteActionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAction operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAlgorithm
default DeleteAlgorithmResponse deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Removes the specified algorithm from your account.
- Parameters:
deleteAlgorithmRequest
-- Returns:
- Result of the DeleteAlgorithm operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAlgorithm
default DeleteAlgorithmResponse deleteAlgorithm(Consumer<DeleteAlgorithmRequest.Builder> deleteAlgorithmRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteAlgorithmRequest.builder()
- Parameters:
deleteAlgorithmRequest
- AConsumer
that will call methods onDeleteAlgorithmRequest.Builder
to create a request.- Returns:
- Result of the DeleteAlgorithm operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Used to stop and delete an app.
- Parameters:
deleteAppRequest
-- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteAppRequest.builder()
- Parameters:
deleteAppRequest
- AConsumer
that will call methods onDeleteAppRequest.Builder
to create a request.- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAppImageConfig
default DeleteAppImageConfigResponse deleteAppImageConfig(DeleteAppImageConfigRequest deleteAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an AppImageConfig.
- Parameters:
deleteAppImageConfigRequest
-- Returns:
- Result of the DeleteAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAppImageConfig
default DeleteAppImageConfigResponse deleteAppImageConfig(Consumer<DeleteAppImageConfigRequest.Builder> deleteAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an AppImageConfig.
This is a convenience which creates an instance of the
DeleteAppImageConfigRequest.Builder
avoiding the need to create one manually viaDeleteAppImageConfigRequest.builder()
- Parameters:
deleteAppImageConfigRequest
- AConsumer
that will call methods onDeleteAppImageConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteArtifact
default DeleteArtifactResponse deleteArtifact(DeleteArtifactRequest deleteArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an artifact. Either
ArtifactArn
orSource
must be specified.- Parameters:
deleteArtifactRequest
-- Returns:
- Result of the DeleteArtifact operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteArtifact
default DeleteArtifactResponse deleteArtifact(Consumer<DeleteArtifactRequest.Builder> deleteArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an artifact. Either
ArtifactArn
orSource
must be specified.
This is a convenience which creates an instance of the
DeleteArtifactRequest.Builder
avoiding the need to create one manually viaDeleteArtifactRequest.builder()
- Parameters:
deleteArtifactRequest
- AConsumer
that will call methods onDeleteArtifactRequest.Builder
to create a request.- Returns:
- Result of the DeleteArtifact operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAssociation
default DeleteAssociationResponse deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an association.
- Parameters:
deleteAssociationRequest
-- Returns:
- Result of the DeleteAssociation operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteAssociation
default DeleteAssociationResponse deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an association.
This is a convenience which creates an instance of the
DeleteAssociationRequest.Builder
avoiding the need to create one manually viaDeleteAssociationRequest.builder()
- Parameters:
deleteAssociationRequest
- AConsumer
that will call methods onDeleteAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssociation operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Delete a SageMaker HyperPod cluster.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Delete a SageMaker HyperPod cluster.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteClusterSchedulerConfig
default DeleteClusterSchedulerConfigResponse deleteClusterSchedulerConfig(DeleteClusterSchedulerConfigRequest deleteClusterSchedulerConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the cluster policy of the cluster.
- Parameters:
deleteClusterSchedulerConfigRequest
-- Returns:
- Result of the DeleteClusterSchedulerConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteClusterSchedulerConfig
default DeleteClusterSchedulerConfigResponse deleteClusterSchedulerConfig(Consumer<DeleteClusterSchedulerConfigRequest.Builder> deleteClusterSchedulerConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the cluster policy of the cluster.
This is a convenience which creates an instance of the
DeleteClusterSchedulerConfigRequest.Builder
avoiding the need to create one manually viaDeleteClusterSchedulerConfigRequest.builder()
- Parameters:
deleteClusterSchedulerConfigRequest
- AConsumer
that will call methods onDeleteClusterSchedulerConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteClusterSchedulerConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCodeRepository
default DeleteCodeRepositoryResponse deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes the specified Git repository from your account.
- Parameters:
deleteCodeRepositoryRequest
-- Returns:
- Result of the DeleteCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCodeRepository
default DeleteCodeRepositoryResponse deleteCodeRepository(Consumer<DeleteCodeRepositoryRequest.Builder> deleteCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteCodeRepositoryRequest.builder()
- Parameters:
deleteCodeRepositoryRequest
- AConsumer
that will call methods onDeleteCodeRepositoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCompilationJob
default DeleteCompilationJobResponse deleteCompilationJob(DeleteCompilationJobRequest deleteCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. 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
, orSTOPPED
. If the job status isSTARTING
orINPROGRESS
, stop the job, and then delete it after its status becomesSTOPPED
.- Parameters:
deleteCompilationJobRequest
-- Returns:
- Result of the DeleteCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteCompilationJob
default DeleteCompilationJobResponse deleteCompilationJob(Consumer<DeleteCompilationJobRequest.Builder> deleteCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. 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
, orSTOPPED
. If the job status isSTARTING
orINPROGRESS
, stop the job, and then delete it after its status becomesSTOPPED
.
This is a convenience which creates an instance of the
DeleteCompilationJobRequest.Builder
avoiding the need to create one manually viaDeleteCompilationJobRequest.builder()
- Parameters:
deleteCompilationJobRequest
- AConsumer
that will call methods onDeleteCompilationJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteComputeQuota
default DeleteComputeQuotaResponse deleteComputeQuota(DeleteComputeQuotaRequest deleteComputeQuotaRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the compute allocation from the cluster.
- Parameters:
deleteComputeQuotaRequest
-- Returns:
- Result of the DeleteComputeQuota operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteComputeQuota
default DeleteComputeQuotaResponse deleteComputeQuota(Consumer<DeleteComputeQuotaRequest.Builder> deleteComputeQuotaRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the compute allocation from the cluster.
This is a convenience which creates an instance of the
DeleteComputeQuotaRequest.Builder
avoiding the need to create one manually viaDeleteComputeQuotaRequest.builder()
- Parameters:
deleteComputeQuotaRequest
- AConsumer
that will call methods onDeleteComputeQuotaRequest.Builder
to create a request.- Returns:
- Result of the DeleteComputeQuota operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteContext
default DeleteContextResponse deleteContext(DeleteContextRequest deleteContextRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an context.
- Parameters:
deleteContextRequest
-- Returns:
- Result of the DeleteContext operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteContext
default DeleteContextResponse deleteContext(Consumer<DeleteContextRequest.Builder> deleteContextRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an context.
This is a convenience which creates an instance of the
DeleteContextRequest.Builder
avoiding the need to create one manually viaDeleteContextRequest.builder()
- Parameters:
deleteContextRequest
- AConsumer
that will call methods onDeleteContextRequest.Builder
to create a request.- Returns:
- Result of the DeleteContext operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDataQualityJobDefinition
default DeleteDataQualityJobDefinitionResponse deleteDataQualityJobDefinition(DeleteDataQualityJobDefinitionRequest deleteDataQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes a data quality monitoring job definition.
- Parameters:
deleteDataQualityJobDefinitionRequest
-- Returns:
- Result of the DeleteDataQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDataQualityJobDefinition
default DeleteDataQualityJobDefinitionResponse deleteDataQualityJobDefinition(Consumer<DeleteDataQualityJobDefinitionRequest.Builder> deleteDataQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteDataQualityJobDefinitionRequest.builder()
- Parameters:
deleteDataQualityJobDefinitionRequest
- AConsumer
that will call methods onDeleteDataQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDeviceFleet
default DeleteDeviceFleetResponse deleteDeviceFleet(DeleteDeviceFleetRequest deleteDeviceFleetRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Deletes a fleet.
- Parameters:
deleteDeviceFleetRequest
-- Returns:
- Result of the DeleteDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDeviceFleet
default DeleteDeviceFleetResponse deleteDeviceFleet(Consumer<DeleteDeviceFleetRequest.Builder> deleteDeviceFleetRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Deletes a fleet.
This is a convenience which creates an instance of the
DeleteDeviceFleetRequest.Builder
avoiding the need to create one manually viaDeleteDeviceFleetRequest.builder()
- Parameters:
deleteDeviceFleetRequest
- AConsumer
that will call methods onDeleteDeviceFleetRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteDomainRequest.builder()
- Parameters:
deleteDomainRequest
- AConsumer
that will call methods onDeleteDomainRequest.Builder
to create a request.- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEdgeDeploymentPlan
default DeleteEdgeDeploymentPlanResponse deleteEdgeDeploymentPlan(DeleteEdgeDeploymentPlanRequest deleteEdgeDeploymentPlanRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteEdgeDeploymentPlan operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEdgeDeploymentPlan
default DeleteEdgeDeploymentPlanResponse deleteEdgeDeploymentPlan(Consumer<DeleteEdgeDeploymentPlanRequest.Builder> deleteEdgeDeploymentPlanRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteEdgeDeploymentPlanRequest.builder()
- Parameters:
deleteEdgeDeploymentPlanRequest
- AConsumer
that will call methods onDeleteEdgeDeploymentPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteEdgeDeploymentPlan operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEdgeDeploymentStage
default DeleteEdgeDeploymentStageResponse deleteEdgeDeploymentStage(DeleteEdgeDeploymentStageRequest deleteEdgeDeploymentStageRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Delete a stage in an edge deployment plan if (and only if) the stage is inactive.
- Parameters:
deleteEdgeDeploymentStageRequest
-- Returns:
- Result of the DeleteEdgeDeploymentStage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEdgeDeploymentStage
default DeleteEdgeDeploymentStageResponse deleteEdgeDeploymentStage(Consumer<DeleteEdgeDeploymentStageRequest.Builder> deleteEdgeDeploymentStageRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteEdgeDeploymentStageRequest.builder()
- Parameters:
deleteEdgeDeploymentStageRequest
- AConsumer
that will call methods onDeleteEdgeDeploymentStageRequest.Builder
to create a request.- Returns:
- Result of the DeleteEdgeDeploymentStage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteEndpoint operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteEndpointRequest.builder()
- Parameters:
deleteEndpointRequest
- AConsumer
that will call methods onDeleteEndpointRequest.Builder
to create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEndpointConfig
default DeleteEndpointConfigResponse deleteEndpointConfig(DeleteEndpointConfigRequest deleteEndpointConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. If you delete theEndpointConfig
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:
- Result of the DeleteEndpointConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteEndpointConfig
default DeleteEndpointConfigResponse deleteEndpointConfig(Consumer<DeleteEndpointConfigRequest.Builder> deleteEndpointConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. If you delete theEndpointConfig
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 viaDeleteEndpointConfigRequest.builder()
- Parameters:
deleteEndpointConfigRequest
- AConsumer
that will call methods onDeleteEndpointConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteEndpointConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteExperiment
default DeleteExperimentResponse deleteExperiment(DeleteExperimentRequest deleteExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteExperiment
default DeleteExperimentResponse deleteExperiment(Consumer<DeleteExperimentRequest.Builder> deleteExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteExperimentRequest.builder()
- Parameters:
deleteExperimentRequest
- AConsumer
that will call methods onDeleteExperimentRequest.Builder
to create a request.- Returns:
- Result of the DeleteExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFeatureGroup
default DeleteFeatureGroupResponse deleteFeatureGroup(DeleteFeatureGroupRequest deleteFeatureGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete the
FeatureGroup
and any data that was written to theOnlineStore
of theFeatureGroup
. Data cannot be accessed from theOnlineStore
immediately afterDeleteFeatureGroup
is called.Data written into the
OfflineStore
will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for yourOfflineStore
are not deleted.Note that it can take approximately 10-15 minutes to delete an
OnlineStore
FeatureGroup
with theInMemory
StorageType
.- Parameters:
deleteFeatureGroupRequest
-- Returns:
- Result of the DeleteFeatureGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFeatureGroup
default DeleteFeatureGroupResponse deleteFeatureGroup(Consumer<DeleteFeatureGroupRequest.Builder> deleteFeatureGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete the
FeatureGroup
and any data that was written to theOnlineStore
of theFeatureGroup
. Data cannot be accessed from theOnlineStore
immediately afterDeleteFeatureGroup
is called.Data written into the
OfflineStore
will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for yourOfflineStore
are not deleted.Note that it can take approximately 10-15 minutes to delete an
OnlineStore
FeatureGroup
with theInMemory
StorageType
.
This is a convenience which creates an instance of the
DeleteFeatureGroupRequest.Builder
avoiding the need to create one manually viaDeleteFeatureGroupRequest.builder()
- Parameters:
deleteFeatureGroupRequest
- AConsumer
that will call methods onDeleteFeatureGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteFeatureGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFlowDefinition
default DeleteFlowDefinitionResponse deleteFlowDefinition(DeleteFlowDefinitionRequest deleteFlowDefinitionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified flow definition.
- Parameters:
deleteFlowDefinitionRequest
-- Returns:
- Result of the DeleteFlowDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteFlowDefinition
default DeleteFlowDefinitionResponse deleteFlowDefinition(Consumer<DeleteFlowDefinitionRequest.Builder> deleteFlowDefinitionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified flow definition.
This is a convenience which creates an instance of the
DeleteFlowDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteFlowDefinitionRequest.builder()
- Parameters:
deleteFlowDefinitionRequest
- AConsumer
that will call methods onDeleteFlowDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlowDefinition operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHub
default DeleteHubResponse deleteHub(DeleteHubRequest deleteHubRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete a hub.
- Parameters:
deleteHubRequest
-- Returns:
- Result of the DeleteHub operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHub
default DeleteHubResponse deleteHub(Consumer<DeleteHubRequest.Builder> deleteHubRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete a hub.
This is a convenience which creates an instance of the
DeleteHubRequest.Builder
avoiding the need to create one manually viaDeleteHubRequest.builder()
- Parameters:
deleteHubRequest
- AConsumer
that will call methods onDeleteHubRequest.Builder
to create a request.- Returns:
- Result of the DeleteHub operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHubContent
default DeleteHubContentResponse deleteHubContent(DeleteHubContentRequest deleteHubContentRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete the contents of a hub.
- Parameters:
deleteHubContentRequest
-- Returns:
- Result of the DeleteHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHubContent
default DeleteHubContentResponse deleteHubContent(Consumer<DeleteHubContentRequest.Builder> deleteHubContentRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete the contents of a hub.
This is a convenience which creates an instance of the
DeleteHubContentRequest.Builder
avoiding the need to create one manually viaDeleteHubContentRequest.builder()
- Parameters:
deleteHubContentRequest
- AConsumer
that will call methods onDeleteHubContentRequest.Builder
to create a request.- Returns:
- Result of the DeleteHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHubContentReference
default DeleteHubContentReferenceResponse deleteHubContentReference(DeleteHubContentReferenceRequest deleteHubContentReferenceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete a hub content reference in order to remove a model from a private hub.
- Parameters:
deleteHubContentReferenceRequest
-- Returns:
- Result of the DeleteHubContentReference operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHubContentReference
default DeleteHubContentReferenceResponse deleteHubContentReference(Consumer<DeleteHubContentReferenceRequest.Builder> deleteHubContentReferenceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Delete a hub content reference in order to remove a model from a private hub.
This is a convenience which creates an instance of the
DeleteHubContentReferenceRequest.Builder
avoiding the need to create one manually viaDeleteHubContentReferenceRequest.builder()
- Parameters:
deleteHubContentReferenceRequest
- AConsumer
that will call methods onDeleteHubContentReferenceRequest.Builder
to create a request.- Returns:
- Result of the DeleteHubContentReference operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHumanTaskUi
default DeleteHumanTaskUiResponse deleteHumanTaskUi(DeleteHumanTaskUiRequest deleteHumanTaskUiRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteHumanTaskUi operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHumanTaskUi
default DeleteHumanTaskUiResponse deleteHumanTaskUi(Consumer<DeleteHumanTaskUiRequest.Builder> deleteHumanTaskUiRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteHumanTaskUiRequest.builder()
- Parameters:
deleteHumanTaskUiRequest
- AConsumer
that will call methods onDeleteHumanTaskUiRequest.Builder
to create a request.- Returns:
- Result of the DeleteHumanTaskUi operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHyperParameterTuningJob
default DeleteHyperParameterTuningJobResponse deleteHyperParameterTuningJob(DeleteHyperParameterTuningJobRequest deleteHyperParameterTuningJobRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a hyperparameter tuning job. The
DeleteHyperParameterTuningJob
API deletes only the tuning job entry that was created in SageMaker when you called theCreateHyperParameterTuningJob
API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.- Parameters:
deleteHyperParameterTuningJobRequest
-- Returns:
- Result of the DeleteHyperParameterTuningJob operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteHyperParameterTuningJob
default DeleteHyperParameterTuningJobResponse deleteHyperParameterTuningJob(Consumer<DeleteHyperParameterTuningJobRequest.Builder> deleteHyperParameterTuningJobRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a hyperparameter tuning job. The
DeleteHyperParameterTuningJob
API deletes only the tuning job entry that was created in SageMaker when you called theCreateHyperParameterTuningJob
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 viaDeleteHyperParameterTuningJobRequest.builder()
- Parameters:
deleteHyperParameterTuningJobRequest
- AConsumer
that will call methods onDeleteHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteHyperParameterTuningJob operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteImage
default DeleteImageResponse deleteImage(DeleteImageRequest deleteImageRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.
- Parameters:
deleteImageRequest
-- Returns:
- Result of the DeleteImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteImage
default DeleteImageResponse deleteImage(Consumer<DeleteImageRequest.Builder> deleteImageRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes a SageMaker AI 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 viaDeleteImageRequest.builder()
- Parameters:
deleteImageRequest
- AConsumer
that will call methods onDeleteImageRequest.Builder
to create a request.- Returns:
- Result of the DeleteImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteImageVersion
default DeleteImageVersionResponse deleteImageVersion(DeleteImageVersionRequest deleteImageVersionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.
- Parameters:
deleteImageVersionRequest
-- Returns:
- Result of the DeleteImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteImageVersion
default DeleteImageVersionResponse deleteImageVersion(Consumer<DeleteImageVersionRequest.Builder> deleteImageVersionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes a version of a SageMaker AI 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 viaDeleteImageVersionRequest.builder()
- Parameters:
deleteImageVersionRequest
- AConsumer
that will call methods onDeleteImageVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteInferenceComponent
default DeleteInferenceComponentResponse deleteInferenceComponent(DeleteInferenceComponentRequest deleteInferenceComponentRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an inference component.
- Parameters:
deleteInferenceComponentRequest
-- Returns:
- Result of the DeleteInferenceComponent operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteInferenceComponent
default DeleteInferenceComponentResponse deleteInferenceComponent(Consumer<DeleteInferenceComponentRequest.Builder> deleteInferenceComponentRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an inference component.
This is a convenience which creates an instance of the
DeleteInferenceComponentRequest.Builder
avoiding the need to create one manually viaDeleteInferenceComponentRequest.builder()
- Parameters:
deleteInferenceComponentRequest
- AConsumer
that will call methods onDeleteInferenceComponentRequest.Builder
to create a request.- Returns:
- Result of the DeleteInferenceComponent operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteInferenceExperiment
default DeleteInferenceExperimentResponse deleteInferenceExperiment(DeleteInferenceExperimentRequest deleteInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteInferenceExperiment
default DeleteInferenceExperimentResponse deleteInferenceExperiment(Consumer<DeleteInferenceExperimentRequest.Builder> deleteInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteInferenceExperimentRequest.builder()
- Parameters:
deleteInferenceExperimentRequest
- AConsumer
that will call methods onDeleteInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the DeleteInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMlflowTrackingServer
default DeleteMlflowTrackingServerResponse deleteMlflowTrackingServer(DeleteMlflowTrackingServerRequest deleteMlflowTrackingServerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
- Parameters:
deleteMlflowTrackingServerRequest
-- Returns:
- Result of the DeleteMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMlflowTrackingServer
default DeleteMlflowTrackingServerResponse deleteMlflowTrackingServer(Consumer<DeleteMlflowTrackingServerRequest.Builder> deleteMlflowTrackingServerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.
This is a convenience which creates an instance of the
DeleteMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaDeleteMlflowTrackingServerRequest.builder()
- Parameters:
deleteMlflowTrackingServerRequest
- AConsumer
that will call methods onDeleteMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the DeleteMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModel
default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model. The
DeleteModel
API deletes only the model entry that was created in SageMaker when you called theCreateModel
API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.- Parameters:
deleteModelRequest
-- Returns:
- Result of the DeleteModel operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModel
default DeleteModelResponse deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model. The
DeleteModel
API deletes only the model entry that was created in SageMaker when you called theCreateModel
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 viaDeleteModelRequest.builder()
- Parameters:
deleteModelRequest
- AConsumer
that will call methods onDeleteModelRequest.Builder
to create a request.- Returns:
- Result of the DeleteModel operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelBiasJobDefinition
default DeleteModelBiasJobDefinitionResponse deleteModelBiasJobDefinition(DeleteModelBiasJobDefinitionRequest deleteModelBiasJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker AI model bias job definition.
- Parameters:
deleteModelBiasJobDefinitionRequest
-- Returns:
- Result of the DeleteModelBiasJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelBiasJobDefinition
default DeleteModelBiasJobDefinitionResponse deleteModelBiasJobDefinition(Consumer<DeleteModelBiasJobDefinitionRequest.Builder> deleteModelBiasJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker AI model bias job definition.
This is a convenience which creates an instance of the
DeleteModelBiasJobDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteModelBiasJobDefinitionRequest.builder()
- Parameters:
deleteModelBiasJobDefinitionRequest
- AConsumer
that will call methods onDeleteModelBiasJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelBiasJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelCard
default DeleteModelCardResponse deleteModelCard(DeleteModelCardRequest deleteModelCardRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker Model Card.
- Parameters:
deleteModelCardRequest
-- Returns:
- Result of the DeleteModelCard operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelCard
default DeleteModelCardResponse deleteModelCard(Consumer<DeleteModelCardRequest.Builder> deleteModelCardRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteModelCardRequest.builder()
- Parameters:
deleteModelCardRequest
- AConsumer
that will call methods onDeleteModelCardRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelCard operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelExplainabilityJobDefinition
default DeleteModelExplainabilityJobDefinitionResponse deleteModelExplainabilityJobDefinition(DeleteModelExplainabilityJobDefinitionRequest deleteModelExplainabilityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker AI model explainability job definition.
- Parameters:
deleteModelExplainabilityJobDefinitionRequest
-- Returns:
- Result of the DeleteModelExplainabilityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelExplainabilityJobDefinition
default DeleteModelExplainabilityJobDefinitionResponse deleteModelExplainabilityJobDefinition(Consumer<DeleteModelExplainabilityJobDefinitionRequest.Builder> deleteModelExplainabilityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker AI model explainability job definition.
This is a convenience which creates an instance of the
DeleteModelExplainabilityJobDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteModelExplainabilityJobDefinitionRequest.builder()
- Parameters:
deleteModelExplainabilityJobDefinitionRequest
- AConsumer
that will call methods onDeleteModelExplainabilityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelExplainabilityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackage
default DeleteModelPackageResponse deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackage
default DeleteModelPackageResponse deleteModelPackage(Consumer<DeleteModelPackageRequest.Builder> deleteModelPackageRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteModelPackageRequest.builder()
- Parameters:
deleteModelPackageRequest
- AConsumer
that will call methods onDeleteModelPackageRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackageGroup
default DeleteModelPackageGroupResponse deleteModelPackageGroup(DeleteModelPackageGroupRequest deleteModelPackageGroupRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified model group.
- Parameters:
deleteModelPackageGroupRequest
-- Returns:
- Result of the DeleteModelPackageGroup operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackageGroup
default DeleteModelPackageGroupResponse deleteModelPackageGroup(Consumer<DeleteModelPackageGroupRequest.Builder> deleteModelPackageGroupRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Deletes the specified model group.
This is a convenience which creates an instance of the
DeleteModelPackageGroupRequest.Builder
avoiding the need to create one manually viaDeleteModelPackageGroupRequest.builder()
- Parameters:
deleteModelPackageGroupRequest
- AConsumer
that will call methods onDeleteModelPackageGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelPackageGroup operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackageGroupPolicy
default DeleteModelPackageGroupPolicyResponse deleteModelPackageGroupPolicy(DeleteModelPackageGroupPolicyRequest deleteModelPackageGroupPolicyRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model group resource policy.
- Parameters:
deleteModelPackageGroupPolicyRequest
-- Returns:
- Result of the DeleteModelPackageGroupPolicy operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelPackageGroupPolicy
default DeleteModelPackageGroupPolicyResponse deleteModelPackageGroupPolicy(Consumer<DeleteModelPackageGroupPolicyRequest.Builder> deleteModelPackageGroupPolicyRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteModelPackageGroupPolicyRequest.builder()
- Parameters:
deleteModelPackageGroupPolicyRequest
- AConsumer
that will call methods onDeleteModelPackageGroupPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelPackageGroupPolicy operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelQualityJobDefinition
default DeleteModelQualityJobDefinitionResponse deleteModelQualityJobDefinition(DeleteModelQualityJobDefinitionRequest deleteModelQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes the secified model quality monitoring job definition.
- Parameters:
deleteModelQualityJobDefinitionRequest
-- Returns:
- Result of the DeleteModelQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteModelQualityJobDefinition
default DeleteModelQualityJobDefinitionResponse deleteModelQualityJobDefinition(Consumer<DeleteModelQualityJobDefinitionRequest.Builder> deleteModelQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteModelQualityJobDefinitionRequest.builder()
- Parameters:
deleteModelQualityJobDefinitionRequest
- AConsumer
that will call methods onDeleteModelQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DeleteModelQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMonitoringSchedule
default DeleteMonitoringScheduleResponse deleteMonitoringSchedule(DeleteMonitoringScheduleRequest deleteMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMonitoringSchedule
default DeleteMonitoringScheduleResponse deleteMonitoringSchedule(Consumer<DeleteMonitoringScheduleRequest.Builder> deleteMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteMonitoringScheduleRequest.builder()
- Parameters:
deleteMonitoringScheduleRequest
- AConsumer
that will call methods onDeleteMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the DeleteMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteNotebookInstance
default DeleteNotebookInstanceResponse deleteNotebookInstance(DeleteNotebookInstanceRequest deleteNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an SageMaker AI 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 AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
- Parameters:
deleteNotebookInstanceRequest
-- Returns:
- Result of the DeleteNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteNotebookInstance
default DeleteNotebookInstanceResponse deleteNotebookInstance(Consumer<DeleteNotebookInstanceRequest.Builder> deleteNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an SageMaker AI 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 AI 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 viaDeleteNotebookInstanceRequest.builder()
- Parameters:
deleteNotebookInstanceRequest
- AConsumer
that will call methods onDeleteNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteNotebookInstanceLifecycleConfig
default DeleteNotebookInstanceLifecycleConfigResponse deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a notebook instance lifecycle configuration.
- Parameters:
deleteNotebookInstanceLifecycleConfigRequest
-- Returns:
- Result of the DeleteNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteNotebookInstanceLifecycleConfig
default DeleteNotebookInstanceLifecycleConfigResponse deleteNotebookInstanceLifecycleConfig(Consumer<DeleteNotebookInstanceLifecycleConfigRequest.Builder> deleteNotebookInstanceLifecycleConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteNotebookInstanceLifecycleConfigRequest.builder()
- Parameters:
deleteNotebookInstanceLifecycleConfigRequest
- AConsumer
that will call methods onDeleteNotebookInstanceLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteOptimizationJob
default DeleteOptimizationJobResponse deleteOptimizationJob(DeleteOptimizationJobRequest deleteOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an optimization job.
- Parameters:
deleteOptimizationJobRequest
-- Returns:
- Result of the DeleteOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteOptimizationJob
default DeleteOptimizationJobResponse deleteOptimizationJob(Consumer<DeleteOptimizationJobRequest.Builder> deleteOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Deletes an optimization job.
This is a convenience which creates an instance of the
DeleteOptimizationJobRequest.Builder
avoiding the need to create one manually viaDeleteOptimizationJobRequest.builder()
- Parameters:
deleteOptimizationJobRequest
- AConsumer
that will call methods onDeleteOptimizationJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deletePartnerApp
default DeletePartnerAppResponse deletePartnerApp(DeletePartnerAppRequest deletePartnerAppRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Deletes a SageMaker Partner AI App.
- Parameters:
deletePartnerAppRequest
-- Returns:
- Result of the DeletePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deletePartnerApp
default DeletePartnerAppResponse deletePartnerApp(Consumer<DeletePartnerAppRequest.Builder> deletePartnerAppRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Deletes a SageMaker Partner AI App.
This is a convenience which creates an instance of the
DeletePartnerAppRequest.Builder
avoiding the need to create one manually viaDeletePartnerAppRequest.builder()
- Parameters:
deletePartnerAppRequest
- AConsumer
that will call methods onDeletePartnerAppRequest.Builder
to create a request.- Returns:
- Result of the DeletePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deletePipeline
default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeletePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deletePipeline
default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeletePipelineRequest.builder()
- Parameters:
deletePipelineRequest
- AConsumer
that will call methods onDeletePipelineRequest.Builder
to create a request.- Returns:
- Result of the DeletePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteProject
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Delete the specified project.
- Parameters:
deleteProjectRequest
-- Returns:
- Result of the DeleteProject operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteProject
default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Delete the specified project.
This is a convenience which creates an instance of the
DeleteProjectRequest.Builder
avoiding the need to create one manually viaDeleteProjectRequest.builder()
- Parameters:
deleteProjectRequest
- AConsumer
that will call methods onDeleteProjectRequest.Builder
to create a request.- Returns:
- Result of the DeleteProject operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteSpace
default DeleteSpaceResponse deleteSpace(DeleteSpaceRequest deleteSpaceRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Used to delete a space.
- Parameters:
deleteSpaceRequest
-- Returns:
- Result of the DeleteSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteSpace
default DeleteSpaceResponse deleteSpace(Consumer<DeleteSpaceRequest.Builder> deleteSpaceRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Used to delete a space.
This is a convenience which creates an instance of the
DeleteSpaceRequest.Builder
avoiding the need to create one manually viaDeleteSpaceRequest.builder()
- Parameters:
deleteSpaceRequest
- AConsumer
that will call methods onDeleteSpaceRequest.Builder
to create a request.- Returns:
- Result of the DeleteSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteStudioLifecycleConfig
default DeleteStudioLifecycleConfigResponse deleteStudioLifecycleConfig(DeleteStudioLifecycleConfigRequest deleteStudioLifecycleConfigRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Deletes the Amazon SageMaker AI 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:
- Result of the DeleteStudioLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteStudioLifecycleConfig
default DeleteStudioLifecycleConfigResponse deleteStudioLifecycleConfig(Consumer<DeleteStudioLifecycleConfigRequest.Builder> deleteStudioLifecycleConfigRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Deletes the Amazon SageMaker AI 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 viaDeleteStudioLifecycleConfigRequest.builder()
- Parameters:
deleteStudioLifecycleConfigRequest
- AConsumer
that will call methods onDeleteStudioLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteStudioLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTags
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTags
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTrial
default DeleteTrialResponse deleteTrial(DeleteTrialRequest deleteTrialRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteTrial operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTrial
default DeleteTrialResponse deleteTrial(Consumer<DeleteTrialRequest.Builder> deleteTrialRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteTrialRequest.builder()
- Parameters:
deleteTrialRequest
- AConsumer
that will call methods onDeleteTrialRequest.Builder
to create a request.- Returns:
- Result of the DeleteTrial operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTrialComponent
default DeleteTrialComponentResponse deleteTrialComponent(DeleteTrialComponentRequest deleteTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteTrialComponent
default DeleteTrialComponentResponse deleteTrialComponent(Consumer<DeleteTrialComponentRequest.Builder> deleteTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteTrialComponentRequest.builder()
- Parameters:
deleteTrialComponentRequest
- AConsumer
that will call methods onDeleteTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the DeleteTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteUserProfile
default DeleteUserProfileResponse deleteUserProfile(DeleteUserProfileRequest deleteUserProfileRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DeleteUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteUserProfile
default DeleteUserProfileResponse deleteUserProfile(Consumer<DeleteUserProfileRequest.Builder> deleteUserProfileRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteUserProfileRequest.builder()
- Parameters:
deleteUserProfileRequest
- AConsumer
that will call methods onDeleteUserProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteWorkforce
default DeleteWorkforceResponse deleteWorkforce(DeleteWorkforceRequest deleteWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 receive a
ResourceInUse
error.- Parameters:
deleteWorkforceRequest
-- Returns:
- Result of the DeleteWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteWorkforce
default DeleteWorkforceResponse deleteWorkforce(Consumer<DeleteWorkforceRequest.Builder> deleteWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 receive a
ResourceInUse
error.
This is a convenience which creates an instance of the
DeleteWorkforceRequest.Builder
avoiding the need to create one manually viaDeleteWorkforceRequest.builder()
- Parameters:
deleteWorkforceRequest
- AConsumer
that will call methods onDeleteWorkforceRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteWorkteam
default DeleteWorkteamResponse deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Deletes an existing work team. This operation can't be undone.
- Parameters:
deleteWorkteamRequest
-- Returns:
- Result of the DeleteWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteWorkteam
default DeleteWorkteamResponse deleteWorkteam(Consumer<DeleteWorkteamRequest.Builder> deleteWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaDeleteWorkteamRequest.builder()
- Parameters:
deleteWorkteamRequest
- AConsumer
that will call methods onDeleteWorkteamRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
deregisterDevices
default DeregisterDevicesResponse deregisterDevices(DeregisterDevicesRequest deregisterDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
- Parameters:
deregisterDevicesRequest
-- Returns:
- Result of the DeregisterDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deregisterDevices
default DeregisterDevicesResponse deregisterDevices(Consumer<DeregisterDevicesRequest.Builder> deregisterDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDeregisterDevicesRequest.builder()
- Parameters:
deregisterDevicesRequest
- AConsumer
that will call methods onDeregisterDevicesRequest.Builder
to create a request.- Returns:
- Result of the DeregisterDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAction
default DescribeActionResponse describeAction(DescribeActionRequest describeActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an action.
- Parameters:
describeActionRequest
-- Returns:
- Result of the DescribeAction operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAction
default DescribeActionResponse describeAction(Consumer<DescribeActionRequest.Builder> describeActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an action.
This is a convenience which creates an instance of the
DescribeActionRequest.Builder
avoiding the need to create one manually viaDescribeActionRequest.builder()
- Parameters:
describeActionRequest
- AConsumer
that will call methods onDescribeActionRequest.Builder
to create a request.- Returns:
- Result of the DescribeAction operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAlgorithm
default DescribeAlgorithmResponse describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified algorithm that is in your account.
- Parameters:
describeAlgorithmRequest
-- Returns:
- Result of the DescribeAlgorithm operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAlgorithm
default DescribeAlgorithmResponse describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeAlgorithmRequest.builder()
- Parameters:
describeAlgorithmRequest
- AConsumer
that will call methods onDescribeAlgorithmRequest.Builder
to create a request.- Returns:
- Result of the DescribeAlgorithm operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeApp
default DescribeAppResponse describeApp(DescribeAppRequest describeAppRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the app.
- Parameters:
describeAppRequest
-- Returns:
- Result of the DescribeApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeApp
default DescribeAppResponse describeApp(Consumer<DescribeAppRequest.Builder> describeAppRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the app.
This is a convenience which creates an instance of the
DescribeAppRequest.Builder
avoiding the need to create one manually viaDescribeAppRequest.builder()
- Parameters:
describeAppRequest
- AConsumer
that will call methods onDescribeAppRequest.Builder
to create a request.- Returns:
- Result of the DescribeApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAppImageConfig
default DescribeAppImageConfigResponse describeAppImageConfig(DescribeAppImageConfigRequest describeAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an AppImageConfig.
- Parameters:
describeAppImageConfigRequest
-- Returns:
- Result of the DescribeAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAppImageConfig
default DescribeAppImageConfigResponse describeAppImageConfig(Consumer<DescribeAppImageConfigRequest.Builder> describeAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an AppImageConfig.
This is a convenience which creates an instance of the
DescribeAppImageConfigRequest.Builder
avoiding the need to create one manually viaDescribeAppImageConfigRequest.builder()
- Parameters:
describeAppImageConfigRequest
- AConsumer
that will call methods onDescribeAppImageConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeArtifact
default DescribeArtifactResponse describeArtifact(DescribeArtifactRequest describeArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an artifact.
- Parameters:
describeArtifactRequest
-- Returns:
- Result of the DescribeArtifact operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeArtifact
default DescribeArtifactResponse describeArtifact(Consumer<DescribeArtifactRequest.Builder> describeArtifactRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an artifact.
This is a convenience which creates an instance of the
DescribeArtifactRequest.Builder
avoiding the need to create one manually viaDescribeArtifactRequest.builder()
- Parameters:
describeArtifactRequest
- AConsumer
that will call methods onDescribeArtifactRequest.Builder
to create a request.- Returns:
- Result of the DescribeArtifact operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAutoMLJob
default DescribeAutoMlJobResponse describeAutoMLJob(DescribeAutoMlJobRequest describeAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about an AutoML job created by calling CreateAutoMLJob.
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by
DescribeAutoMLJob
.- Parameters:
describeAutoMlJobRequest
-- Returns:
- Result of the DescribeAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAutoMLJob
default DescribeAutoMlJobResponse describeAutoMLJob(Consumer<DescribeAutoMlJobRequest.Builder> describeAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeAutoMlJobRequest.builder()
- Parameters:
describeAutoMlJobRequest
- AConsumer
that will call methods onDescribeAutoMlJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAutoMLJobV2
default DescribeAutoMlJobV2Response describeAutoMLJobV2(DescribeAutoMlJobV2Request describeAutoMlJobV2Request) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
- Parameters:
describeAutoMlJobV2Request
-- Returns:
- Result of the DescribeAutoMLJobV2 operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAutoMLJobV2
default DescribeAutoMlJobV2Response describeAutoMLJobV2(Consumer<DescribeAutoMlJobV2Request.Builder> describeAutoMlJobV2Request) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeAutoMlJobV2Request.builder()
- Parameters:
describeAutoMlJobV2Request
- AConsumer
that will call methods onDescribeAutoMlJobV2Request.Builder
to create a request.- Returns:
- Result of the DescribeAutoMLJobV2 operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCluster
default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves information of a SageMaker HyperPod cluster.
- Parameters:
describeClusterRequest
-- Returns:
- Result of the DescribeCluster operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCluster
default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeClusterRequest.builder()
- Parameters:
describeClusterRequest
- AConsumer
that will call methods onDescribeClusterRequest.Builder
to create a request.- Returns:
- Result of the DescribeCluster operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeClusterNode
default DescribeClusterNodeResponse describeClusterNode(DescribeClusterNodeRequest describeClusterNodeRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.
- Parameters:
describeClusterNodeRequest
-- Returns:
- Result of the DescribeClusterNode operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeClusterNode
default DescribeClusterNodeResponse describeClusterNode(Consumer<DescribeClusterNodeRequest.Builder> describeClusterNodeRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves information of a node (also called a instance 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 viaDescribeClusterNodeRequest.builder()
- Parameters:
describeClusterNodeRequest
- AConsumer
that will call methods onDescribeClusterNodeRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterNode operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeClusterSchedulerConfig
default DescribeClusterSchedulerConfigResponse describeClusterSchedulerConfig(DescribeClusterSchedulerConfigRequest describeClusterSchedulerConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
- Parameters:
describeClusterSchedulerConfigRequest
-- Returns:
- Result of the DescribeClusterSchedulerConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeClusterSchedulerConfig
default DescribeClusterSchedulerConfigResponse describeClusterSchedulerConfig(Consumer<DescribeClusterSchedulerConfigRequest.Builder> describeClusterSchedulerConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
This is a convenience which creates an instance of the
DescribeClusterSchedulerConfigRequest.Builder
avoiding the need to create one manually viaDescribeClusterSchedulerConfigRequest.builder()
- Parameters:
describeClusterSchedulerConfigRequest
- AConsumer
that will call methods onDescribeClusterSchedulerConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusterSchedulerConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCodeRepository
default DescribeCodeRepositoryResponse describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets details about the specified Git repository.
- Parameters:
describeCodeRepositoryRequest
-- Returns:
- Result of the DescribeCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCodeRepository
default DescribeCodeRepositoryResponse describeCodeRepository(Consumer<DescribeCodeRepositoryRequest.Builder> describeCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeCodeRepositoryRequest.builder()
- Parameters:
describeCodeRepositoryRequest
- AConsumer
that will call methods onDescribeCodeRepositoryRequest.Builder
to create a request.- Returns:
- Result of the DescribeCodeRepository operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCompilationJob
default DescribeCompilationJobResponse describeCompilationJob(DescribeCompilationJobRequest describeCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeCompilationJob
default DescribeCompilationJobResponse describeCompilationJob(Consumer<DescribeCompilationJobRequest.Builder> describeCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeCompilationJobRequest.builder()
- Parameters:
describeCompilationJobRequest
- AConsumer
that will call methods onDescribeCompilationJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeComputeQuota
default DescribeComputeQuotaResponse describeComputeQuota(DescribeComputeQuotaRequest describeComputeQuotaRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Description of the compute allocation definition.
- Parameters:
describeComputeQuotaRequest
-- Returns:
- Result of the DescribeComputeQuota operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeComputeQuota
default DescribeComputeQuotaResponse describeComputeQuota(Consumer<DescribeComputeQuotaRequest.Builder> describeComputeQuotaRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Description of the compute allocation definition.
This is a convenience which creates an instance of the
DescribeComputeQuotaRequest.Builder
avoiding the need to create one manually viaDescribeComputeQuotaRequest.builder()
- Parameters:
describeComputeQuotaRequest
- AConsumer
that will call methods onDescribeComputeQuotaRequest.Builder
to create a request.- Returns:
- Result of the DescribeComputeQuota operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeContext
default DescribeContextResponse describeContext(DescribeContextRequest describeContextRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a context.
- Parameters:
describeContextRequest
-- Returns:
- Result of the DescribeContext operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeContext
default DescribeContextResponse describeContext(Consumer<DescribeContextRequest.Builder> describeContextRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a context.
This is a convenience which creates an instance of the
DescribeContextRequest.Builder
avoiding the need to create one manually viaDescribeContextRequest.builder()
- Parameters:
describeContextRequest
- AConsumer
that will call methods onDescribeContextRequest.Builder
to create a request.- Returns:
- Result of the DescribeContext operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDataQualityJobDefinition
default DescribeDataQualityJobDefinitionResponse describeDataQualityJobDefinition(DescribeDataQualityJobDefinitionRequest describeDataQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets the details of a data quality monitoring job definition.
- Parameters:
describeDataQualityJobDefinitionRequest
-- Returns:
- Result of the DescribeDataQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDataQualityJobDefinition
default DescribeDataQualityJobDefinitionResponse describeDataQualityJobDefinition(Consumer<DescribeDataQualityJobDefinitionRequest.Builder> describeDataQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeDataQualityJobDefinitionRequest.builder()
- Parameters:
describeDataQualityJobDefinitionRequest
- AConsumer
that will call methods onDescribeDataQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDevice
default DescribeDeviceResponse describeDevice(DescribeDeviceRequest describeDeviceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the device.
- Parameters:
describeDeviceRequest
-- Returns:
- Result of the DescribeDevice operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDevice
default DescribeDeviceResponse describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the device.
This is a convenience which creates an instance of the
DescribeDeviceRequest.Builder
avoiding the need to create one manually viaDescribeDeviceRequest.builder()
- Parameters:
describeDeviceRequest
- AConsumer
that will call methods onDescribeDeviceRequest.Builder
to create a request.- Returns:
- Result of the DescribeDevice operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDeviceFleet
default DescribeDeviceFleetResponse describeDeviceFleet(DescribeDeviceFleetRequest describeDeviceFleetRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
A description of the fleet the device belongs to.
- Parameters:
describeDeviceFleetRequest
-- Returns:
- Result of the DescribeDeviceFleet operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDeviceFleet
default DescribeDeviceFleetResponse describeDeviceFleet(Consumer<DescribeDeviceFleetRequest.Builder> describeDeviceFleetRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeDeviceFleetRequest.builder()
- Parameters:
describeDeviceFleetRequest
- AConsumer
that will call methods onDescribeDeviceFleetRequest.Builder
to create a request.- Returns:
- Result of the DescribeDeviceFleet operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDomain
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
The description of the domain.
- Parameters:
describeDomainRequest
-- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDomain
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
The description of the domain.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builder
avoiding the need to create one manually viaDescribeDomainRequest.builder()
- Parameters:
describeDomainRequest
- AConsumer
that will call methods onDescribeDomainRequest.Builder
to create a request.- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEdgeDeploymentPlan
default DescribeEdgeDeploymentPlanResponse describeEdgeDeploymentPlan(DescribeEdgeDeploymentPlanRequest describeEdgeDeploymentPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an edge deployment plan with deployment status per stage.
- Parameters:
describeEdgeDeploymentPlanRequest
-- Returns:
- Result of the DescribeEdgeDeploymentPlan operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEdgeDeploymentPlan
default DescribeEdgeDeploymentPlanResponse describeEdgeDeploymentPlan(Consumer<DescribeEdgeDeploymentPlanRequest.Builder> describeEdgeDeploymentPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeEdgeDeploymentPlanRequest.builder()
- Parameters:
describeEdgeDeploymentPlanRequest
- AConsumer
that will call methods onDescribeEdgeDeploymentPlanRequest.Builder
to create a request.- Returns:
- Result of the DescribeEdgeDeploymentPlan operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEdgePackagingJob
default DescribeEdgePackagingJobResponse describeEdgePackagingJob(DescribeEdgePackagingJobRequest describeEdgePackagingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
A description of edge packaging jobs.
- Parameters:
describeEdgePackagingJobRequest
-- Returns:
- Result of the DescribeEdgePackagingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEdgePackagingJob
default DescribeEdgePackagingJobResponse describeEdgePackagingJob(Consumer<DescribeEdgePackagingJobRequest.Builder> describeEdgePackagingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeEdgePackagingJobRequest.builder()
- Parameters:
describeEdgePackagingJobRequest
- AConsumer
that will call methods onDescribeEdgePackagingJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeEdgePackagingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the description of an endpoint.
- Parameters:
describeEndpointRequest
-- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeEndpointRequest.builder()
- Parameters:
describeEndpointRequest
- AConsumer
that will call methods onDescribeEndpointRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEndpointConfig
default DescribeEndpointConfigResponse describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.- Parameters:
describeEndpointConfigRequest
-- Returns:
- Result of the DescribeEndpointConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEndpointConfig
default DescribeEndpointConfigResponse describeEndpointConfig(Consumer<DescribeEndpointConfigRequest.Builder> describeEndpointConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeEndpointConfigRequest.builder()
- Parameters:
describeEndpointConfigRequest
- AConsumer
that will call methods onDescribeEndpointConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpointConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeExperiment
default DescribeExperimentResponse describeExperiment(DescribeExperimentRequest describeExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides a list of an experiment's properties.
- Parameters:
describeExperimentRequest
-- Returns:
- Result of the DescribeExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeExperiment
default DescribeExperimentResponse describeExperiment(Consumer<DescribeExperimentRequest.Builder> describeExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeExperimentRequest.builder()
- Parameters:
describeExperimentRequest
- AConsumer
that will call methods onDescribeExperimentRequest.Builder
to create a request.- Returns:
- Result of the DescribeExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFeatureGroup
default DescribeFeatureGroupResponse describeFeatureGroup(DescribeFeatureGroupRequest describeFeatureGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Use this operation to describe a
FeatureGroup
. The response includes information on the creation time,FeatureGroup
name, the unique identifier for eachFeatureGroup
, and more.- Parameters:
describeFeatureGroupRequest
-- Returns:
- Result of the DescribeFeatureGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFeatureGroup
default DescribeFeatureGroupResponse describeFeatureGroup(Consumer<DescribeFeatureGroupRequest.Builder> describeFeatureGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Use this operation to describe a
FeatureGroup
. The response includes information on the creation time,FeatureGroup
name, the unique identifier for eachFeatureGroup
, and more.
This is a convenience which creates an instance of the
DescribeFeatureGroupRequest.Builder
avoiding the need to create one manually viaDescribeFeatureGroupRequest.builder()
- Parameters:
describeFeatureGroupRequest
- AConsumer
that will call methods onDescribeFeatureGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeFeatureGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFeatureMetadata
default DescribeFeatureMetadataResponse describeFeatureMetadata(DescribeFeatureMetadataRequest describeFeatureMetadataRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Shows the metadata for a feature within a feature group.
- Parameters:
describeFeatureMetadataRequest
-- Returns:
- Result of the DescribeFeatureMetadata operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFeatureMetadata
default DescribeFeatureMetadataResponse describeFeatureMetadata(Consumer<DescribeFeatureMetadataRequest.Builder> describeFeatureMetadataRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeFeatureMetadataRequest.builder()
- Parameters:
describeFeatureMetadataRequest
- AConsumer
that will call methods onDescribeFeatureMetadataRequest.Builder
to create a request.- Returns:
- Result of the DescribeFeatureMetadata operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFlowDefinition
default DescribeFlowDefinitionResponse describeFlowDefinition(DescribeFlowDefinitionRequest describeFlowDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about the specified flow definition.
- Parameters:
describeFlowDefinitionRequest
-- Returns:
- Result of the DescribeFlowDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeFlowDefinition
default DescribeFlowDefinitionResponse describeFlowDefinition(Consumer<DescribeFlowDefinitionRequest.Builder> describeFlowDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeFlowDefinitionRequest.builder()
- Parameters:
describeFlowDefinitionRequest
- AConsumer
that will call methods onDescribeFlowDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeFlowDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHub
default DescribeHubResponse describeHub(DescribeHubRequest describeHubRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a hub.
- Parameters:
describeHubRequest
-- Returns:
- Result of the DescribeHub operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHub
default DescribeHubResponse describeHub(Consumer<DescribeHubRequest.Builder> describeHubRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a hub.
This is a convenience which creates an instance of the
DescribeHubRequest.Builder
avoiding the need to create one manually viaDescribeHubRequest.builder()
- Parameters:
describeHubRequest
- AConsumer
that will call methods onDescribeHubRequest.Builder
to create a request.- Returns:
- Result of the DescribeHub operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHubContent
default DescribeHubContentResponse describeHubContent(DescribeHubContentRequest describeHubContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describe the content of a hub.
- Parameters:
describeHubContentRequest
-- Returns:
- Result of the DescribeHubContent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHubContent
default DescribeHubContentResponse describeHubContent(Consumer<DescribeHubContentRequest.Builder> describeHubContentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describe the content of a hub.
This is a convenience which creates an instance of the
DescribeHubContentRequest.Builder
avoiding the need to create one manually viaDescribeHubContentRequest.builder()
- Parameters:
describeHubContentRequest
- AConsumer
that will call methods onDescribeHubContentRequest.Builder
to create a request.- Returns:
- Result of the DescribeHubContent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHumanTaskUi
default DescribeHumanTaskUiResponse describeHumanTaskUi(DescribeHumanTaskUiRequest describeHumanTaskUiRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about the requested human task user interface (worker task template).
- Parameters:
describeHumanTaskUiRequest
-- Returns:
- Result of the DescribeHumanTaskUi operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHumanTaskUi
default DescribeHumanTaskUiResponse describeHumanTaskUi(Consumer<DescribeHumanTaskUiRequest.Builder> describeHumanTaskUiRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeHumanTaskUiRequest.builder()
- Parameters:
describeHumanTaskUiRequest
- AConsumer
that will call methods onDescribeHumanTaskUiRequest.Builder
to create a request.- Returns:
- Result of the DescribeHumanTaskUi operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHyperParameterTuningJob
default DescribeHyperParameterTuningJobResponse describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeHyperParameterTuningJob
default DescribeHyperParameterTuningJobResponse describeHyperParameterTuningJob(Consumer<DescribeHyperParameterTuningJobRequest.Builder> describeHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeHyperParameterTuningJobRequest.builder()
- Parameters:
describeHyperParameterTuningJobRequest
- AConsumer
that will call methods onDescribeHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeImage
default DescribeImageResponse describeImage(DescribeImageRequest describeImageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a SageMaker AI image.
- Parameters:
describeImageRequest
-- Returns:
- Result of the DescribeImage operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeImage
default DescribeImageResponse describeImage(Consumer<DescribeImageRequest.Builder> describeImageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a SageMaker AI image.
This is a convenience which creates an instance of the
DescribeImageRequest.Builder
avoiding the need to create one manually viaDescribeImageRequest.builder()
- Parameters:
describeImageRequest
- AConsumer
that will call methods onDescribeImageRequest.Builder
to create a request.- Returns:
- Result of the DescribeImage operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeImageVersion
default DescribeImageVersionResponse describeImageVersion(DescribeImageVersionRequest describeImageVersionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a version of a SageMaker AI image.
- Parameters:
describeImageVersionRequest
-- Returns:
- Result of the DescribeImageVersion operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeImageVersion
default DescribeImageVersionResponse describeImageVersion(Consumer<DescribeImageVersionRequest.Builder> describeImageVersionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes a version of a SageMaker AI image.
This is a convenience which creates an instance of the
DescribeImageVersionRequest.Builder
avoiding the need to create one manually viaDescribeImageVersionRequest.builder()
- Parameters:
describeImageVersionRequest
- AConsumer
that will call methods onDescribeImageVersionRequest.Builder
to create a request.- Returns:
- Result of the DescribeImageVersion operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceComponent
default DescribeInferenceComponentResponse describeInferenceComponent(DescribeInferenceComponentRequest describeInferenceComponentRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns information about an inference component.
- Parameters:
describeInferenceComponentRequest
-- Returns:
- Result of the DescribeInferenceComponent operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceComponent
default DescribeInferenceComponentResponse describeInferenceComponent(Consumer<DescribeInferenceComponentRequest.Builder> describeInferenceComponentRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeInferenceComponentRequest.builder()
- Parameters:
describeInferenceComponentRequest
- AConsumer
that will call methods onDescribeInferenceComponentRequest.Builder
to create a request.- Returns:
- Result of the DescribeInferenceComponent operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceExperiment
default DescribeInferenceExperimentResponse describeInferenceExperiment(DescribeInferenceExperimentRequest describeInferenceExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns details about an inference experiment.
- Parameters:
describeInferenceExperimentRequest
-- Returns:
- Result of the DescribeInferenceExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceExperiment
default DescribeInferenceExperimentResponse describeInferenceExperiment(Consumer<DescribeInferenceExperimentRequest.Builder> describeInferenceExperimentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeInferenceExperimentRequest.builder()
- Parameters:
describeInferenceExperimentRequest
- AConsumer
that will call methods onDescribeInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the DescribeInferenceExperiment operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceRecommendationsJob
default DescribeInferenceRecommendationsJobResponse describeInferenceRecommendationsJob(DescribeInferenceRecommendationsJobRequest describeInferenceRecommendationsJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
- Parameters:
describeInferenceRecommendationsJobRequest
-- Returns:
- Result of the DescribeInferenceRecommendationsJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInferenceRecommendationsJob
default DescribeInferenceRecommendationsJobResponse describeInferenceRecommendationsJob(Consumer<DescribeInferenceRecommendationsJobRequest.Builder> describeInferenceRecommendationsJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeInferenceRecommendationsJobRequest.builder()
- Parameters:
describeInferenceRecommendationsJobRequest
- AConsumer
that will call methods onDescribeInferenceRecommendationsJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeInferenceRecommendationsJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLabelingJob
default DescribeLabelingJobResponse describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets information about a labeling job.
- Parameters:
describeLabelingJobRequest
-- Returns:
- Result of the DescribeLabelingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLabelingJob
default DescribeLabelingJobResponse describeLabelingJob(Consumer<DescribeLabelingJobRequest.Builder> describeLabelingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeLabelingJobRequest.builder()
- Parameters:
describeLabelingJobRequest
- AConsumer
that will call methods onDescribeLabelingJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeLabelingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLineageGroup
default DescribeLineageGroupResponse describeLineageGroup(DescribeLineageGroupRequest describeLineageGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeLineageGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLineageGroup
default DescribeLineageGroupResponse describeLineageGroup(Consumer<DescribeLineageGroupRequest.Builder> describeLineageGroupRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeLineageGroupRequest.builder()
- Parameters:
describeLineageGroupRequest
- AConsumer
that will call methods onDescribeLineageGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeLineageGroup operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeMlflowTrackingServer
default DescribeMlflowTrackingServerResponse describeMlflowTrackingServer(DescribeMlflowTrackingServerRequest describeMlflowTrackingServerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about an MLflow Tracking Server.
- Parameters:
describeMlflowTrackingServerRequest
-- Returns:
- Result of the DescribeMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeMlflowTrackingServer
default DescribeMlflowTrackingServerResponse describeMlflowTrackingServer(Consumer<DescribeMlflowTrackingServerRequest.Builder> describeMlflowTrackingServerRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about an MLflow Tracking Server.
This is a convenience which creates an instance of the
DescribeMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaDescribeMlflowTrackingServerRequest.builder()
- Parameters:
describeMlflowTrackingServerRequest
- AConsumer
that will call methods onDescribeMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the DescribeMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModel
default DescribeModelResponse describeModel(DescribeModelRequest describeModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
Describes a model that you created using the
CreateModel
API.- Parameters:
describeModelRequest
-- Returns:
- Result of the DescribeModel operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModel
default DescribeModelResponse describeModel(Consumer<DescribeModelRequest.Builder> describeModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelRequest.builder()
- Parameters:
describeModelRequest
- AConsumer
that will call methods onDescribeModelRequest.Builder
to create a request.- Returns:
- Result of the DescribeModel operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelBiasJobDefinition
default DescribeModelBiasJobDefinitionResponse describeModelBiasJobDefinition(DescribeModelBiasJobDefinitionRequest describeModelBiasJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a description of a model bias job definition.
- Parameters:
describeModelBiasJobDefinitionRequest
-- Returns:
- Result of the DescribeModelBiasJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelBiasJobDefinition
default DescribeModelBiasJobDefinitionResponse describeModelBiasJobDefinition(Consumer<DescribeModelBiasJobDefinitionRequest.Builder> describeModelBiasJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelBiasJobDefinitionRequest.builder()
- Parameters:
describeModelBiasJobDefinitionRequest
- AConsumer
that will call methods onDescribeModelBiasJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelBiasJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelCard
default DescribeModelCardResponse describeModelCard(DescribeModelCardRequest describeModelCardRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.
- Parameters:
describeModelCardRequest
-- Returns:
- Result of the DescribeModelCard operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelCard
default DescribeModelCardResponse describeModelCard(Consumer<DescribeModelCardRequest.Builder> describeModelCardRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelCardRequest.builder()
- Parameters:
describeModelCardRequest
- AConsumer
that will call methods onDescribeModelCardRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelCard operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelCardExportJob
default DescribeModelCardExportJobResponse describeModelCardExportJob(DescribeModelCardExportJobRequest describeModelCardExportJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes an Amazon SageMaker Model Card export job.
- Parameters:
describeModelCardExportJobRequest
-- Returns:
- Result of the DescribeModelCardExportJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelCardExportJob
default DescribeModelCardExportJobResponse describeModelCardExportJob(Consumer<DescribeModelCardExportJobRequest.Builder> describeModelCardExportJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelCardExportJobRequest.builder()
- Parameters:
describeModelCardExportJobRequest
- AConsumer
that will call methods onDescribeModelCardExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelCardExportJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelExplainabilityJobDefinition
default DescribeModelExplainabilityJobDefinitionResponse describeModelExplainabilityJobDefinition(DescribeModelExplainabilityJobDefinitionRequest describeModelExplainabilityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a description of a model explainability job definition.
- Parameters:
describeModelExplainabilityJobDefinitionRequest
-- Returns:
- Result of the DescribeModelExplainabilityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelExplainabilityJobDefinition
default DescribeModelExplainabilityJobDefinitionResponse describeModelExplainabilityJobDefinition(Consumer<DescribeModelExplainabilityJobDefinitionRequest.Builder> describeModelExplainabilityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelExplainabilityJobDefinitionRequest.builder()
- Parameters:
describeModelExplainabilityJobDefinitionRequest
- AConsumer
that will call methods onDescribeModelExplainabilityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelExplainabilityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelPackage
default DescribeModelPackageResponse describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API.
To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
- Parameters:
describeModelPackageRequest
-- Returns:
- Result of the DescribeModelPackage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelPackage
default DescribeModelPackageResponse describeModelPackage(Consumer<DescribeModelPackageRequest.Builder> describeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.
If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API.
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 viaDescribeModelPackageRequest.builder()
- Parameters:
describeModelPackageRequest
- AConsumer
that will call methods onDescribeModelPackageRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelPackage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelPackageGroup
default DescribeModelPackageGroupResponse describeModelPackageGroup(DescribeModelPackageGroupRequest describeModelPackageGroupRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a description for the specified model group.
- Parameters:
describeModelPackageGroupRequest
-- Returns:
- Result of the DescribeModelPackageGroup operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelPackageGroup
default DescribeModelPackageGroupResponse describeModelPackageGroup(Consumer<DescribeModelPackageGroupRequest.Builder> describeModelPackageGroupRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelPackageGroupRequest.builder()
- Parameters:
describeModelPackageGroupRequest
- AConsumer
that will call methods onDescribeModelPackageGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelPackageGroup operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelQualityJobDefinition
default DescribeModelQualityJobDefinitionResponse describeModelQualityJobDefinition(DescribeModelQualityJobDefinitionRequest describeModelQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a description of a model quality job definition.
- Parameters:
describeModelQualityJobDefinitionRequest
-- Returns:
- Result of the DescribeModelQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeModelQualityJobDefinition
default DescribeModelQualityJobDefinitionResponse describeModelQualityJobDefinition(Consumer<DescribeModelQualityJobDefinitionRequest.Builder> describeModelQualityJobDefinitionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeModelQualityJobDefinitionRequest.builder()
- Parameters:
describeModelQualityJobDefinitionRequest
- AConsumer
that will call methods onDescribeModelQualityJobDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeModelQualityJobDefinition operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeMonitoringSchedule
default DescribeMonitoringScheduleResponse describeMonitoringSchedule(DescribeMonitoringScheduleRequest describeMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the schedule for a monitoring job.
- Parameters:
describeMonitoringScheduleRequest
-- Returns:
- Result of the DescribeMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeMonitoringSchedule
default DescribeMonitoringScheduleResponse describeMonitoringSchedule(Consumer<DescribeMonitoringScheduleRequest.Builder> describeMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeMonitoringScheduleRequest.builder()
- Parameters:
describeMonitoringScheduleRequest
- AConsumer
that will call methods onDescribeMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the DescribeMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeNotebookInstance
default DescribeNotebookInstanceResponse describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns information about a notebook instance.
- Parameters:
describeNotebookInstanceRequest
-- Returns:
- Result of the DescribeNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeNotebookInstance
default DescribeNotebookInstanceResponse describeNotebookInstance(Consumer<DescribeNotebookInstanceRequest.Builder> describeNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeNotebookInstanceRequest.builder()
- Parameters:
describeNotebookInstanceRequest
- AConsumer
that will call methods onDescribeNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the DescribeNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeNotebookInstanceLifecycleConfig
default DescribeNotebookInstanceLifecycleConfigResponse describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest describeNotebookInstanceLifecycleConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeNotebookInstanceLifecycleConfig
default DescribeNotebookInstanceLifecycleConfigResponse describeNotebookInstanceLifecycleConfig(Consumer<DescribeNotebookInstanceLifecycleConfigRequest.Builder> describeNotebookInstanceLifecycleConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeNotebookInstanceLifecycleConfigRequest.builder()
- Parameters:
describeNotebookInstanceLifecycleConfigRequest
- AConsumer
that will call methods onDescribeNotebookInstanceLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeOptimizationJob
default DescribeOptimizationJobResponse describeOptimizationJob(DescribeOptimizationJobRequest describeOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides the properties of the specified optimization job.
- Parameters:
describeOptimizationJobRequest
-- Returns:
- Result of the DescribeOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeOptimizationJob
default DescribeOptimizationJobResponse describeOptimizationJob(Consumer<DescribeOptimizationJobRequest.Builder> describeOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides the properties of the specified optimization job.
This is a convenience which creates an instance of the
DescribeOptimizationJobRequest.Builder
avoiding the need to create one manually viaDescribeOptimizationJobRequest.builder()
- Parameters:
describeOptimizationJobRequest
- AConsumer
that will call methods onDescribeOptimizationJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePartnerApp
default DescribePartnerAppResponse describePartnerApp(DescribePartnerAppRequest describePartnerAppRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets information about a SageMaker Partner AI App.
- Parameters:
describePartnerAppRequest
-- Returns:
- Result of the DescribePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePartnerApp
default DescribePartnerAppResponse describePartnerApp(Consumer<DescribePartnerAppRequest.Builder> describePartnerAppRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets information about a SageMaker Partner AI App.
This is a convenience which creates an instance of the
DescribePartnerAppRequest.Builder
avoiding the need to create one manually viaDescribePartnerAppRequest.builder()
- Parameters:
describePartnerAppRequest
- AConsumer
that will call methods onDescribePartnerAppRequest.Builder
to create a request.- Returns:
- Result of the DescribePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipeline
default DescribePipelineResponse describePipeline(DescribePipelineRequest describePipelineRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the details of a pipeline.
- Parameters:
describePipelineRequest
-- Returns:
- Result of the DescribePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipeline
default DescribePipelineResponse describePipeline(Consumer<DescribePipelineRequest.Builder> describePipelineRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribePipelineRequest.builder()
- Parameters:
describePipelineRequest
- AConsumer
that will call methods onDescribePipelineRequest.Builder
to create a request.- Returns:
- Result of the DescribePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipelineDefinitionForExecution
default DescribePipelineDefinitionForExecutionResponse describePipelineDefinitionForExecution(DescribePipelineDefinitionForExecutionRequest describePipelineDefinitionForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the details of an execution's pipeline definition.
- Parameters:
describePipelineDefinitionForExecutionRequest
-- Returns:
- Result of the DescribePipelineDefinitionForExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipelineDefinitionForExecution
default DescribePipelineDefinitionForExecutionResponse describePipelineDefinitionForExecution(Consumer<DescribePipelineDefinitionForExecutionRequest.Builder> describePipelineDefinitionForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribePipelineDefinitionForExecutionRequest.builder()
- Parameters:
describePipelineDefinitionForExecutionRequest
- AConsumer
that will call methods onDescribePipelineDefinitionForExecutionRequest.Builder
to create a request.- Returns:
- Result of the DescribePipelineDefinitionForExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipelineExecution
default DescribePipelineExecutionResponse describePipelineExecution(DescribePipelineExecutionRequest describePipelineExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the details of a pipeline execution.
- Parameters:
describePipelineExecutionRequest
-- Returns:
- Result of the DescribePipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describePipelineExecution
default DescribePipelineExecutionResponse describePipelineExecution(Consumer<DescribePipelineExecutionRequest.Builder> describePipelineExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribePipelineExecutionRequest.builder()
- Parameters:
describePipelineExecutionRequest
- AConsumer
that will call methods onDescribePipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the DescribePipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeProcessingJob
default DescribeProcessingJobResponse describeProcessingJob(DescribeProcessingJobRequest describeProcessingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns a description of a processing job.
- Parameters:
describeProcessingJobRequest
-- Returns:
- Result of the DescribeProcessingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeProcessingJob
default DescribeProcessingJobResponse describeProcessingJob(Consumer<DescribeProcessingJobRequest.Builder> describeProcessingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeProcessingJobRequest.builder()
- Parameters:
describeProcessingJobRequest
- AConsumer
that will call methods onDescribeProcessingJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeProcessingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeProject
default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest) throws AwsServiceException, SdkClientException, SageMakerException
Describes the details of a project.
- Parameters:
describeProjectRequest
-- Returns:
- Result of the DescribeProject operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeProject
default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeProjectRequest.builder()
- Parameters:
describeProjectRequest
- AConsumer
that will call methods onDescribeProjectRequest.Builder
to create a request.- Returns:
- Result of the DescribeProject operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeSpace
default DescribeSpaceResponse describeSpace(DescribeSpaceRequest describeSpaceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the space.
- Parameters:
describeSpaceRequest
-- Returns:
- Result of the DescribeSpace operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeSpace
default DescribeSpaceResponse describeSpace(Consumer<DescribeSpaceRequest.Builder> describeSpaceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the space.
This is a convenience which creates an instance of the
DescribeSpaceRequest.Builder
avoiding the need to create one manually viaDescribeSpaceRequest.builder()
- Parameters:
describeSpaceRequest
- AConsumer
that will call methods onDescribeSpaceRequest.Builder
to create a request.- Returns:
- Result of the DescribeSpace operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStudioLifecycleConfig
default DescribeStudioLifecycleConfigResponse describeStudioLifecycleConfig(DescribeStudioLifecycleConfigRequest describeStudioLifecycleConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
- Parameters:
describeStudioLifecycleConfigRequest
-- Returns:
- Result of the DescribeStudioLifecycleConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStudioLifecycleConfig
default DescribeStudioLifecycleConfigResponse describeStudioLifecycleConfig(Consumer<DescribeStudioLifecycleConfigRequest.Builder> describeStudioLifecycleConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Describes the Amazon SageMaker AI Studio Lifecycle Configuration.
This is a convenience which creates an instance of the
DescribeStudioLifecycleConfigRequest.Builder
avoiding the need to create one manually viaDescribeStudioLifecycleConfigRequest.builder()
- Parameters:
describeStudioLifecycleConfigRequest
- AConsumer
that will call methods onDescribeStudioLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the DescribeStudioLifecycleConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeSubscribedWorkteam
default DescribeSubscribedWorkteamResponse describeSubscribedWorkteam(DescribeSubscribedWorkteamRequest describeSubscribedWorkteamRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeSubscribedWorkteam operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeSubscribedWorkteam
default DescribeSubscribedWorkteamResponse describeSubscribedWorkteam(Consumer<DescribeSubscribedWorkteamRequest.Builder> describeSubscribedWorkteamRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeSubscribedWorkteamRequest.builder()
- Parameters:
describeSubscribedWorkteamRequest
- AConsumer
that will call methods onDescribeSubscribedWorkteamRequest.Builder
to create a request.- Returns:
- Result of the DescribeSubscribedWorkteam operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrainingJob
default DescribeTrainingJobResponse describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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
isFailed
and, depending on theFailureReason
, attributes likeTrainingStartTime
,TrainingTimeInSeconds
,TrainingEndTime
, andBillableTimeInSeconds
may not be present in the response.- Parameters:
describeTrainingJobRequest
-- Returns:
- Result of the DescribeTrainingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrainingJob
default DescribeTrainingJobResponse describeTrainingJob(Consumer<DescribeTrainingJobRequest.Builder> describeTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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
isFailed
and, depending on theFailureReason
, attributes likeTrainingStartTime
,TrainingTimeInSeconds
,TrainingEndTime
, andBillableTimeInSeconds
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 viaDescribeTrainingJobRequest.builder()
- Parameters:
describeTrainingJobRequest
- AConsumer
that will call methods onDescribeTrainingJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrainingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrainingPlan
default DescribeTrainingPlanResponse describeTrainingPlan(DescribeTrainingPlanRequest describeTrainingPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves detailed information about a specific training plan.
- Parameters:
describeTrainingPlanRequest
-- Returns:
- Result of the DescribeTrainingPlan operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrainingPlan
default DescribeTrainingPlanResponse describeTrainingPlan(Consumer<DescribeTrainingPlanRequest.Builder> describeTrainingPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves detailed information about a specific training plan.
This is a convenience which creates an instance of the
DescribeTrainingPlanRequest.Builder
avoiding the need to create one manually viaDescribeTrainingPlanRequest.builder()
- Parameters:
describeTrainingPlanRequest
- AConsumer
that will call methods onDescribeTrainingPlanRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrainingPlan operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTransformJob
default DescribeTransformJobResponse describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about a transform job.
- Parameters:
describeTransformJobRequest
-- Returns:
- Result of the DescribeTransformJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTransformJob
default DescribeTransformJobResponse describeTransformJob(Consumer<DescribeTransformJobRequest.Builder> describeTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeTransformJobRequest.builder()
- Parameters:
describeTransformJobRequest
- AConsumer
that will call methods onDescribeTransformJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeTransformJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrial
default DescribeTrialResponse describeTrial(DescribeTrialRequest describeTrialRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides a list of a trial's properties.
- Parameters:
describeTrialRequest
-- Returns:
- Result of the DescribeTrial operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrial
default DescribeTrialResponse describeTrial(Consumer<DescribeTrialRequest.Builder> describeTrialRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeTrialRequest.builder()
- Parameters:
describeTrialRequest
- AConsumer
that will call methods onDescribeTrialRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrial operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrialComponent
default DescribeTrialComponentResponse describeTrialComponent(DescribeTrialComponentRequest describeTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Provides a list of a trials component's properties.
- Parameters:
describeTrialComponentRequest
-- Returns:
- Result of the DescribeTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeTrialComponent
default DescribeTrialComponentResponse describeTrialComponent(Consumer<DescribeTrialComponentRequest.Builder> describeTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeTrialComponentRequest.builder()
- Parameters:
describeTrialComponentRequest
- AConsumer
that will call methods onDescribeTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the DescribeTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeUserProfile
default DescribeUserProfileResponse describeUserProfile(DescribeUserProfileRequest describeUserProfileRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Describes a user profile. For more information, see
CreateUserProfile
.- Parameters:
describeUserProfileRequest
-- Returns:
- Result of the DescribeUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
describeUserProfile
default DescribeUserProfileResponse describeUserProfile(Consumer<DescribeUserProfileRequest.Builder> describeUserProfileRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeUserProfileRequest.builder()
- Parameters:
describeUserProfileRequest
- AConsumer
that will call methods onDescribeUserProfileRequest.Builder
to create a request.- Returns:
- Result of the DescribeUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
describeWorkforce
default DescribeWorkforceResponse describeWorkforce(DescribeWorkforceRequest describeWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the DescribeWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeWorkforce
default DescribeWorkforceResponse describeWorkforce(Consumer<DescribeWorkforceRequest.Builder> describeWorkforceRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDescribeWorkforceRequest.builder()
- Parameters:
describeWorkforceRequest
- AConsumer
that will call methods onDescribeWorkforceRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkforce operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeWorkteam
default DescribeWorkteamResponse describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
- Parameters:
describeWorkteamRequest
-- Returns:
- Result of the DescribeWorkteam operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeWorkteam
default DescribeWorkteamResponse describeWorkteam(Consumer<DescribeWorkteamRequest.Builder> describeWorkteamRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets information about a specific work team. You can see information such as the creation 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 viaDescribeWorkteamRequest.builder()
- Parameters:
describeWorkteamRequest
- AConsumer
that will call methods onDescribeWorkteamRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkteam operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disableSagemakerServicecatalogPortfolio
default DisableSagemakerServicecatalogPortfolioResponse disableSagemakerServicecatalogPortfolio(DisableSagemakerServicecatalogPortfolioRequest disableSagemakerServicecatalogPortfolioRequest) throws AwsServiceException, SdkClientException, SageMakerException
Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
- Parameters:
disableSagemakerServicecatalogPortfolioRequest
-- Returns:
- Result of the DisableSagemakerServicecatalogPortfolio operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disableSagemakerServicecatalogPortfolio
default DisableSagemakerServicecatalogPortfolioResponse disableSagemakerServicecatalogPortfolio(Consumer<DisableSagemakerServicecatalogPortfolioRequest.Builder> disableSagemakerServicecatalogPortfolioRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaDisableSagemakerServicecatalogPortfolioRequest.builder()
- Parameters:
disableSagemakerServicecatalogPortfolioRequest
- AConsumer
that will call methods onDisableSagemakerServicecatalogPortfolioRequest.Builder
to create a request.- Returns:
- Result of the DisableSagemakerServicecatalogPortfolio operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateTrialComponent
default DisassociateTrialComponentResponse disassociateTrialComponent(DisassociateTrialComponentRequest disassociateTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 theResource
parameter. The list appears in the response underResults.TrialComponent.Parents
.- Parameters:
disassociateTrialComponentRequest
-- Returns:
- Result of the DisassociateTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateTrialComponent
default DisassociateTrialComponentResponse disassociateTrialComponent(Consumer<DisassociateTrialComponentRequest.Builder> disassociateTrialComponentRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 theResource
parameter. The list appears in the response underResults.TrialComponent.Parents
.
This is a convenience which creates an instance of the
DisassociateTrialComponentRequest.Builder
avoiding the need to create one manually viaDisassociateTrialComponentRequest.builder()
- Parameters:
disassociateTrialComponentRequest
- AConsumer
that will call methods onDisassociateTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the DisassociateTrialComponent operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
enableSagemakerServicecatalogPortfolio
default EnableSagemakerServicecatalogPortfolioResponse enableSagemakerServicecatalogPortfolio(EnableSagemakerServicecatalogPortfolioRequest enableSagemakerServicecatalogPortfolioRequest) throws AwsServiceException, SdkClientException, SageMakerException
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
- Parameters:
enableSagemakerServicecatalogPortfolioRequest
-- Returns:
- Result of the EnableSagemakerServicecatalogPortfolio operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
enableSagemakerServicecatalogPortfolio
default EnableSagemakerServicecatalogPortfolioResponse enableSagemakerServicecatalogPortfolio(Consumer<EnableSagemakerServicecatalogPortfolioRequest.Builder> enableSagemakerServicecatalogPortfolioRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaEnableSagemakerServicecatalogPortfolioRequest.builder()
- Parameters:
enableSagemakerServicecatalogPortfolioRequest
- AConsumer
that will call methods onEnableSagemakerServicecatalogPortfolioRequest.Builder
to create a request.- Returns:
- Result of the EnableSagemakerServicecatalogPortfolio operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDeviceFleetReport
default GetDeviceFleetReportResponse getDeviceFleetReport(GetDeviceFleetReportRequest getDeviceFleetReportRequest) throws AwsServiceException, SdkClientException, SageMakerException
Describes a fleet.
- Parameters:
getDeviceFleetReportRequest
-- Returns:
- Result of the GetDeviceFleetReport operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getDeviceFleetReport
default GetDeviceFleetReportResponse getDeviceFleetReport(Consumer<GetDeviceFleetReportRequest.Builder> getDeviceFleetReportRequest) throws AwsServiceException, SdkClientException, SageMakerException
Describes a fleet.
This is a convenience which creates an instance of the
GetDeviceFleetReportRequest.Builder
avoiding the need to create one manually viaGetDeviceFleetReportRequest.builder()
- Parameters:
getDeviceFleetReportRequest
- AConsumer
that will call methods onGetDeviceFleetReportRequest.Builder
to create a request.- Returns:
- Result of the GetDeviceFleetReport operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getLineageGroupPolicy
default GetLineageGroupPolicyResponse getLineageGroupPolicy(GetLineageGroupPolicyRequest getLineageGroupPolicyRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
The resource policy for the lineage group.
- Parameters:
getLineageGroupPolicyRequest
-- Returns:
- Result of the GetLineageGroupPolicy operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getLineageGroupPolicy
default GetLineageGroupPolicyResponse getLineageGroupPolicy(Consumer<GetLineageGroupPolicyRequest.Builder> getLineageGroupPolicyRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaGetLineageGroupPolicyRequest.builder()
- Parameters:
getLineageGroupPolicyRequest
- AConsumer
that will call methods onGetLineageGroupPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetLineageGroupPolicy operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getModelPackageGroupPolicy
default GetModelPackageGroupPolicyResponse getModelPackageGroupPolicy(GetModelPackageGroupPolicyRequest getModelPackageGroupPolicyRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the GetModelPackageGroupPolicy operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getModelPackageGroupPolicy
default GetModelPackageGroupPolicyResponse getModelPackageGroupPolicy(Consumer<GetModelPackageGroupPolicyRequest.Builder> getModelPackageGroupPolicyRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaGetModelPackageGroupPolicyRequest.builder()
- Parameters:
getModelPackageGroupPolicyRequest
- AConsumer
that will call methods onGetModelPackageGroupPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetModelPackageGroupPolicy operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSagemakerServicecatalogPortfolioStatus
default GetSagemakerServicecatalogPortfolioStatusResponse getSagemakerServicecatalogPortfolioStatus(GetSagemakerServicecatalogPortfolioStatusRequest getSagemakerServicecatalogPortfolioStatusRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
- Parameters:
getSagemakerServicecatalogPortfolioStatusRequest
-- Returns:
- Result of the GetSagemakerServicecatalogPortfolioStatus operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSagemakerServicecatalogPortfolioStatus
default GetSagemakerServicecatalogPortfolioStatusResponse getSagemakerServicecatalogPortfolioStatus(Consumer<GetSagemakerServicecatalogPortfolioStatusRequest.Builder> getSagemakerServicecatalogPortfolioStatusRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaGetSagemakerServicecatalogPortfolioStatusRequest.builder()
- Parameters:
getSagemakerServicecatalogPortfolioStatusRequest
- AConsumer
that will call methods onGetSagemakerServicecatalogPortfolioStatusRequest.Builder
to create a request.- Returns:
- Result of the GetSagemakerServicecatalogPortfolioStatus operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getScalingConfigurationRecommendation
default GetScalingConfigurationRecommendationResponse getScalingConfigurationRecommendation(GetScalingConfigurationRecommendationRequest getScalingConfigurationRecommendationRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the GetScalingConfigurationRecommendation operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getScalingConfigurationRecommendation
default GetScalingConfigurationRecommendationResponse getScalingConfigurationRecommendation(Consumer<GetScalingConfigurationRecommendationRequest.Builder> getScalingConfigurationRecommendationRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaGetScalingConfigurationRecommendationRequest.builder()
- Parameters:
getScalingConfigurationRecommendationRequest
- AConsumer
that will call methods onGetScalingConfigurationRecommendationRequest.Builder
to create a request.- Returns:
- Result of the GetScalingConfigurationRecommendation operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSearchSuggestions
default GetSearchSuggestionsResponse getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 forHyperParameters
,Tags
, andMetrics
.- Parameters:
getSearchSuggestionsRequest
-- Returns:
- Result of the GetSearchSuggestions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getSearchSuggestions
default GetSearchSuggestionsResponse getSearchSuggestions(Consumer<GetSearchSuggestionsRequest.Builder> getSearchSuggestionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 forHyperParameters
,Tags
, andMetrics
.
This is a convenience which creates an instance of the
GetSearchSuggestionsRequest.Builder
avoiding the need to create one manually viaGetSearchSuggestionsRequest.builder()
- Parameters:
getSearchSuggestionsRequest
- AConsumer
that will call methods onGetSearchSuggestionsRequest.Builder
to create a request.- Returns:
- Result of the GetSearchSuggestions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
importHubContent
default ImportHubContentResponse importHubContent(ImportHubContentRequest importHubContentRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Import hub content.
- Parameters:
importHubContentRequest
-- Returns:
- Result of the ImportHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
importHubContent
default ImportHubContentResponse importHubContent(Consumer<ImportHubContentRequest.Builder> importHubContentRequest) throws ResourceInUseException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Import hub content.
This is a convenience which creates an instance of the
ImportHubContentRequest.Builder
avoiding the need to create one manually viaImportHubContentRequest.builder()
- Parameters:
importHubContentRequest
- AConsumer
that will call methods onImportHubContentRequest.Builder
to create a request.- Returns:
- Result of the ImportHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
listActions
default ListActionsResponse listActions(ListActionsRequest listActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the actions in your account and their properties.
- Parameters:
listActionsRequest
-- Returns:
- Result of the ListActions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listActions
default ListActionsResponse listActions(Consumer<ListActionsRequest.Builder> listActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListActionsRequest.builder()
- Parameters:
listActionsRequest
- AConsumer
that will call methods onListActionsRequest.Builder
to create a request.- Returns:
- Result of the ListActions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listActionsPaginator
default ListActionsIterable listActionsPaginator(ListActionsRequest listActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listActionsPaginator
default ListActionsIterable listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listActions(software.amazon.awssdk.services.sagemaker.model.ListActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListActionsIterable responses = client.listActionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListActionsRequest.builder()
- Parameters:
listActionsRequest
- AConsumer
that will call methods onListActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAlgorithms
default ListAlgorithmsResponse listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the machine learning algorithms that have been created.
- Parameters:
listAlgorithmsRequest
-- Returns:
- Result of the ListAlgorithms operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAlgorithms
default ListAlgorithmsResponse listAlgorithms(Consumer<ListAlgorithmsRequest.Builder> listAlgorithmsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListAlgorithmsRequest.builder()
- Parameters:
listAlgorithmsRequest
- AConsumer
that will call methods onListAlgorithmsRequest.Builder
to create a request.- Returns:
- Result of the ListAlgorithms operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAlgorithms
default ListAlgorithmsResponse listAlgorithms() throws AwsServiceException, SdkClientException, SageMakerException
Lists the machine learning algorithms that have been created.
- Returns:
- Result of the ListAlgorithms operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listAlgorithms(ListAlgorithmsRequest)
, AWS API Documentation
-
listAlgorithmsPaginator
default ListAlgorithmsIterable listAlgorithmsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client .listAlgorithmsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listAlgorithmsPaginator(ListAlgorithmsRequest)
, AWS API Documentation
-
listAlgorithmsPaginator
default ListAlgorithmsIterable listAlgorithmsPaginator(ListAlgorithmsRequest listAlgorithmsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client .listAlgorithmsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAlgorithmsPaginator
default ListAlgorithmsIterable listAlgorithmsPaginator(Consumer<ListAlgorithmsRequest.Builder> listAlgorithmsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAlgorithms(software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client .listAlgorithmsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAlgorithmsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAlgorithmsIterable responses = client.listAlgorithmsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAlgorithmsRequest.builder()
- Parameters:
listAlgorithmsRequest
- AConsumer
that will call methods onListAlgorithmsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAliases
default ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the aliases of a specified image or image version.
- Parameters:
listAliasesRequest
-- Returns:
- Result of the ListAliases operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAliases
default ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListAliases operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAliases(software.amazon.awssdk.services.sagemaker.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppImageConfigs
default ListAppImageConfigsResponse listAppImageConfigs(ListAppImageConfigsRequest listAppImageConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListAppImageConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppImageConfigs
default ListAppImageConfigsResponse listAppImageConfigs(Consumer<ListAppImageConfigsRequest.Builder> listAppImageConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListAppImageConfigsRequest.builder()
- Parameters:
listAppImageConfigsRequest
- AConsumer
that will call methods onListAppImageConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListAppImageConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppImageConfigsPaginator
default ListAppImageConfigsIterable listAppImageConfigsPaginator(ListAppImageConfigsRequest listAppImageConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client.listAppImageConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client .listAppImageConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client.listAppImageConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppImageConfigsPaginator
default ListAppImageConfigsIterable listAppImageConfigsPaginator(Consumer<ListAppImageConfigsRequest.Builder> listAppImageConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAppImageConfigs(software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client.listAppImageConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client .listAppImageConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAppImageConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAppImageConfigsIterable responses = client.listAppImageConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAppImageConfigsRequest.builder()
- Parameters:
listAppImageConfigsRequest
- AConsumer
that will call methods onListAppImageConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists apps.
- Parameters:
listAppsRequest
-- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(Consumer<ListAppsRequest.Builder> listAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists apps.
This is a convenience which creates an instance of the
ListAppsRequest.Builder
avoiding the need to create one manually viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request.- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppsPaginator
default ListAppsIterable listAppsPaginator(ListAppsRequest listAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAppsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAppsPaginator
default ListAppsIterable listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listApps(software.amazon.awssdk.services.sagemaker.model.ListAppsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAppsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listArtifacts
default ListArtifactsResponse listArtifacts(ListArtifactsRequest listArtifactsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the artifacts in your account and their properties.
- Parameters:
listArtifactsRequest
-- Returns:
- Result of the ListArtifacts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listArtifacts
default ListArtifactsResponse listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListArtifactsRequest.builder()
- Parameters:
listArtifactsRequest
- AConsumer
that will call methods onListArtifactsRequest.Builder
to create a request.- Returns:
- Result of the ListArtifacts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listArtifactsPaginator
default ListArtifactsIterable listArtifactsPaginator(ListArtifactsRequest listArtifactsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listArtifactsPaginator
default ListArtifactsIterable listArtifactsPaginator(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listArtifacts(software.amazon.awssdk.services.sagemaker.model.ListArtifactsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListArtifactsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListArtifactsIterable responses = client.listArtifactsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListArtifactsRequest.builder()
- Parameters:
listArtifactsRequest
- AConsumer
that will call methods onListArtifactsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAssociations
default ListAssociationsResponse listAssociations(ListAssociationsRequest listAssociationsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the associations in your account and their properties.
- Parameters:
listAssociationsRequest
-- Returns:
- Result of the ListAssociations operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAssociations
default ListAssociationsResponse listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListAssociationsRequest.builder()
- Parameters:
listAssociationsRequest
- AConsumer
that will call methods onListAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListAssociations operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAssociationsPaginator
default ListAssociationsIterable listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client .listAssociationsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAssociationsPaginator
default ListAssociationsIterable listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAssociations(software.amazon.awssdk.services.sagemaker.model.ListAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client .listAssociationsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAssociationsRequest.builder()
- Parameters:
listAssociationsRequest
- AConsumer
that will call methods onListAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAutoMLJobs
default ListAutoMlJobsResponse listAutoMLJobs(ListAutoMlJobsRequest listAutoMlJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Request a list of jobs.
- Parameters:
listAutoMlJobsRequest
-- Returns:
- Result of the ListAutoMLJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAutoMLJobs
default ListAutoMlJobsResponse listAutoMLJobs(Consumer<ListAutoMlJobsRequest.Builder> listAutoMlJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Request a list of jobs.
This is a convenience which creates an instance of the
ListAutoMlJobsRequest.Builder
avoiding the need to create one manually viaListAutoMlJobsRequest.builder()
- Parameters:
listAutoMlJobsRequest
- AConsumer
that will call methods onListAutoMlJobsRequest.Builder
to create a request.- Returns:
- Result of the ListAutoMLJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAutoMLJobsPaginator
default ListAutoMLJobsIterable listAutoMLJobsPaginator(ListAutoMlJobsRequest listAutoMlJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client.listAutoMLJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client .listAutoMLJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client.listAutoMLJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listAutoMLJobsPaginator
default ListAutoMLJobsIterable listAutoMLJobsPaginator(Consumer<ListAutoMlJobsRequest.Builder> listAutoMlJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listAutoMLJobs(software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client.listAutoMLJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client .listAutoMLJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListAutoMlJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListAutoMLJobsIterable responses = client.listAutoMLJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListAutoMlJobsRequest.builder()
- Parameters:
listAutoMlJobsRequest
- AConsumer
that will call methods onListAutoMlJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCandidatesForAutoMLJob
default ListCandidatesForAutoMlJobResponse listCandidatesForAutoMLJob(ListCandidatesForAutoMlJobRequest listCandidatesForAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List the candidates created for the job.
- Parameters:
listCandidatesForAutoMlJobRequest
-- Returns:
- Result of the ListCandidatesForAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCandidatesForAutoMLJob
default ListCandidatesForAutoMlJobResponse listCandidatesForAutoMLJob(Consumer<ListCandidatesForAutoMlJobRequest.Builder> listCandidatesForAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListCandidatesForAutoMlJobRequest.builder()
- Parameters:
listCandidatesForAutoMlJobRequest
- AConsumer
that will call methods onListCandidatesForAutoMlJobRequest.Builder
to create a request.- Returns:
- Result of the ListCandidatesForAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCandidatesForAutoMLJobPaginator
default ListCandidatesForAutoMLJobIterable listCandidatesForAutoMLJobPaginator(ListCandidatesForAutoMlJobRequest listCandidatesForAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client.listCandidatesForAutoMLJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client .listCandidatesForAutoMLJobPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client.listCandidatesForAutoMLJobPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCandidatesForAutoMLJobPaginator
default ListCandidatesForAutoMLJobIterable listCandidatesForAutoMLJobPaginator(Consumer<ListCandidatesForAutoMlJobRequest.Builder> listCandidatesForAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCandidatesForAutoMLJob(software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client.listCandidatesForAutoMLJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client .listCandidatesForAutoMLJobPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCandidatesForAutoMlJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCandidatesForAutoMLJobIterable responses = client.listCandidatesForAutoMLJobPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListCandidatesForAutoMlJobRequest.builder()
- Parameters:
listCandidatesForAutoMlJobRequest
- AConsumer
that will call methods onListCandidatesForAutoMlJobRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterNodes
default ListClusterNodesResponse listClusterNodes(ListClusterNodesRequest listClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.
- Parameters:
listClusterNodesRequest
-- Returns:
- Result of the ListClusterNodes operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterNodes
default ListClusterNodesResponse listClusterNodes(Consumer<ListClusterNodesRequest.Builder> listClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListClusterNodesRequest.builder()
- Parameters:
listClusterNodesRequest
- AConsumer
that will call methods onListClusterNodesRequest.Builder
to create a request.- Returns:
- Result of the ListClusterNodes operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterNodesPaginator
default ListClusterNodesIterable listClusterNodesPaginator(ListClusterNodesRequest listClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client.listClusterNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client .listClusterNodesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client.listClusterNodesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterNodesPaginator
default ListClusterNodesIterable listClusterNodesPaginator(Consumer<ListClusterNodesRequest.Builder> listClusterNodesRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusterNodes(software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client.listClusterNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client .listClusterNodesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClusterNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterNodesIterable responses = client.listClusterNodesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListClusterNodesRequest.builder()
- Parameters:
listClusterNodesRequest
- AConsumer
that will call methods onListClusterNodesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterSchedulerConfigs
default ListClusterSchedulerConfigsResponse listClusterSchedulerConfigs(ListClusterSchedulerConfigsRequest listClusterSchedulerConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List the cluster policy configurations.
- Parameters:
listClusterSchedulerConfigsRequest
-- Returns:
- Result of the ListClusterSchedulerConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterSchedulerConfigs
default ListClusterSchedulerConfigsResponse listClusterSchedulerConfigs(Consumer<ListClusterSchedulerConfigsRequest.Builder> listClusterSchedulerConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List the cluster policy configurations.
This is a convenience which creates an instance of the
ListClusterSchedulerConfigsRequest.Builder
avoiding the need to create one manually viaListClusterSchedulerConfigsRequest.builder()
- Parameters:
listClusterSchedulerConfigsRequest
- AConsumer
that will call methods onListClusterSchedulerConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListClusterSchedulerConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterSchedulerConfigsPaginator
default ListClusterSchedulerConfigsIterable listClusterSchedulerConfigsPaginator(ListClusterSchedulerConfigsRequest listClusterSchedulerConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusterSchedulerConfigs(software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client.listClusterSchedulerConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client .listClusterSchedulerConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client.listClusterSchedulerConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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
listClusterSchedulerConfigs(software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsRequest)
operation.- Parameters:
listClusterSchedulerConfigsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusterSchedulerConfigsPaginator
default ListClusterSchedulerConfigsIterable listClusterSchedulerConfigsPaginator(Consumer<ListClusterSchedulerConfigsRequest.Builder> listClusterSchedulerConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusterSchedulerConfigs(software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client.listClusterSchedulerConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client .listClusterSchedulerConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClusterSchedulerConfigsIterable responses = client.listClusterSchedulerConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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
listClusterSchedulerConfigs(software.amazon.awssdk.services.sagemaker.model.ListClusterSchedulerConfigsRequest)
operation.
This is a convenience which creates an instance of the
ListClusterSchedulerConfigsRequest.Builder
avoiding the need to create one manually viaListClusterSchedulerConfigsRequest.builder()
- Parameters:
listClusterSchedulerConfigsRequest
- AConsumer
that will call methods onListClusterSchedulerConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusters
default ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws AwsServiceException, SdkClientException, SageMakerException
Retrieves the list of SageMaker HyperPod clusters.
- Parameters:
listClustersRequest
-- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClusters
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listClusters(software.amazon.awssdk.services.sagemaker.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCodeRepositories
default ListCodeRepositoriesResponse listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the Git repositories in your account.
- Parameters:
listCodeRepositoriesRequest
-- Returns:
- Result of the ListCodeRepositories operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCodeRepositories
default ListCodeRepositoriesResponse listCodeRepositories(Consumer<ListCodeRepositoriesRequest.Builder> listCodeRepositoriesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListCodeRepositoriesRequest.builder()
- Parameters:
listCodeRepositoriesRequest
- AConsumer
that will call methods onListCodeRepositoriesRequest.Builder
to create a request.- Returns:
- Result of the ListCodeRepositories operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCodeRepositories
default ListCodeRepositoriesResponse listCodeRepositories() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the Git repositories in your account.
- Returns:
- Result of the ListCodeRepositories operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listCodeRepositories(ListCodeRepositoriesRequest)
, AWS API Documentation
-
listCodeRepositoriesPaginator
default ListCodeRepositoriesIterable listCodeRepositoriesPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client .listCodeRepositoriesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listCodeRepositoriesPaginator(ListCodeRepositoriesRequest)
, AWS API Documentation
-
listCodeRepositoriesPaginator
default ListCodeRepositoriesIterable listCodeRepositoriesPaginator(ListCodeRepositoriesRequest listCodeRepositoriesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client .listCodeRepositoriesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCodeRepositoriesPaginator
default ListCodeRepositoriesIterable listCodeRepositoriesPaginator(Consumer<ListCodeRepositoriesRequest.Builder> listCodeRepositoriesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCodeRepositories(software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client .listCodeRepositoriesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCodeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCodeRepositoriesIterable responses = client.listCodeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListCodeRepositoriesRequest.builder()
- Parameters:
listCodeRepositoriesRequest
- AConsumer
that will call methods onListCodeRepositoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCompilationJobs
default ListCompilationJobsResponse listCompilationJobs(ListCompilationJobsRequest listCompilationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListCompilationJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCompilationJobs
default ListCompilationJobsResponse listCompilationJobs(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListCompilationJobsRequest.builder()
- Parameters:
listCompilationJobsRequest
- AConsumer
that will call methods onListCompilationJobsRequest.Builder
to create a request.- Returns:
- Result of the ListCompilationJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCompilationJobs
default ListCompilationJobsResponse listCompilationJobs() throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListCompilationJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listCompilationJobs(ListCompilationJobsRequest)
, AWS API Documentation
-
listCompilationJobsPaginator
default ListCompilationJobsIterable listCompilationJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client .listCompilationJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listCompilationJobsPaginator(ListCompilationJobsRequest)
, AWS API Documentation
-
listCompilationJobsPaginator
default ListCompilationJobsIterable listCompilationJobsPaginator(ListCompilationJobsRequest listCompilationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client .listCompilationJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listCompilationJobsPaginator
default ListCompilationJobsIterable listCompilationJobsPaginator(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client .listCompilationJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListCompilationJobsRequest.builder()
- Parameters:
listCompilationJobsRequest
- AConsumer
that will call methods onListCompilationJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listComputeQuotas
default ListComputeQuotasResponse listComputeQuotas(ListComputeQuotasRequest listComputeQuotasRequest) throws AwsServiceException, SdkClientException, SageMakerException
List the resource allocation definitions.
- Parameters:
listComputeQuotasRequest
-- Returns:
- Result of the ListComputeQuotas operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listComputeQuotas
default ListComputeQuotasResponse listComputeQuotas(Consumer<ListComputeQuotasRequest.Builder> listComputeQuotasRequest) throws AwsServiceException, SdkClientException, SageMakerException
List the resource allocation definitions.
This is a convenience which creates an instance of the
ListComputeQuotasRequest.Builder
avoiding the need to create one manually viaListComputeQuotasRequest.builder()
- Parameters:
listComputeQuotasRequest
- AConsumer
that will call methods onListComputeQuotasRequest.Builder
to create a request.- Returns:
- Result of the ListComputeQuotas operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listComputeQuotasPaginator
default ListComputeQuotasIterable listComputeQuotasPaginator(ListComputeQuotasRequest listComputeQuotasRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listComputeQuotas(software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client.listComputeQuotasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client .listComputeQuotasPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client.listComputeQuotasPaginator(request); responses.iterator().forEachRemaining(....);
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
listComputeQuotas(software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasRequest)
operation.- Parameters:
listComputeQuotasRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listComputeQuotasPaginator
default ListComputeQuotasIterable listComputeQuotasPaginator(Consumer<ListComputeQuotasRequest.Builder> listComputeQuotasRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listComputeQuotas(software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client.listComputeQuotasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client .listComputeQuotasPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListComputeQuotasIterable responses = client.listComputeQuotasPaginator(request); responses.iterator().forEachRemaining(....);
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
listComputeQuotas(software.amazon.awssdk.services.sagemaker.model.ListComputeQuotasRequest)
operation.
This is a convenience which creates an instance of the
ListComputeQuotasRequest.Builder
avoiding the need to create one manually viaListComputeQuotasRequest.builder()
- Parameters:
listComputeQuotasRequest
- AConsumer
that will call methods onListComputeQuotasRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listContexts
default ListContextsResponse listContexts(ListContextsRequest listContextsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the contexts in your account and their properties.
- Parameters:
listContextsRequest
-- Returns:
- Result of the ListContexts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listContexts
default ListContextsResponse listContexts(Consumer<ListContextsRequest.Builder> listContextsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListContextsRequest.builder()
- Parameters:
listContextsRequest
- AConsumer
that will call methods onListContextsRequest.Builder
to create a request.- Returns:
- Result of the ListContexts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listContextsPaginator
default ListContextsIterable listContextsPaginator(ListContextsRequest listContextsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListContextsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listContextsPaginator
default ListContextsIterable listContextsPaginator(Consumer<ListContextsRequest.Builder> listContextsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listContexts(software.amazon.awssdk.services.sagemaker.model.ListContextsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListContextsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListContextsIterable responses = client.listContextsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListContextsRequest.builder()
- Parameters:
listContextsRequest
- AConsumer
that will call methods onListContextsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataQualityJobDefinitions
default ListDataQualityJobDefinitionsResponse listDataQualityJobDefinitions(ListDataQualityJobDefinitionsRequest listDataQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the data quality job definitions in your account.
- Parameters:
listDataQualityJobDefinitionsRequest
-- Returns:
- Result of the ListDataQualityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataQualityJobDefinitions
default ListDataQualityJobDefinitionsResponse listDataQualityJobDefinitions(Consumer<ListDataQualityJobDefinitionsRequest.Builder> listDataQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListDataQualityJobDefinitionsRequest.builder()
- Parameters:
listDataQualityJobDefinitionsRequest
- AConsumer
that will call methods onListDataQualityJobDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListDataQualityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataQualityJobDefinitionsPaginator
default ListDataQualityJobDefinitionsIterable listDataQualityJobDefinitionsPaginator(ListDataQualityJobDefinitionsRequest listDataQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client.listDataQualityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client .listDataQualityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client.listDataQualityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDataQualityJobDefinitionsPaginator
default ListDataQualityJobDefinitionsIterable listDataQualityJobDefinitionsPaginator(Consumer<ListDataQualityJobDefinitionsRequest.Builder> listDataQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDataQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client.listDataQualityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client .listDataQualityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDataQualityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDataQualityJobDefinitionsIterable responses = client.listDataQualityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListDataQualityJobDefinitionsRequest.builder()
- Parameters:
listDataQualityJobDefinitionsRequest
- AConsumer
that will call methods onListDataQualityJobDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeviceFleets
default ListDeviceFleetsResponse listDeviceFleets(ListDeviceFleetsRequest listDeviceFleetsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of devices in the fleet.
- Parameters:
listDeviceFleetsRequest
-- Returns:
- Result of the ListDeviceFleets operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeviceFleets
default ListDeviceFleetsResponse listDeviceFleets(Consumer<ListDeviceFleetsRequest.Builder> listDeviceFleetsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListDeviceFleetsRequest.builder()
- Parameters:
listDeviceFleetsRequest
- AConsumer
that will call methods onListDeviceFleetsRequest.Builder
to create a request.- Returns:
- Result of the ListDeviceFleets operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeviceFleetsPaginator
default ListDeviceFleetsIterable listDeviceFleetsPaginator(ListDeviceFleetsRequest listDeviceFleetsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client.listDeviceFleetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client .listDeviceFleetsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client.listDeviceFleetsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeviceFleetsPaginator
default ListDeviceFleetsIterable listDeviceFleetsPaginator(Consumer<ListDeviceFleetsRequest.Builder> listDeviceFleetsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDeviceFleets(software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client.listDeviceFleetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client .listDeviceFleetsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDeviceFleetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDeviceFleetsIterable responses = client.listDeviceFleetsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListDeviceFleetsRequest.builder()
- Parameters:
listDeviceFleetsRequest
- AConsumer
that will call methods onListDeviceFleetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(ListDevicesRequest listDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
A list of devices.
- Parameters:
listDevicesRequest
-- Returns:
- Result of the ListDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDevices
default ListDevicesResponse listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
A list of devices.
This is a convenience which creates an instance of the
ListDevicesRequest.Builder
avoiding the need to create one manually viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- Result of the ListDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDevicesPaginator
default ListDevicesIterable listDevicesPaginator(ListDevicesRequest listDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDevicesPaginator
default ListDevicesIterable listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDevices(software.amazon.awssdk.services.sagemaker.model.ListDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDevicesIterable responses = client.listDevicesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the domains.
- Parameters:
listDomainsRequest
-- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the domains.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listDomains(software.amazon.awssdk.services.sagemaker.model.ListDomainsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListDomainsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgeDeploymentPlans
default ListEdgeDeploymentPlansResponse listEdgeDeploymentPlans(ListEdgeDeploymentPlansRequest listEdgeDeploymentPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all edge deployment plans.
- Parameters:
listEdgeDeploymentPlansRequest
-- Returns:
- Result of the ListEdgeDeploymentPlans operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgeDeploymentPlans
default ListEdgeDeploymentPlansResponse listEdgeDeploymentPlans(Consumer<ListEdgeDeploymentPlansRequest.Builder> listEdgeDeploymentPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all edge deployment plans.
This is a convenience which creates an instance of the
ListEdgeDeploymentPlansRequest.Builder
avoiding the need to create one manually viaListEdgeDeploymentPlansRequest.builder()
- Parameters:
listEdgeDeploymentPlansRequest
- AConsumer
that will call methods onListEdgeDeploymentPlansRequest.Builder
to create a request.- Returns:
- Result of the ListEdgeDeploymentPlans operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgeDeploymentPlansPaginator
default ListEdgeDeploymentPlansIterable listEdgeDeploymentPlansPaginator(ListEdgeDeploymentPlansRequest listEdgeDeploymentPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client.listEdgeDeploymentPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client .listEdgeDeploymentPlansPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client.listEdgeDeploymentPlansPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgeDeploymentPlansPaginator
default ListEdgeDeploymentPlansIterable listEdgeDeploymentPlansPaginator(Consumer<ListEdgeDeploymentPlansRequest.Builder> listEdgeDeploymentPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEdgeDeploymentPlans(software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client.listEdgeDeploymentPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client .listEdgeDeploymentPlansPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEdgeDeploymentPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgeDeploymentPlansIterable responses = client.listEdgeDeploymentPlansPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListEdgeDeploymentPlansRequest.builder()
- Parameters:
listEdgeDeploymentPlansRequest
- AConsumer
that will call methods onListEdgeDeploymentPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgePackagingJobs
default ListEdgePackagingJobsResponse listEdgePackagingJobs(ListEdgePackagingJobsRequest listEdgePackagingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of edge packaging jobs.
- Parameters:
listEdgePackagingJobsRequest
-- Returns:
- Result of the ListEdgePackagingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgePackagingJobs
default ListEdgePackagingJobsResponse listEdgePackagingJobs(Consumer<ListEdgePackagingJobsRequest.Builder> listEdgePackagingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListEdgePackagingJobsRequest.builder()
- Parameters:
listEdgePackagingJobsRequest
- AConsumer
that will call methods onListEdgePackagingJobsRequest.Builder
to create a request.- Returns:
- Result of the ListEdgePackagingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgePackagingJobsPaginator
default ListEdgePackagingJobsIterable listEdgePackagingJobsPaginator(ListEdgePackagingJobsRequest listEdgePackagingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client.listEdgePackagingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client .listEdgePackagingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client.listEdgePackagingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEdgePackagingJobsPaginator
default ListEdgePackagingJobsIterable listEdgePackagingJobsPaginator(Consumer<ListEdgePackagingJobsRequest.Builder> listEdgePackagingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEdgePackagingJobs(software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client.listEdgePackagingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client .listEdgePackagingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEdgePackagingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEdgePackagingJobsIterable responses = client.listEdgePackagingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListEdgePackagingJobsRequest.builder()
- Parameters:
listEdgePackagingJobsRequest
- AConsumer
that will call methods onListEdgePackagingJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpointConfigs
default ListEndpointConfigsResponse listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
- Parameters:
listEndpointConfigsRequest
-- Returns:
- Result of the ListEndpointConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpointConfigs
default ListEndpointConfigsResponse listEndpointConfigs(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
This is a convenience which creates an instance of the
ListEndpointConfigsRequest.Builder
avoiding the need to create one manually viaListEndpointConfigsRequest.builder()
- Parameters:
listEndpointConfigsRequest
- AConsumer
that will call methods onListEndpointConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListEndpointConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpointConfigs
default ListEndpointConfigsResponse listEndpointConfigs() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
- Returns:
- Result of the ListEndpointConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listEndpointConfigs(ListEndpointConfigsRequest)
, AWS API Documentation
-
listEndpointConfigsPaginator
default ListEndpointConfigsIterable listEndpointConfigsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client .listEndpointConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listEndpointConfigsPaginator(ListEndpointConfigsRequest)
, AWS API Documentation
-
listEndpointConfigsPaginator
default ListEndpointConfigsIterable listEndpointConfigsPaginator(ListEndpointConfigsRequest listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client .listEndpointConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpointConfigsPaginator
default ListEndpointConfigsIterable listEndpointConfigsPaginator(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client .listEndpointConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListEndpointConfigsRequest.builder()
- Parameters:
listEndpointConfigsRequest
- AConsumer
that will call methods onListEndpointConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpoints
default ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
- Parameters:
listEndpointsRequest
-- Returns:
- Result of the ListEndpoints operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpoints
default ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
This is a convenience which creates an instance of the
ListEndpointsRequest.Builder
avoiding the need to create one manually viaListEndpointsRequest.builder()
- Parameters:
listEndpointsRequest
- AConsumer
that will call methods onListEndpointsRequest.Builder
to create a request.- Returns:
- Result of the ListEndpoints operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpoints
default ListEndpointsResponse listEndpoints() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
- Returns:
- Result of the ListEndpoints operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listEndpoints(ListEndpointsRequest)
, AWS API Documentation
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listEndpointsPaginator(ListEndpointsRequest)
, AWS API Documentation
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listEndpointsPaginator
default ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListEndpointsRequest.builder()
- Parameters:
listEndpointsRequest
- AConsumer
that will call methods onListEndpointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listExperiments
default ListExperimentsResponse listExperiments(ListExperimentsRequest listExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListExperiments operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listExperiments
default ListExperimentsResponse listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListExperimentsRequest.builder()
- Parameters:
listExperimentsRequest
- AConsumer
that will call methods onListExperimentsRequest.Builder
to create a request.- Returns:
- Result of the ListExperiments operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listExperimentsPaginator
default ListExperimentsIterable listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client .listExperimentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listExperimentsPaginator
default ListExperimentsIterable listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listExperiments(software.amazon.awssdk.services.sagemaker.model.ListExperimentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client .listExperimentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListExperimentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListExperimentsRequest.builder()
- Parameters:
listExperimentsRequest
- AConsumer
that will call methods onListExperimentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFeatureGroups
default ListFeatureGroupsResponse listFeatureGroups(ListFeatureGroupsRequest listFeatureGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List
FeatureGroup
s based on given filter and order.- Parameters:
listFeatureGroupsRequest
-- Returns:
- Result of the ListFeatureGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFeatureGroups
default ListFeatureGroupsResponse listFeatureGroups(Consumer<ListFeatureGroupsRequest.Builder> listFeatureGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List
FeatureGroup
s 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 viaListFeatureGroupsRequest.builder()
- Parameters:
listFeatureGroupsRequest
- AConsumer
that will call methods onListFeatureGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListFeatureGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFeatureGroupsPaginator
default ListFeatureGroupsIterable listFeatureGroupsPaginator(ListFeatureGroupsRequest listFeatureGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client.listFeatureGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client .listFeatureGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client.listFeatureGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFeatureGroupsPaginator
default ListFeatureGroupsIterable listFeatureGroupsPaginator(Consumer<ListFeatureGroupsRequest.Builder> listFeatureGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listFeatureGroups(software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client.listFeatureGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client .listFeatureGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListFeatureGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListFeatureGroupsIterable responses = client.listFeatureGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListFeatureGroupsRequest.builder()
- Parameters:
listFeatureGroupsRequest
- AConsumer
that will call methods onListFeatureGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFlowDefinitions
default ListFlowDefinitionsResponse listFlowDefinitions(ListFlowDefinitionsRequest listFlowDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns information about the flow definitions in your account.
- Parameters:
listFlowDefinitionsRequest
-- Returns:
- Result of the ListFlowDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFlowDefinitions
default ListFlowDefinitionsResponse listFlowDefinitions(Consumer<ListFlowDefinitionsRequest.Builder> listFlowDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListFlowDefinitionsRequest.builder()
- Parameters:
listFlowDefinitionsRequest
- AConsumer
that will call methods onListFlowDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListFlowDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFlowDefinitionsPaginator
default ListFlowDefinitionsIterable listFlowDefinitionsPaginator(ListFlowDefinitionsRequest listFlowDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client.listFlowDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client .listFlowDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client.listFlowDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listFlowDefinitionsPaginator
default ListFlowDefinitionsIterable listFlowDefinitionsPaginator(Consumer<ListFlowDefinitionsRequest.Builder> listFlowDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listFlowDefinitions(software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client.listFlowDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client .listFlowDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListFlowDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListFlowDefinitionsIterable responses = client.listFlowDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListFlowDefinitionsRequest.builder()
- Parameters:
listFlowDefinitionsRequest
- AConsumer
that will call methods onListFlowDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubContentVersions
default ListHubContentVersionsResponse listHubContentVersions(ListHubContentVersionsRequest listHubContentVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List hub content versions.
- Parameters:
listHubContentVersionsRequest
-- Returns:
- Result of the ListHubContentVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubContentVersions
default ListHubContentVersionsResponse listHubContentVersions(Consumer<ListHubContentVersionsRequest.Builder> listHubContentVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List hub content versions.
This is a convenience which creates an instance of the
ListHubContentVersionsRequest.Builder
avoiding the need to create one manually viaListHubContentVersionsRequest.builder()
- Parameters:
listHubContentVersionsRequest
- AConsumer
that will call methods onListHubContentVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListHubContentVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubContents
default ListHubContentsResponse listHubContents(ListHubContentsRequest listHubContentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List the contents of a hub.
- Parameters:
listHubContentsRequest
-- Returns:
- Result of the ListHubContents operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubContents
default ListHubContentsResponse listHubContents(Consumer<ListHubContentsRequest.Builder> listHubContentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List the contents of a hub.
This is a convenience which creates an instance of the
ListHubContentsRequest.Builder
avoiding the need to create one manually viaListHubContentsRequest.builder()
- Parameters:
listHubContentsRequest
- AConsumer
that will call methods onListHubContentsRequest.Builder
to create a request.- Returns:
- Result of the ListHubContents operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubs
default ListHubsResponse listHubs(ListHubsRequest listHubsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List all existing hubs.
- Parameters:
listHubsRequest
-- Returns:
- Result of the ListHubs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHubs
default ListHubsResponse listHubs(Consumer<ListHubsRequest.Builder> listHubsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List all existing hubs.
This is a convenience which creates an instance of the
ListHubsRequest.Builder
avoiding the need to create one manually viaListHubsRequest.builder()
- Parameters:
listHubsRequest
- AConsumer
that will call methods onListHubsRequest.Builder
to create a request.- Returns:
- Result of the ListHubs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHumanTaskUis
default ListHumanTaskUisResponse listHumanTaskUis(ListHumanTaskUisRequest listHumanTaskUisRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns information about the human task user interfaces in your account.
- Parameters:
listHumanTaskUisRequest
-- Returns:
- Result of the ListHumanTaskUis operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHumanTaskUis
default ListHumanTaskUisResponse listHumanTaskUis(Consumer<ListHumanTaskUisRequest.Builder> listHumanTaskUisRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListHumanTaskUisRequest.builder()
- Parameters:
listHumanTaskUisRequest
- AConsumer
that will call methods onListHumanTaskUisRequest.Builder
to create a request.- Returns:
- Result of the ListHumanTaskUis operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHumanTaskUisPaginator
default ListHumanTaskUisIterable listHumanTaskUisPaginator(ListHumanTaskUisRequest listHumanTaskUisRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client.listHumanTaskUisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client .listHumanTaskUisPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client.listHumanTaskUisPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHumanTaskUisPaginator
default ListHumanTaskUisIterable listHumanTaskUisPaginator(Consumer<ListHumanTaskUisRequest.Builder> listHumanTaskUisRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listHumanTaskUis(software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client.listHumanTaskUisPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client .listHumanTaskUisPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListHumanTaskUisResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListHumanTaskUisIterable responses = client.listHumanTaskUisPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListHumanTaskUisRequest.builder()
- Parameters:
listHumanTaskUisRequest
- AConsumer
that will call methods onListHumanTaskUisRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHyperParameterTuningJobs
default ListHyperParameterTuningJobsResponse listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
- Parameters:
listHyperParameterTuningJobsRequest
-- Returns:
- Result of the ListHyperParameterTuningJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHyperParameterTuningJobs
default ListHyperParameterTuningJobsResponse listHyperParameterTuningJobs(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListHyperParameterTuningJobsRequest.builder()
- Parameters:
listHyperParameterTuningJobsRequest
- AConsumer
that will call methods onListHyperParameterTuningJobsRequest.Builder
to create a request.- Returns:
- Result of the ListHyperParameterTuningJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHyperParameterTuningJobs
default ListHyperParameterTuningJobsResponse listHyperParameterTuningJobs() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
- Returns:
- Result of the ListHyperParameterTuningJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest)
, AWS API Documentation
-
listHyperParameterTuningJobsPaginator
default ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client .listHyperParameterTuningJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest)
, AWS API Documentation
-
listHyperParameterTuningJobsPaginator
default ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client .listHyperParameterTuningJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listHyperParameterTuningJobsPaginator
default ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client .listHyperParameterTuningJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListHyperParameterTuningJobsRequest.builder()
- Parameters:
listHyperParameterTuningJobsRequest
- AConsumer
that will call methods onListHyperParameterTuningJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImageVersions
default ListImageVersionsResponse listImageVersions(ListImageVersionsRequest listImageVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
- Parameters:
listImageVersionsRequest
-- Returns:
- Result of the ListImageVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImageVersions
default ListImageVersionsResponse listImageVersions(Consumer<ListImageVersionsRequest.Builder> listImageVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListImageVersionsRequest.builder()
- Parameters:
listImageVersionsRequest
- AConsumer
that will call methods onListImageVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListImageVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImageVersionsPaginator
default ListImageVersionsIterable listImageVersionsPaginator(ListImageVersionsRequest listImageVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client.listImageVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client .listImageVersionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client.listImageVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImageVersionsPaginator
default ListImageVersionsIterable listImageVersionsPaginator(Consumer<ListImageVersionsRequest.Builder> listImageVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listImageVersions(software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client.listImageVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client .listImageVersionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListImageVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListImageVersionsIterable responses = client.listImageVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListImageVersionsRequest.builder()
- Parameters:
listImageVersionsRequest
- AConsumer
that will call methods onListImageVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListImages operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- Result of the ListImages operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listImages(software.amazon.awssdk.services.sagemaker.model.ListImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceComponents
default ListInferenceComponentsResponse listInferenceComponents(ListInferenceComponentsRequest listInferenceComponentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the inference components in your account and their properties.
- Parameters:
listInferenceComponentsRequest
-- Returns:
- Result of the ListInferenceComponents operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceComponents
default ListInferenceComponentsResponse listInferenceComponents(Consumer<ListInferenceComponentsRequest.Builder> listInferenceComponentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListInferenceComponentsRequest.builder()
- Parameters:
listInferenceComponentsRequest
- AConsumer
that will call methods onListInferenceComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListInferenceComponents operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceComponentsPaginator
default ListInferenceComponentsIterable listInferenceComponentsPaginator(ListInferenceComponentsRequest listInferenceComponentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client.listInferenceComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client .listInferenceComponentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client.listInferenceComponentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceComponentsPaginator
default ListInferenceComponentsIterable listInferenceComponentsPaginator(Consumer<ListInferenceComponentsRequest.Builder> listInferenceComponentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceComponents(software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client.listInferenceComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client .listInferenceComponentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceComponentsIterable responses = client.listInferenceComponentsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListInferenceComponentsRequest.builder()
- Parameters:
listInferenceComponentsRequest
- AConsumer
that will call methods onListInferenceComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceExperiments
default ListInferenceExperimentsResponse listInferenceExperiments(ListInferenceExperimentsRequest listInferenceExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the list of all inference experiments.
- Parameters:
listInferenceExperimentsRequest
-- Returns:
- Result of the ListInferenceExperiments operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceExperiments
default ListInferenceExperimentsResponse listInferenceExperiments(Consumer<ListInferenceExperimentsRequest.Builder> listInferenceExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListInferenceExperimentsRequest.builder()
- Parameters:
listInferenceExperimentsRequest
- AConsumer
that will call methods onListInferenceExperimentsRequest.Builder
to create a request.- Returns:
- Result of the ListInferenceExperiments operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceExperimentsPaginator
default ListInferenceExperimentsIterable listInferenceExperimentsPaginator(ListInferenceExperimentsRequest listInferenceExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client.listInferenceExperimentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client .listInferenceExperimentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client.listInferenceExperimentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceExperimentsPaginator
default ListInferenceExperimentsIterable listInferenceExperimentsPaginator(Consumer<ListInferenceExperimentsRequest.Builder> listInferenceExperimentsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceExperiments(software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client.listInferenceExperimentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client .listInferenceExperimentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceExperimentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceExperimentsIterable responses = client.listInferenceExperimentsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListInferenceExperimentsRequest.builder()
- Parameters:
listInferenceExperimentsRequest
- AConsumer
that will call methods onListInferenceExperimentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobSteps
default ListInferenceRecommendationsJobStepsResponse listInferenceRecommendationsJobSteps(ListInferenceRecommendationsJobStepsRequest listInferenceRecommendationsJobStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListInferenceRecommendationsJobSteps operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobSteps
default ListInferenceRecommendationsJobStepsResponse listInferenceRecommendationsJobSteps(Consumer<ListInferenceRecommendationsJobStepsRequest.Builder> listInferenceRecommendationsJobStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListInferenceRecommendationsJobStepsRequest.builder()
- Parameters:
listInferenceRecommendationsJobStepsRequest
- AConsumer
that will call methods onListInferenceRecommendationsJobStepsRequest.Builder
to create a request.- Returns:
- Result of the ListInferenceRecommendationsJobSteps operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobStepsPaginator
default ListInferenceRecommendationsJobStepsIterable listInferenceRecommendationsJobStepsPaginator(ListInferenceRecommendationsJobStepsRequest listInferenceRecommendationsJobStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client.listInferenceRecommendationsJobStepsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client .listInferenceRecommendationsJobStepsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client.listInferenceRecommendationsJobStepsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobStepsPaginator
default ListInferenceRecommendationsJobStepsIterable listInferenceRecommendationsJobStepsPaginator(Consumer<ListInferenceRecommendationsJobStepsRequest.Builder> listInferenceRecommendationsJobStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceRecommendationsJobSteps(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client.listInferenceRecommendationsJobStepsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client .listInferenceRecommendationsJobStepsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobStepsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobStepsIterable responses = client.listInferenceRecommendationsJobStepsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListInferenceRecommendationsJobStepsRequest.builder()
- Parameters:
listInferenceRecommendationsJobStepsRequest
- AConsumer
that will call methods onListInferenceRecommendationsJobStepsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobs
default ListInferenceRecommendationsJobsResponse listInferenceRecommendationsJobs(ListInferenceRecommendationsJobsRequest listInferenceRecommendationsJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists recommendation jobs that satisfy various filters.
- Parameters:
listInferenceRecommendationsJobsRequest
-- Returns:
- Result of the ListInferenceRecommendationsJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobs
default ListInferenceRecommendationsJobsResponse listInferenceRecommendationsJobs(Consumer<ListInferenceRecommendationsJobsRequest.Builder> listInferenceRecommendationsJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListInferenceRecommendationsJobsRequest.builder()
- Parameters:
listInferenceRecommendationsJobsRequest
- AConsumer
that will call methods onListInferenceRecommendationsJobsRequest.Builder
to create a request.- Returns:
- Result of the ListInferenceRecommendationsJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobsPaginator
default ListInferenceRecommendationsJobsIterable listInferenceRecommendationsJobsPaginator(ListInferenceRecommendationsJobsRequest listInferenceRecommendationsJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client.listInferenceRecommendationsJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client .listInferenceRecommendationsJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client.listInferenceRecommendationsJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listInferenceRecommendationsJobsPaginator
default ListInferenceRecommendationsJobsIterable listInferenceRecommendationsJobsPaginator(Consumer<ListInferenceRecommendationsJobsRequest.Builder> listInferenceRecommendationsJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listInferenceRecommendationsJobs(software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client.listInferenceRecommendationsJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client .listInferenceRecommendationsJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListInferenceRecommendationsJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListInferenceRecommendationsJobsIterable responses = client.listInferenceRecommendationsJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListInferenceRecommendationsJobsRequest.builder()
- Parameters:
listInferenceRecommendationsJobsRequest
- AConsumer
that will call methods onListInferenceRecommendationsJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobs
default ListLabelingJobsResponse listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
- Parameters:
listLabelingJobsRequest
-- Returns:
- Result of the ListLabelingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobs
default ListLabelingJobsResponse listLabelingJobs(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListLabelingJobsRequest.builder()
- Parameters:
listLabelingJobsRequest
- AConsumer
that will call methods onListLabelingJobsRequest.Builder
to create a request.- Returns:
- Result of the ListLabelingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobs
default ListLabelingJobsResponse listLabelingJobs() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
- Returns:
- Result of the ListLabelingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listLabelingJobs(ListLabelingJobsRequest)
, AWS API Documentation
-
listLabelingJobsPaginator
default ListLabelingJobsIterable listLabelingJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client .listLabelingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listLabelingJobsPaginator(ListLabelingJobsRequest)
, AWS API Documentation
-
listLabelingJobsPaginator
default ListLabelingJobsIterable listLabelingJobsPaginator(ListLabelingJobsRequest listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client .listLabelingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobsPaginator
default ListLabelingJobsIterable listLabelingJobsPaginator(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client .listLabelingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListLabelingJobsRequest.builder()
- Parameters:
listLabelingJobsRequest
- AConsumer
that will call methods onListLabelingJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobsForWorkteam
default ListLabelingJobsForWorkteamResponse listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs assigned to a specified work team.
- Parameters:
listLabelingJobsForWorkteamRequest
-- Returns:
- Result of the ListLabelingJobsForWorkteam operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobsForWorkteam
default ListLabelingJobsForWorkteamResponse listLabelingJobsForWorkteam(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListLabelingJobsForWorkteamRequest.builder()
- Parameters:
listLabelingJobsForWorkteamRequest
- AConsumer
that will call methods onListLabelingJobsForWorkteamRequest.Builder
to create a request.- Returns:
- Result of the ListLabelingJobsForWorkteam operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobsForWorkteamPaginator
default ListLabelingJobsForWorkteamIterable listLabelingJobsForWorkteamPaginator(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client .listLabelingJobsForWorkteamPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLabelingJobsForWorkteamPaginator
default ListLabelingJobsForWorkteamIterable listLabelingJobsForWorkteamPaginator(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client .listLabelingJobsForWorkteamPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListLabelingJobsForWorkteamRequest.builder()
- Parameters:
listLabelingJobsForWorkteamRequest
- AConsumer
that will call methods onListLabelingJobsForWorkteamRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLineageGroups
default ListLineageGroupsResponse listLineageGroups(ListLineageGroupsRequest listLineageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListLineageGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLineageGroups
default ListLineageGroupsResponse listLineageGroups(Consumer<ListLineageGroupsRequest.Builder> listLineageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListLineageGroupsRequest.builder()
- Parameters:
listLineageGroupsRequest
- AConsumer
that will call methods onListLineageGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListLineageGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLineageGroupsPaginator
default ListLineageGroupsIterable listLineageGroupsPaginator(ListLineageGroupsRequest listLineageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client.listLineageGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client .listLineageGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client.listLineageGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listLineageGroupsPaginator
default ListLineageGroupsIterable listLineageGroupsPaginator(Consumer<ListLineageGroupsRequest.Builder> listLineageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listLineageGroups(software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client.listLineageGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client .listLineageGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListLineageGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListLineageGroupsIterable responses = client.listLineageGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListLineageGroupsRequest.builder()
- Parameters:
listLineageGroupsRequest
- AConsumer
that will call methods onListLineageGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMlflowTrackingServers
default ListMlflowTrackingServersResponse listMlflowTrackingServers(ListMlflowTrackingServersRequest listMlflowTrackingServersRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all MLflow Tracking Servers.
- Parameters:
listMlflowTrackingServersRequest
-- Returns:
- Result of the ListMlflowTrackingServers operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMlflowTrackingServers
default ListMlflowTrackingServersResponse listMlflowTrackingServers(Consumer<ListMlflowTrackingServersRequest.Builder> listMlflowTrackingServersRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all MLflow Tracking Servers.
This is a convenience which creates an instance of the
ListMlflowTrackingServersRequest.Builder
avoiding the need to create one manually viaListMlflowTrackingServersRequest.builder()
- Parameters:
listMlflowTrackingServersRequest
- AConsumer
that will call methods onListMlflowTrackingServersRequest.Builder
to create a request.- Returns:
- Result of the ListMlflowTrackingServers operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMlflowTrackingServersPaginator
default ListMlflowTrackingServersIterable listMlflowTrackingServersPaginator(ListMlflowTrackingServersRequest listMlflowTrackingServersRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMlflowTrackingServers(software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client.listMlflowTrackingServersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client .listMlflowTrackingServersPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client.listMlflowTrackingServersPaginator(request); responses.iterator().forEachRemaining(....);
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
listMlflowTrackingServers(software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersRequest)
operation.- Parameters:
listMlflowTrackingServersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMlflowTrackingServersPaginator
default ListMlflowTrackingServersIterable listMlflowTrackingServersPaginator(Consumer<ListMlflowTrackingServersRequest.Builder> listMlflowTrackingServersRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMlflowTrackingServers(software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client.listMlflowTrackingServersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client .listMlflowTrackingServersPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMlflowTrackingServersIterable responses = client.listMlflowTrackingServersPaginator(request); responses.iterator().forEachRemaining(....);
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
listMlflowTrackingServers(software.amazon.awssdk.services.sagemaker.model.ListMlflowTrackingServersRequest)
operation.
This is a convenience which creates an instance of the
ListMlflowTrackingServersRequest.Builder
avoiding the need to create one manually viaListMlflowTrackingServersRequest.builder()
- Parameters:
listMlflowTrackingServersRequest
- AConsumer
that will call methods onListMlflowTrackingServersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelBiasJobDefinitions
default ListModelBiasJobDefinitionsResponse listModelBiasJobDefinitions(ListModelBiasJobDefinitionsRequest listModelBiasJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists model bias jobs definitions that satisfy various filters.
- Parameters:
listModelBiasJobDefinitionsRequest
-- Returns:
- Result of the ListModelBiasJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelBiasJobDefinitions
default ListModelBiasJobDefinitionsResponse listModelBiasJobDefinitions(Consumer<ListModelBiasJobDefinitionsRequest.Builder> listModelBiasJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelBiasJobDefinitionsRequest.builder()
- Parameters:
listModelBiasJobDefinitionsRequest
- AConsumer
that will call methods onListModelBiasJobDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListModelBiasJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelBiasJobDefinitionsPaginator
default ListModelBiasJobDefinitionsIterable listModelBiasJobDefinitionsPaginator(ListModelBiasJobDefinitionsRequest listModelBiasJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client.listModelBiasJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client .listModelBiasJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client.listModelBiasJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelBiasJobDefinitionsPaginator
default ListModelBiasJobDefinitionsIterable listModelBiasJobDefinitionsPaginator(Consumer<ListModelBiasJobDefinitionsRequest.Builder> listModelBiasJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelBiasJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client.listModelBiasJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client .listModelBiasJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelBiasJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelBiasJobDefinitionsIterable responses = client.listModelBiasJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelBiasJobDefinitionsRequest.builder()
- Parameters:
listModelBiasJobDefinitionsRequest
- AConsumer
that will call methods onListModelBiasJobDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardExportJobs
default ListModelCardExportJobsResponse listModelCardExportJobs(ListModelCardExportJobsRequest listModelCardExportJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List the export jobs for the Amazon SageMaker Model Card.
- Parameters:
listModelCardExportJobsRequest
-- Returns:
- Result of the ListModelCardExportJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardExportJobs
default ListModelCardExportJobsResponse listModelCardExportJobs(Consumer<ListModelCardExportJobsRequest.Builder> listModelCardExportJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelCardExportJobsRequest.builder()
- Parameters:
listModelCardExportJobsRequest
- AConsumer
that will call methods onListModelCardExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListModelCardExportJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardExportJobsPaginator
default ListModelCardExportJobsIterable listModelCardExportJobsPaginator(ListModelCardExportJobsRequest listModelCardExportJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client.listModelCardExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client .listModelCardExportJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client.listModelCardExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardExportJobsPaginator
default ListModelCardExportJobsIterable listModelCardExportJobsPaginator(Consumer<ListModelCardExportJobsRequest.Builder> listModelCardExportJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCardExportJobs(software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client.listModelCardExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client .listModelCardExportJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardExportJobsIterable responses = client.listModelCardExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelCardExportJobsRequest.builder()
- Parameters:
listModelCardExportJobsRequest
- AConsumer
that will call methods onListModelCardExportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardVersions
default ListModelCardVersionsResponse listModelCardVersions(ListModelCardVersionsRequest listModelCardVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
List existing versions of an Amazon SageMaker Model Card.
- Parameters:
listModelCardVersionsRequest
-- Returns:
- Result of the ListModelCardVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardVersions
default ListModelCardVersionsResponse listModelCardVersions(Consumer<ListModelCardVersionsRequest.Builder> listModelCardVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListModelCardVersionsRequest.builder()
- Parameters:
listModelCardVersionsRequest
- AConsumer
that will call methods onListModelCardVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListModelCardVersions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardVersionsPaginator
default ListModelCardVersionsIterable listModelCardVersionsPaginator(ListModelCardVersionsRequest listModelCardVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client.listModelCardVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client .listModelCardVersionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client.listModelCardVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardVersionsPaginator
default ListModelCardVersionsIterable listModelCardVersionsPaginator(Consumer<ListModelCardVersionsRequest.Builder> listModelCardVersionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCardVersions(software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client.listModelCardVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client .listModelCardVersionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardVersionsIterable responses = client.listModelCardVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelCardVersionsRequest.builder()
- Parameters:
listModelCardVersionsRequest
- AConsumer
that will call methods onListModelCardVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCards
default ListModelCardsResponse listModelCards(ListModelCardsRequest listModelCardsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List existing model cards.
- Parameters:
listModelCardsRequest
-- Returns:
- Result of the ListModelCards operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCards
default ListModelCardsResponse listModelCards(Consumer<ListModelCardsRequest.Builder> listModelCardsRequest) throws AwsServiceException, SdkClientException, SageMakerException
List existing model cards.
This is a convenience which creates an instance of the
ListModelCardsRequest.Builder
avoiding the need to create one manually viaListModelCardsRequest.builder()
- Parameters:
listModelCardsRequest
- AConsumer
that will call methods onListModelCardsRequest.Builder
to create a request.- Returns:
- Result of the ListModelCards operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardsPaginator
default ListModelCardsIterable listModelCardsPaginator(ListModelCardsRequest listModelCardsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client.listModelCardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client .listModelCardsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client.listModelCardsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelCardsPaginator
default ListModelCardsIterable listModelCardsPaginator(Consumer<ListModelCardsRequest.Builder> listModelCardsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelCards(software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client.listModelCardsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client .listModelCardsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelCardsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelCardsIterable responses = client.listModelCardsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelCardsRequest.builder()
- Parameters:
listModelCardsRequest
- AConsumer
that will call methods onListModelCardsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelExplainabilityJobDefinitions
default ListModelExplainabilityJobDefinitionsResponse listModelExplainabilityJobDefinitions(ListModelExplainabilityJobDefinitionsRequest listModelExplainabilityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists model explainability job definitions that satisfy various filters.
- Parameters:
listModelExplainabilityJobDefinitionsRequest
-- Returns:
- Result of the ListModelExplainabilityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelExplainabilityJobDefinitions
default ListModelExplainabilityJobDefinitionsResponse listModelExplainabilityJobDefinitions(Consumer<ListModelExplainabilityJobDefinitionsRequest.Builder> listModelExplainabilityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelExplainabilityJobDefinitionsRequest.builder()
- Parameters:
listModelExplainabilityJobDefinitionsRequest
- AConsumer
that will call methods onListModelExplainabilityJobDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListModelExplainabilityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelExplainabilityJobDefinitionsPaginator
default ListModelExplainabilityJobDefinitionsIterable listModelExplainabilityJobDefinitionsPaginator(ListModelExplainabilityJobDefinitionsRequest listModelExplainabilityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client.listModelExplainabilityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client .listModelExplainabilityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client.listModelExplainabilityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelExplainabilityJobDefinitionsPaginator
default ListModelExplainabilityJobDefinitionsIterable listModelExplainabilityJobDefinitionsPaginator(Consumer<ListModelExplainabilityJobDefinitionsRequest.Builder> listModelExplainabilityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelExplainabilityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client.listModelExplainabilityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client .listModelExplainabilityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelExplainabilityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelExplainabilityJobDefinitionsIterable responses = client.listModelExplainabilityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelExplainabilityJobDefinitionsRequest.builder()
- Parameters:
listModelExplainabilityJobDefinitionsRequest
- AConsumer
that will call methods onListModelExplainabilityJobDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelMetadata
default ListModelMetadataResponse listModelMetadata(ListModelMetadataRequest listModelMetadataRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
- Parameters:
listModelMetadataRequest
-- Returns:
- Result of the ListModelMetadata operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelMetadata
default ListModelMetadataResponse listModelMetadata(Consumer<ListModelMetadataRequest.Builder> listModelMetadataRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelMetadataRequest.builder()
- Parameters:
listModelMetadataRequest
- AConsumer
that will call methods onListModelMetadataRequest.Builder
to create a request.- Returns:
- Result of the ListModelMetadata operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelMetadataPaginator
default ListModelMetadataIterable listModelMetadataPaginator(ListModelMetadataRequest listModelMetadataRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client.listModelMetadataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client .listModelMetadataPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client.listModelMetadataPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelMetadataPaginator
default ListModelMetadataIterable listModelMetadataPaginator(Consumer<ListModelMetadataRequest.Builder> listModelMetadataRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelMetadata(software.amazon.awssdk.services.sagemaker.model.ListModelMetadataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client.listModelMetadataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client .listModelMetadataPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelMetadataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelMetadataIterable responses = client.listModelMetadataPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelMetadataRequest.builder()
- Parameters:
listModelMetadataRequest
- AConsumer
that will call methods onListModelMetadataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackageGroups
default ListModelPackageGroupsResponse listModelPackageGroups(ListModelPackageGroupsRequest listModelPackageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the model groups in your Amazon Web Services account.
- Parameters:
listModelPackageGroupsRequest
-- Returns:
- Result of the ListModelPackageGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackageGroups
default ListModelPackageGroupsResponse listModelPackageGroups(Consumer<ListModelPackageGroupsRequest.Builder> listModelPackageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelPackageGroupsRequest.builder()
- Parameters:
listModelPackageGroupsRequest
- AConsumer
that will call methods onListModelPackageGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListModelPackageGroups operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackageGroupsPaginator
default ListModelPackageGroupsIterable listModelPackageGroupsPaginator(ListModelPackageGroupsRequest listModelPackageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client.listModelPackageGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client .listModelPackageGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client.listModelPackageGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackageGroupsPaginator
default ListModelPackageGroupsIterable listModelPackageGroupsPaginator(Consumer<ListModelPackageGroupsRequest.Builder> listModelPackageGroupsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelPackageGroups(software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client.listModelPackageGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client .listModelPackageGroupsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelPackageGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackageGroupsIterable responses = client.listModelPackageGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelPackageGroupsRequest.builder()
- Parameters:
listModelPackageGroupsRequest
- AConsumer
that will call methods onListModelPackageGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackages
default ListModelPackagesResponse listModelPackages(ListModelPackagesRequest listModelPackagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the model packages that have been created.
- Parameters:
listModelPackagesRequest
-- Returns:
- Result of the ListModelPackages operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackages
default ListModelPackagesResponse listModelPackages(Consumer<ListModelPackagesRequest.Builder> listModelPackagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelPackagesRequest.builder()
- Parameters:
listModelPackagesRequest
- AConsumer
that will call methods onListModelPackagesRequest.Builder
to create a request.- Returns:
- Result of the ListModelPackages operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackages
default ListModelPackagesResponse listModelPackages() throws AwsServiceException, SdkClientException, SageMakerException
Lists the model packages that have been created.
- Returns:
- Result of the ListModelPackages operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listModelPackages(ListModelPackagesRequest)
, AWS API Documentation
-
listModelPackagesPaginator
default ListModelPackagesIterable listModelPackagesPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client .listModelPackagesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listModelPackagesPaginator(ListModelPackagesRequest)
, AWS API Documentation
-
listModelPackagesPaginator
default ListModelPackagesIterable listModelPackagesPaginator(ListModelPackagesRequest listModelPackagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client .listModelPackagesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelPackagesPaginator
default ListModelPackagesIterable listModelPackagesPaginator(Consumer<ListModelPackagesRequest.Builder> listModelPackagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelPackages(software.amazon.awssdk.services.sagemaker.model.ListModelPackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client .listModelPackagesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelPackagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelPackagesIterable responses = client.listModelPackagesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelPackagesRequest.builder()
- Parameters:
listModelPackagesRequest
- AConsumer
that will call methods onListModelPackagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelQualityJobDefinitions
default ListModelQualityJobDefinitionsResponse listModelQualityJobDefinitions(ListModelQualityJobDefinitionsRequest listModelQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of model quality monitoring job definitions in your account.
- Parameters:
listModelQualityJobDefinitionsRequest
-- Returns:
- Result of the ListModelQualityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelQualityJobDefinitions
default ListModelQualityJobDefinitionsResponse listModelQualityJobDefinitions(Consumer<ListModelQualityJobDefinitionsRequest.Builder> listModelQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelQualityJobDefinitionsRequest.builder()
- Parameters:
listModelQualityJobDefinitionsRequest
- AConsumer
that will call methods onListModelQualityJobDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListModelQualityJobDefinitions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelQualityJobDefinitionsPaginator
default ListModelQualityJobDefinitionsIterable listModelQualityJobDefinitionsPaginator(ListModelQualityJobDefinitionsRequest listModelQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client.listModelQualityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client .listModelQualityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client.listModelQualityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelQualityJobDefinitionsPaginator
default ListModelQualityJobDefinitionsIterable listModelQualityJobDefinitionsPaginator(Consumer<ListModelQualityJobDefinitionsRequest.Builder> listModelQualityJobDefinitionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModelQualityJobDefinitions(software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client.listModelQualityJobDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client .listModelQualityJobDefinitionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelQualityJobDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelQualityJobDefinitionsIterable responses = client.listModelQualityJobDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelQualityJobDefinitionsRequest.builder()
- Parameters:
listModelQualityJobDefinitionsRequest
- AConsumer
that will call methods onListModelQualityJobDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModels
default ListModelsResponse listModels(ListModelsRequest listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the
CreateModel
API.- Parameters:
listModelsRequest
-- Returns:
- Result of the ListModels operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModels
default ListModelsResponse listModels(Consumer<ListModelsRequest.Builder> listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListModelsRequest.builder()
- Parameters:
listModelsRequest
- AConsumer
that will call methods onListModelsRequest.Builder
to create a request.- Returns:
- Result of the ListModels operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModels
default ListModelsResponse listModels() throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the
CreateModel
API.- Returns:
- Result of the ListModels operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listModels(ListModelsRequest)
, AWS API Documentation
-
listModelsPaginator
default ListModelsIterable listModelsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listModelsPaginator(ListModelsRequest)
, AWS API Documentation
-
listModelsPaginator
default ListModelsIterable listModelsPaginator(ListModelsRequest listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listModelsPaginator
default ListModelsIterable listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListModelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListModelsRequest.builder()
- Parameters:
listModelsRequest
- AConsumer
that will call methods onListModelsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertHistory
default ListMonitoringAlertHistoryResponse listMonitoringAlertHistory(ListMonitoringAlertHistoryRequest listMonitoringAlertHistoryRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of past alerts in a model monitoring schedule.
- Parameters:
listMonitoringAlertHistoryRequest
-- Returns:
- Result of the ListMonitoringAlertHistory operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertHistory
default ListMonitoringAlertHistoryResponse listMonitoringAlertHistory(Consumer<ListMonitoringAlertHistoryRequest.Builder> listMonitoringAlertHistoryRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListMonitoringAlertHistoryRequest.builder()
- Parameters:
listMonitoringAlertHistoryRequest
- AConsumer
that will call methods onListMonitoringAlertHistoryRequest.Builder
to create a request.- Returns:
- Result of the ListMonitoringAlertHistory operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertHistoryPaginator
default ListMonitoringAlertHistoryIterable listMonitoringAlertHistoryPaginator(ListMonitoringAlertHistoryRequest listMonitoringAlertHistoryRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client.listMonitoringAlertHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client .listMonitoringAlertHistoryPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client.listMonitoringAlertHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertHistoryPaginator
default ListMonitoringAlertHistoryIterable listMonitoringAlertHistoryPaginator(Consumer<ListMonitoringAlertHistoryRequest.Builder> listMonitoringAlertHistoryRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringAlertHistory(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client.listMonitoringAlertHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client .listMonitoringAlertHistoryPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertHistoryIterable responses = client.listMonitoringAlertHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListMonitoringAlertHistoryRequest.builder()
- Parameters:
listMonitoringAlertHistoryRequest
- AConsumer
that will call methods onListMonitoringAlertHistoryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlerts
default ListMonitoringAlertsResponse listMonitoringAlerts(ListMonitoringAlertsRequest listMonitoringAlertsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets the alerts for a single monitoring schedule.
- Parameters:
listMonitoringAlertsRequest
-- Returns:
- Result of the ListMonitoringAlerts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlerts
default ListMonitoringAlertsResponse listMonitoringAlerts(Consumer<ListMonitoringAlertsRequest.Builder> listMonitoringAlertsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListMonitoringAlertsRequest.builder()
- Parameters:
listMonitoringAlertsRequest
- AConsumer
that will call methods onListMonitoringAlertsRequest.Builder
to create a request.- Returns:
- Result of the ListMonitoringAlerts operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertsPaginator
default ListMonitoringAlertsIterable listMonitoringAlertsPaginator(ListMonitoringAlertsRequest listMonitoringAlertsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client.listMonitoringAlertsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client .listMonitoringAlertsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client.listMonitoringAlertsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringAlertsPaginator
default ListMonitoringAlertsIterable listMonitoringAlertsPaginator(Consumer<ListMonitoringAlertsRequest.Builder> listMonitoringAlertsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringAlerts(software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client.listMonitoringAlertsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client .listMonitoringAlertsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringAlertsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringAlertsIterable responses = client.listMonitoringAlertsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListMonitoringAlertsRequest.builder()
- Parameters:
listMonitoringAlertsRequest
- AConsumer
that will call methods onListMonitoringAlertsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringExecutions
default ListMonitoringExecutionsResponse listMonitoringExecutions(ListMonitoringExecutionsRequest listMonitoringExecutionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns list of all monitoring job executions.
- Parameters:
listMonitoringExecutionsRequest
-- Returns:
- Result of the ListMonitoringExecutions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringExecutions
default ListMonitoringExecutionsResponse listMonitoringExecutions(Consumer<ListMonitoringExecutionsRequest.Builder> listMonitoringExecutionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListMonitoringExecutionsRequest.builder()
- Parameters:
listMonitoringExecutionsRequest
- AConsumer
that will call methods onListMonitoringExecutionsRequest.Builder
to create a request.- Returns:
- Result of the ListMonitoringExecutions operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringExecutionsPaginator
default ListMonitoringExecutionsIterable listMonitoringExecutionsPaginator(ListMonitoringExecutionsRequest listMonitoringExecutionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client.listMonitoringExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client .listMonitoringExecutionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client.listMonitoringExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringExecutionsPaginator
default ListMonitoringExecutionsIterable listMonitoringExecutionsPaginator(Consumer<ListMonitoringExecutionsRequest.Builder> listMonitoringExecutionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringExecutions(software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client.listMonitoringExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client .listMonitoringExecutionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringExecutionsIterable responses = client.listMonitoringExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListMonitoringExecutionsRequest.builder()
- Parameters:
listMonitoringExecutionsRequest
- AConsumer
that will call methods onListMonitoringExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringSchedules
default ListMonitoringSchedulesResponse listMonitoringSchedules(ListMonitoringSchedulesRequest listMonitoringSchedulesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns list of all monitoring schedules.
- Parameters:
listMonitoringSchedulesRequest
-- Returns:
- Result of the ListMonitoringSchedules operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringSchedules
default ListMonitoringSchedulesResponse listMonitoringSchedules(Consumer<ListMonitoringSchedulesRequest.Builder> listMonitoringSchedulesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListMonitoringSchedulesRequest.builder()
- Parameters:
listMonitoringSchedulesRequest
- AConsumer
that will call methods onListMonitoringSchedulesRequest.Builder
to create a request.- Returns:
- Result of the ListMonitoringSchedules operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringSchedulesPaginator
default ListMonitoringSchedulesIterable listMonitoringSchedulesPaginator(ListMonitoringSchedulesRequest listMonitoringSchedulesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client.listMonitoringSchedulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client .listMonitoringSchedulesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client.listMonitoringSchedulesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listMonitoringSchedulesPaginator
default ListMonitoringSchedulesIterable listMonitoringSchedulesPaginator(Consumer<ListMonitoringSchedulesRequest.Builder> listMonitoringSchedulesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listMonitoringSchedules(software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client.listMonitoringSchedulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client .listMonitoringSchedulesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListMonitoringSchedulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListMonitoringSchedulesIterable responses = client.listMonitoringSchedulesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListMonitoringSchedulesRequest.builder()
- Parameters:
listMonitoringSchedulesRequest
- AConsumer
that will call methods onListMonitoringSchedulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstanceLifecycleConfigs
default ListNotebookInstanceLifecycleConfigsResponse listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
- Parameters:
listNotebookInstanceLifecycleConfigsRequest
-- Returns:
- Result of the ListNotebookInstanceLifecycleConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstanceLifecycleConfigs
default ListNotebookInstanceLifecycleConfigsResponse listNotebookInstanceLifecycleConfigs(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListNotebookInstanceLifecycleConfigsRequest.builder()
- Parameters:
listNotebookInstanceLifecycleConfigsRequest
- AConsumer
that will call methods onListNotebookInstanceLifecycleConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListNotebookInstanceLifecycleConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstanceLifecycleConfigs
default ListNotebookInstanceLifecycleConfigsResponse listNotebookInstanceLifecycleConfigs() throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
- Returns:
- Result of the ListNotebookInstanceLifecycleConfigs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest)
, AWS API Documentation
-
listNotebookInstanceLifecycleConfigsPaginator
default ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client .listNotebookInstanceLifecycleConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest)
, AWS API Documentation
-
listNotebookInstanceLifecycleConfigsPaginator
default ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client .listNotebookInstanceLifecycleConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstanceLifecycleConfigsPaginator
default ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client .listNotebookInstanceLifecycleConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListNotebookInstanceLifecycleConfigsRequest.builder()
- Parameters:
listNotebookInstanceLifecycleConfigsRequest
- AConsumer
that will call methods onListNotebookInstanceLifecycleConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstances
default ListNotebookInstancesResponse listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.
- Parameters:
listNotebookInstancesRequest
-- Returns:
- Result of the ListNotebookInstances operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstances
default ListNotebookInstancesResponse listNotebookInstances(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the SageMaker AI 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 viaListNotebookInstancesRequest.builder()
- Parameters:
listNotebookInstancesRequest
- AConsumer
that will call methods onListNotebookInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListNotebookInstances operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstances
default ListNotebookInstancesResponse listNotebookInstances() throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.
- Returns:
- Result of the ListNotebookInstances operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listNotebookInstances(ListNotebookInstancesRequest)
, AWS API Documentation
-
listNotebookInstancesPaginator
default ListNotebookInstancesIterable listNotebookInstancesPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client .listNotebookInstancesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listNotebookInstancesPaginator(ListNotebookInstancesRequest)
, AWS API Documentation
-
listNotebookInstancesPaginator
default ListNotebookInstancesIterable listNotebookInstancesPaginator(ListNotebookInstancesRequest listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client .listNotebookInstancesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listNotebookInstancesPaginator
default ListNotebookInstancesIterable listNotebookInstancesPaginator(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client .listNotebookInstancesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListNotebookInstancesRequest.builder()
- Parameters:
listNotebookInstancesRequest
- AConsumer
that will call methods onListNotebookInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOptimizationJobs
default ListOptimizationJobsResponse listOptimizationJobs(ListOptimizationJobsRequest listOptimizationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the optimization jobs in your account and their properties.
- Parameters:
listOptimizationJobsRequest
-- Returns:
- Result of the ListOptimizationJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOptimizationJobs
default ListOptimizationJobsResponse listOptimizationJobs(Consumer<ListOptimizationJobsRequest.Builder> listOptimizationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the optimization jobs in your account and their properties.
This is a convenience which creates an instance of the
ListOptimizationJobsRequest.Builder
avoiding the need to create one manually viaListOptimizationJobsRequest.builder()
- Parameters:
listOptimizationJobsRequest
- AConsumer
that will call methods onListOptimizationJobsRequest.Builder
to create a request.- Returns:
- Result of the ListOptimizationJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOptimizationJobsPaginator
default ListOptimizationJobsIterable listOptimizationJobsPaginator(ListOptimizationJobsRequest listOptimizationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listOptimizationJobs(software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client.listOptimizationJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client .listOptimizationJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client.listOptimizationJobsPaginator(request); responses.iterator().forEachRemaining(....);
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
listOptimizationJobs(software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsRequest)
operation.- Parameters:
listOptimizationJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOptimizationJobsPaginator
default ListOptimizationJobsIterable listOptimizationJobsPaginator(Consumer<ListOptimizationJobsRequest.Builder> listOptimizationJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listOptimizationJobs(software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client.listOptimizationJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client .listOptimizationJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListOptimizationJobsIterable responses = client.listOptimizationJobsPaginator(request); responses.iterator().forEachRemaining(....);
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
listOptimizationJobs(software.amazon.awssdk.services.sagemaker.model.ListOptimizationJobsRequest)
operation.
This is a convenience which creates an instance of the
ListOptimizationJobsRequest.Builder
avoiding the need to create one manually viaListOptimizationJobsRequest.builder()
- Parameters:
listOptimizationJobsRequest
- AConsumer
that will call methods onListOptimizationJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPartnerApps
default ListPartnerAppsResponse listPartnerApps(ListPartnerAppsRequest listPartnerAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all of the SageMaker Partner AI Apps in an account.
- Parameters:
listPartnerAppsRequest
-- Returns:
- Result of the ListPartnerApps operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPartnerApps
default ListPartnerAppsResponse listPartnerApps(Consumer<ListPartnerAppsRequest.Builder> listPartnerAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists all of the SageMaker Partner AI Apps in an account.
This is a convenience which creates an instance of the
ListPartnerAppsRequest.Builder
avoiding the need to create one manually viaListPartnerAppsRequest.builder()
- Parameters:
listPartnerAppsRequest
- AConsumer
that will call methods onListPartnerAppsRequest.Builder
to create a request.- Returns:
- Result of the ListPartnerApps operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPartnerAppsPaginator
default ListPartnerAppsIterable listPartnerAppsPaginator(ListPartnerAppsRequest listPartnerAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPartnerApps(software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client.listPartnerAppsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client .listPartnerAppsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client.listPartnerAppsPaginator(request); responses.iterator().forEachRemaining(....);
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
listPartnerApps(software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsRequest)
operation.- Parameters:
listPartnerAppsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPartnerAppsPaginator
default ListPartnerAppsIterable listPartnerAppsPaginator(Consumer<ListPartnerAppsRequest.Builder> listPartnerAppsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPartnerApps(software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client.listPartnerAppsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client .listPartnerAppsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPartnerAppsIterable responses = client.listPartnerAppsPaginator(request); responses.iterator().forEachRemaining(....);
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
listPartnerApps(software.amazon.awssdk.services.sagemaker.model.ListPartnerAppsRequest)
operation.
This is a convenience which creates an instance of the
ListPartnerAppsRequest.Builder
avoiding the need to create one manually viaListPartnerAppsRequest.builder()
- Parameters:
listPartnerAppsRequest
- AConsumer
that will call methods onListPartnerAppsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionSteps
default ListPipelineExecutionStepsResponse listPipelineExecutionSteps(ListPipelineExecutionStepsRequest listPipelineExecutionStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of
PipeLineExecutionStep
objects.- Parameters:
listPipelineExecutionStepsRequest
-- Returns:
- Result of the ListPipelineExecutionSteps operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionSteps
default ListPipelineExecutionStepsResponse listPipelineExecutionSteps(Consumer<ListPipelineExecutionStepsRequest.Builder> listPipelineExecutionStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListPipelineExecutionStepsRequest.builder()
- Parameters:
listPipelineExecutionStepsRequest
- AConsumer
that will call methods onListPipelineExecutionStepsRequest.Builder
to create a request.- Returns:
- Result of the ListPipelineExecutionSteps operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionStepsPaginator
default ListPipelineExecutionStepsIterable listPipelineExecutionStepsPaginator(ListPipelineExecutionStepsRequest listPipelineExecutionStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client.listPipelineExecutionStepsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client .listPipelineExecutionStepsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client.listPipelineExecutionStepsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionStepsPaginator
default ListPipelineExecutionStepsIterable listPipelineExecutionStepsPaginator(Consumer<ListPipelineExecutionStepsRequest.Builder> listPipelineExecutionStepsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineExecutionSteps(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client.listPipelineExecutionStepsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client .listPipelineExecutionStepsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionStepsIterable responses = client.listPipelineExecutionStepsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPipelineExecutionStepsRequest.builder()
- Parameters:
listPipelineExecutionStepsRequest
- AConsumer
that will call methods onListPipelineExecutionStepsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutions
default ListPipelineExecutionsResponse listPipelineExecutions(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of the pipeline executions.
- Parameters:
listPipelineExecutionsRequest
-- Returns:
- Result of the ListPipelineExecutions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutions
default ListPipelineExecutionsResponse listPipelineExecutions(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request.- Returns:
- Result of the ListPipelineExecutions operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsIterable listPipelineExecutionsPaginator(ListPipelineExecutionsRequest listPipelineExecutionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client .listPipelineExecutionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineExecutionsPaginator
default ListPipelineExecutionsIterable listPipelineExecutionsPaginator(Consumer<ListPipelineExecutionsRequest.Builder> listPipelineExecutionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineExecutions(software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client .listPipelineExecutionsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineExecutionsIterable responses = client.listPipelineExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPipelineExecutionsRequest.builder()
- Parameters:
listPipelineExecutionsRequest
- AConsumer
that will call methods onListPipelineExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineParametersForExecution
default ListPipelineParametersForExecutionResponse listPipelineParametersForExecution(ListPipelineParametersForExecutionRequest listPipelineParametersForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of parameters for a pipeline execution.
- Parameters:
listPipelineParametersForExecutionRequest
-- Returns:
- Result of the ListPipelineParametersForExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineParametersForExecution
default ListPipelineParametersForExecutionResponse listPipelineParametersForExecution(Consumer<ListPipelineParametersForExecutionRequest.Builder> listPipelineParametersForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListPipelineParametersForExecutionRequest.builder()
- Parameters:
listPipelineParametersForExecutionRequest
- AConsumer
that will call methods onListPipelineParametersForExecutionRequest.Builder
to create a request.- Returns:
- Result of the ListPipelineParametersForExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineParametersForExecutionPaginator
default ListPipelineParametersForExecutionIterable listPipelineParametersForExecutionPaginator(ListPipelineParametersForExecutionRequest listPipelineParametersForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client.listPipelineParametersForExecutionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client .listPipelineParametersForExecutionPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client.listPipelineParametersForExecutionPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelineParametersForExecutionPaginator
default ListPipelineParametersForExecutionIterable listPipelineParametersForExecutionPaginator(Consumer<ListPipelineParametersForExecutionRequest.Builder> listPipelineParametersForExecutionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelineParametersForExecution(software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client.listPipelineParametersForExecutionPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client .listPipelineParametersForExecutionPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelineParametersForExecutionResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelineParametersForExecutionIterable responses = client.listPipelineParametersForExecutionPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPipelineParametersForExecutionRequest.builder()
- Parameters:
listPipelineParametersForExecutionRequest
- AConsumer
that will call methods onListPipelineParametersForExecutionRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelines
default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of pipelines.
- Parameters:
listPipelinesRequest
-- Returns:
- Result of the ListPipelines operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelines
default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of pipelines.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builder
avoiding the need to create one manually viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request.- Returns:
- Result of the ListPipelines operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listPipelines(software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListPipelinesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPipelinesRequest.builder()
- Parameters:
listPipelinesRequest
- AConsumer
that will call methods onListPipelinesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProcessingJobs
default ListProcessingJobsResponse listProcessingJobs(ListProcessingJobsRequest listProcessingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists processing jobs that satisfy various filters.
- Parameters:
listProcessingJobsRequest
-- Returns:
- Result of the ListProcessingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProcessingJobs
default ListProcessingJobsResponse listProcessingJobs(Consumer<ListProcessingJobsRequest.Builder> listProcessingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListProcessingJobsRequest.builder()
- Parameters:
listProcessingJobsRequest
- AConsumer
that will call methods onListProcessingJobsRequest.Builder
to create a request.- Returns:
- Result of the ListProcessingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProcessingJobsPaginator
default ListProcessingJobsIterable listProcessingJobsPaginator(ListProcessingJobsRequest listProcessingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client.listProcessingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client .listProcessingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client.listProcessingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProcessingJobsPaginator
default ListProcessingJobsIterable listProcessingJobsPaginator(Consumer<ListProcessingJobsRequest.Builder> listProcessingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listProcessingJobs(software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client.listProcessingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client .listProcessingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListProcessingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListProcessingJobsIterable responses = client.listProcessingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListProcessingJobsRequest.builder()
- Parameters:
listProcessingJobsRequest
- AConsumer
that will call methods onListProcessingJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProjects
default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the projects in an Amazon Web Services account.
- Parameters:
listProjectsRequest
-- Returns:
- Result of the ListProjects operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProjects
default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- Result of the ListProjects operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listProjectsPaginator
default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listProjects(software.amazon.awssdk.services.sagemaker.model.ListProjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListProjectsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResourceCatalogs
default ListResourceCatalogsResponse listResourceCatalogs(ListResourceCatalogsRequest listResourceCatalogsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of
ResourceCatalog
s viewable is 1000.- Parameters:
listResourceCatalogsRequest
-- Returns:
- Result of the ListResourceCatalogs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResourceCatalogs
default ListResourceCatalogsResponse listResourceCatalogs(Consumer<ListResourceCatalogsRequest.Builder> listResourceCatalogsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of
ResourceCatalog
s viewable is 1000.
This is a convenience which creates an instance of the
ListResourceCatalogsRequest.Builder
avoiding the need to create one manually viaListResourceCatalogsRequest.builder()
- Parameters:
listResourceCatalogsRequest
- AConsumer
that will call methods onListResourceCatalogsRequest.Builder
to create a request.- Returns:
- Result of the ListResourceCatalogs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResourceCatalogsPaginator
default ListResourceCatalogsIterable listResourceCatalogsPaginator(ListResourceCatalogsRequest listResourceCatalogsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client.listResourceCatalogsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client .listResourceCatalogsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client.listResourceCatalogsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResourceCatalogsPaginator
default ListResourceCatalogsIterable listResourceCatalogsPaginator(Consumer<ListResourceCatalogsRequest.Builder> listResourceCatalogsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listResourceCatalogs(software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client.listResourceCatalogsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client .listResourceCatalogsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListResourceCatalogsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListResourceCatalogsIterable responses = client.listResourceCatalogsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListResourceCatalogsRequest.builder()
- Parameters:
listResourceCatalogsRequest
- AConsumer
that will call methods onListResourceCatalogsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSpaces
default ListSpacesResponse listSpaces(ListSpacesRequest listSpacesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists spaces.
- Parameters:
listSpacesRequest
-- Returns:
- Result of the ListSpaces operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSpaces
default ListSpacesResponse listSpaces(Consumer<ListSpacesRequest.Builder> listSpacesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists spaces.
This is a convenience which creates an instance of the
ListSpacesRequest.Builder
avoiding the need to create one manually viaListSpacesRequest.builder()
- Parameters:
listSpacesRequest
- AConsumer
that will call methods onListSpacesRequest.Builder
to create a request.- Returns:
- Result of the ListSpaces operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSpacesPaginator
default ListSpacesIterable listSpacesPaginator(ListSpacesRequest listSpacesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSpacesPaginator
default ListSpacesIterable listSpacesPaginator(Consumer<ListSpacesRequest.Builder> listSpacesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listSpaces(software.amazon.awssdk.services.sagemaker.model.ListSpacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListSpacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListSpacesIterable responses = client.listSpacesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListSpacesRequest.builder()
- Parameters:
listSpacesRequest
- AConsumer
that will call methods onListSpacesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStageDevices
default ListStageDevicesResponse listStageDevices(ListStageDevicesRequest listStageDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists devices allocated to the stage, containing detailed device information and deployment status.
- Parameters:
listStageDevicesRequest
-- Returns:
- Result of the ListStageDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStageDevices
default ListStageDevicesResponse listStageDevices(Consumer<ListStageDevicesRequest.Builder> listStageDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListStageDevicesRequest.builder()
- Parameters:
listStageDevicesRequest
- AConsumer
that will call methods onListStageDevicesRequest.Builder
to create a request.- Returns:
- Result of the ListStageDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStageDevicesPaginator
default ListStageDevicesIterable listStageDevicesPaginator(ListStageDevicesRequest listStageDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client.listStageDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client .listStageDevicesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client.listStageDevicesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStageDevicesPaginator
default ListStageDevicesIterable listStageDevicesPaginator(Consumer<ListStageDevicesRequest.Builder> listStageDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listStageDevices(software.amazon.awssdk.services.sagemaker.model.ListStageDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client.listStageDevicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client .listStageDevicesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListStageDevicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListStageDevicesIterable responses = client.listStageDevicesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListStageDevicesRequest.builder()
- Parameters:
listStageDevicesRequest
- AConsumer
that will call methods onListStageDevicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStudioLifecycleConfigs
default ListStudioLifecycleConfigsResponse listStudioLifecycleConfigs(ListStudioLifecycleConfigsRequest listStudioLifecycleConfigsRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Lists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.
- Parameters:
listStudioLifecycleConfigsRequest
-- Returns:
- Result of the ListStudioLifecycleConfigs operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
listStudioLifecycleConfigs
default ListStudioLifecycleConfigsResponse listStudioLifecycleConfigs(Consumer<ListStudioLifecycleConfigsRequest.Builder> listStudioLifecycleConfigsRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Lists the Amazon SageMaker AI 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 viaListStudioLifecycleConfigsRequest.builder()
- Parameters:
listStudioLifecycleConfigsRequest
- AConsumer
that will call methods onListStudioLifecycleConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListStudioLifecycleConfigs operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
listStudioLifecycleConfigsPaginator
default ListStudioLifecycleConfigsIterable listStudioLifecycleConfigsPaginator(ListStudioLifecycleConfigsRequest listStudioLifecycleConfigsRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client.listStudioLifecycleConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client .listStudioLifecycleConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client.listStudioLifecycleConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
listStudioLifecycleConfigsPaginator
default ListStudioLifecycleConfigsIterable listStudioLifecycleConfigsPaginator(Consumer<ListStudioLifecycleConfigsRequest.Builder> listStudioLifecycleConfigsRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listStudioLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client.listStudioLifecycleConfigsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client .listStudioLifecycleConfigsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListStudioLifecycleConfigsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListStudioLifecycleConfigsIterable responses = client.listStudioLifecycleConfigsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListStudioLifecycleConfigsRequest.builder()
- Parameters:
listStudioLifecycleConfigsRequest
- AConsumer
that will call methods onListStudioLifecycleConfigsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
listSubscribedWorkteams
default ListSubscribedWorkteamsResponse listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListSubscribedWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSubscribedWorkteams
default ListSubscribedWorkteamsResponse listSubscribedWorkteams(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListSubscribedWorkteamsRequest.builder()
- Parameters:
listSubscribedWorkteamsRequest
- AConsumer
that will call methods onListSubscribedWorkteamsRequest.Builder
to create a request.- Returns:
- Result of the ListSubscribedWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSubscribedWorkteams
default ListSubscribedWorkteamsResponse listSubscribedWorkteams() throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListSubscribedWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listSubscribedWorkteams(ListSubscribedWorkteamsRequest)
, AWS API Documentation
-
listSubscribedWorkteamsPaginator
default ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client .listSubscribedWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest)
, AWS API Documentation
-
listSubscribedWorkteamsPaginator
default ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client .listSubscribedWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listSubscribedWorkteamsPaginator
default ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client .listSubscribedWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListSubscribedWorkteamsRequest.builder()
- Parameters:
listSubscribedWorkteamsRequest
- AConsumer
that will call methods onListSubscribedWorkteamsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the tags for the specified SageMaker resource.
- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobs
default ListTrainingJobsResponse listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
When
StatusEquals
andMaxResults
are set at the same time, theMaxResults
number of training jobs are first retrieved ignoring theStatusEquals
parameter and then they are filtered by theStatusEquals
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 ofInProgress
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:
- Result of the ListTrainingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobs
default ListTrainingJobsResponse listTrainingJobs(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
When
StatusEquals
andMaxResults
are set at the same time, theMaxResults
number of training jobs are first retrieved ignoring theStatusEquals
parameter and then they are filtered by theStatusEquals
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 ofInProgress
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 viaListTrainingJobsRequest.builder()
- Parameters:
listTrainingJobsRequest
- AConsumer
that will call methods onListTrainingJobsRequest.Builder
to create a request.- Returns:
- Result of the ListTrainingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobs
default ListTrainingJobsResponse listTrainingJobs() throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
When
StatusEquals
andMaxResults
are set at the same time, theMaxResults
number of training jobs are first retrieved ignoring theStatusEquals
parameter and then they are filtered by theStatusEquals
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 ofInProgress
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:
- Result of the ListTrainingJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listTrainingJobs(ListTrainingJobsRequest)
, AWS API Documentation
-
listTrainingJobsPaginator
default ListTrainingJobsIterable listTrainingJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client .listTrainingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listTrainingJobsPaginator(ListTrainingJobsRequest)
, AWS API Documentation
-
listTrainingJobsPaginator
default ListTrainingJobsIterable listTrainingJobsPaginator(ListTrainingJobsRequest listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client .listTrainingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobsPaginator
default ListTrainingJobsIterable listTrainingJobsPaginator(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client .listTrainingJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTrainingJobsRequest.builder()
- Parameters:
listTrainingJobsRequest
- AConsumer
that will call methods onListTrainingJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobsForHyperParameterTuningJob
default ListTrainingJobsForHyperParameterTuningJobResponse listTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
- Parameters:
listTrainingJobsForHyperParameterTuningJobRequest
-- Returns:
- Result of the ListTrainingJobsForHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobsForHyperParameterTuningJob
default ListTrainingJobsForHyperParameterTuningJobResponse listTrainingJobsForHyperParameterTuningJob(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListTrainingJobsForHyperParameterTuningJobRequest.builder()
- Parameters:
listTrainingJobsForHyperParameterTuningJobRequest
- AConsumer
that will call methods onListTrainingJobsForHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- Result of the ListTrainingJobsForHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobsForHyperParameterTuningJobPaginator
default ListTrainingJobsForHyperParameterTuningJobIterable listTrainingJobsForHyperParameterTuningJobPaginator(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client .listTrainingJobsForHyperParameterTuningJobPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingJobsForHyperParameterTuningJobPaginator
default ListTrainingJobsForHyperParameterTuningJobIterable listTrainingJobsForHyperParameterTuningJobPaginator(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client .listTrainingJobsForHyperParameterTuningJobPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTrainingJobsForHyperParameterTuningJobRequest.builder()
- Parameters:
listTrainingJobsForHyperParameterTuningJobRequest
- AConsumer
that will call methods onListTrainingJobsForHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingPlans
default ListTrainingPlansResponse listTrainingPlans(ListTrainingPlansRequest listTrainingPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
Retrieves a list of training plans for the current account.
- Parameters:
listTrainingPlansRequest
-- Returns:
- Result of the ListTrainingPlans operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingPlans
default ListTrainingPlansResponse listTrainingPlans(Consumer<ListTrainingPlansRequest.Builder> listTrainingPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
Retrieves a list of training plans for the current account.
This is a convenience which creates an instance of the
ListTrainingPlansRequest.Builder
avoiding the need to create one manually viaListTrainingPlansRequest.builder()
- Parameters:
listTrainingPlansRequest
- AConsumer
that will call methods onListTrainingPlansRequest.Builder
to create a request.- Returns:
- Result of the ListTrainingPlans operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingPlansPaginator
default ListTrainingPlansIterable listTrainingPlansPaginator(ListTrainingPlansRequest listTrainingPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingPlans(software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client.listTrainingPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client .listTrainingPlansPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client.listTrainingPlansPaginator(request); responses.iterator().forEachRemaining(....);
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
listTrainingPlans(software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansRequest)
operation.- Parameters:
listTrainingPlansRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrainingPlansPaginator
default ListTrainingPlansIterable listTrainingPlansPaginator(Consumer<ListTrainingPlansRequest.Builder> listTrainingPlansRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrainingPlans(software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client.listTrainingPlansPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client .listTrainingPlansPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrainingPlansIterable responses = client.listTrainingPlansPaginator(request); responses.iterator().forEachRemaining(....);
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
listTrainingPlans(software.amazon.awssdk.services.sagemaker.model.ListTrainingPlansRequest)
operation.
This is a convenience which creates an instance of the
ListTrainingPlansRequest.Builder
avoiding the need to create one manually viaListTrainingPlansRequest.builder()
- Parameters:
listTrainingPlansRequest
- AConsumer
that will call methods onListTrainingPlansRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTransformJobs
default ListTransformJobsResponse listTransformJobs(ListTransformJobsRequest listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
- Parameters:
listTransformJobsRequest
-- Returns:
- Result of the ListTransformJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTransformJobs
default ListTransformJobsResponse listTransformJobs(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
This is a convenience which creates an instance of the
ListTransformJobsRequest.Builder
avoiding the need to create one manually viaListTransformJobsRequest.builder()
- Parameters:
listTransformJobsRequest
- AConsumer
that will call methods onListTransformJobsRequest.Builder
to create a request.- Returns:
- Result of the ListTransformJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTransformJobs
default ListTransformJobsResponse listTransformJobs() throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
- Returns:
- Result of the ListTransformJobs operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listTransformJobs(ListTransformJobsRequest)
, AWS API Documentation
-
listTransformJobsPaginator
default ListTransformJobsIterable listTransformJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client .listTransformJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listTransformJobsPaginator(ListTransformJobsRequest)
, AWS API Documentation
-
listTransformJobsPaginator
default ListTransformJobsIterable listTransformJobsPaginator(ListTransformJobsRequest listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client .listTransformJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTransformJobsPaginator
default ListTransformJobsIterable listTransformJobsPaginator(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client .listTransformJobsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTransformJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTransformJobsRequest.builder()
- Parameters:
listTransformJobsRequest
- AConsumer
that will call methods onListTransformJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrialComponents
default ListTrialComponentsResponse listTrialComponents(ListTrialComponentsRequest listTrialComponentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListTrialComponents operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
listTrialComponents
default ListTrialComponentsResponse listTrialComponents(Consumer<ListTrialComponentsRequest.Builder> listTrialComponentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListTrialComponentsRequest.builder()
- Parameters:
listTrialComponentsRequest
- AConsumer
that will call methods onListTrialComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListTrialComponents operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
listTrialComponentsPaginator
default ListTrialComponentsIterable listTrialComponentsPaginator(ListTrialComponentsRequest listTrialComponentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client.listTrialComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client .listTrialComponentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client.listTrialComponentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrialComponentsPaginator
default ListTrialComponentsIterable listTrialComponentsPaginator(Consumer<ListTrialComponentsRequest.Builder> listTrialComponentsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrialComponents(software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client.listTrialComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client .listTrialComponentsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrialComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialComponentsIterable responses = client.listTrialComponentsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTrialComponentsRequest.builder()
- Parameters:
listTrialComponentsRequest
- AConsumer
that will call methods onListTrialComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrials
default ListTrialsResponse listTrials(ListTrialsRequest listTrialsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListTrials operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrials
default ListTrialsResponse listTrials(Consumer<ListTrialsRequest.Builder> listTrialsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaListTrialsRequest.builder()
- Parameters:
listTrialsRequest
- AConsumer
that will call methods onListTrialsRequest.Builder
to create a request.- Returns:
- Result of the ListTrials operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrialsPaginator
default ListTrialsIterable listTrialsPaginator(ListTrialsRequest listTrialsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTrialsPaginator
default ListTrialsIterable listTrialsPaginator(Consumer<ListTrialsRequest.Builder> listTrialsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listTrials(software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListTrialsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListTrialsIterable responses = client.listTrialsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTrialsRequest.builder()
- Parameters:
listTrialsRequest
- AConsumer
that will call methods onListTrialsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listUserProfiles
default ListUserProfilesResponse listUserProfiles(ListUserProfilesRequest listUserProfilesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists user profiles.
- Parameters:
listUserProfilesRequest
-- Returns:
- Result of the ListUserProfiles operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listUserProfiles
default ListUserProfilesResponse listUserProfiles(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists user profiles.
This is a convenience which creates an instance of the
ListUserProfilesRequest.Builder
avoiding the need to create one manually viaListUserProfilesRequest.builder()
- Parameters:
listUserProfilesRequest
- AConsumer
that will call methods onListUserProfilesRequest.Builder
to create a request.- Returns:
- Result of the ListUserProfiles operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listUserProfilesPaginator
default ListUserProfilesIterable listUserProfilesPaginator(ListUserProfilesRequest listUserProfilesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client.listUserProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client .listUserProfilesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client.listUserProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listUserProfilesPaginator
default ListUserProfilesIterable listUserProfilesPaginator(Consumer<ListUserProfilesRequest.Builder> listUserProfilesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listUserProfiles(software.amazon.awssdk.services.sagemaker.model.ListUserProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client.listUserProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client .listUserProfilesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListUserProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListUserProfilesIterable responses = client.listUserProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListUserProfilesRequest.builder()
- Parameters:
listUserProfilesRequest
- AConsumer
that will call methods onListUserProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkforces
default ListWorkforcesResponse listWorkforces(ListWorkforcesRequest listWorkforcesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListWorkforces operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkforces
default ListWorkforcesResponse listWorkforces(Consumer<ListWorkforcesRequest.Builder> listWorkforcesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListWorkforcesRequest.builder()
- Parameters:
listWorkforcesRequest
- AConsumer
that will call methods onListWorkforcesRequest.Builder
to create a request.- Returns:
- Result of the ListWorkforces operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkforcesPaginator
default ListWorkforcesIterable listWorkforcesPaginator(ListWorkforcesRequest listWorkforcesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client.listWorkforcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client .listWorkforcesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client.listWorkforcesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkforcesPaginator
default ListWorkforcesIterable listWorkforcesPaginator(Consumer<ListWorkforcesRequest.Builder> listWorkforcesRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listWorkforces(software.amazon.awssdk.services.sagemaker.model.ListWorkforcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client.listWorkforcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client .listWorkforcesPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListWorkforcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkforcesIterable responses = client.listWorkforcesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListWorkforcesRequest.builder()
- Parameters:
listWorkforcesRequest
- AConsumer
that will call methods onListWorkforcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkteams
default ListWorkteamsResponse listWorkteams(ListWorkteamsRequest listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkteams
default ListWorkteamsResponse listWorkteams(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaListWorkteamsRequest.builder()
- Parameters:
listWorkteamsRequest
- AConsumer
that will call methods onListWorkteamsRequest.Builder
to create a request.- Returns:
- Result of the ListWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkteams
default ListWorkteamsResponse listWorkteams() throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the ListWorkteams operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listWorkteams(ListWorkteamsRequest)
, AWS API Documentation
-
listWorkteamsPaginator
default ListWorkteamsIterable listWorkteamsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listWorkteamsPaginator(ListWorkteamsRequest)
, AWS API Documentation
-
listWorkteamsPaginator
default ListWorkteamsIterable listWorkteamsPaginator(ListWorkteamsRequest listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listWorkteamsPaginator
default ListWorkteamsIterable listWorkteamsPaginator(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.ListWorkteamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListWorkteamsRequest.builder()
- Parameters:
listWorkteamsRequest
- AConsumer
that will call methods onListWorkteamsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putModelPackageGroupPolicy
default PutModelPackageGroupPolicyResponse putModelPackageGroupPolicy(PutModelPackageGroupPolicyRequest putModelPackageGroupPolicyRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the PutModelPackageGroupPolicy operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putModelPackageGroupPolicy
default PutModelPackageGroupPolicyResponse putModelPackageGroupPolicy(Consumer<PutModelPackageGroupPolicyRequest.Builder> putModelPackageGroupPolicyRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaPutModelPackageGroupPolicyRequest.builder()
- Parameters:
putModelPackageGroupPolicyRequest
- AConsumer
that will call methods onPutModelPackageGroupPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutModelPackageGroupPolicy operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
queryLineage
default QueryLineageResponse queryLineage(QueryLineageRequest queryLineageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the QueryLineage operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
queryLineage
default QueryLineageResponse queryLineage(Consumer<QueryLineageRequest.Builder> queryLineageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaQueryLineageRequest.builder()
- Parameters:
queryLineageRequest
- AConsumer
that will call methods onQueryLineageRequest.Builder
to create a request.- Returns:
- Result of the QueryLineage operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
queryLineagePaginator
default QueryLineageIterable queryLineagePaginator(QueryLineageRequest queryLineageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); for (software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
queryLineagePaginator
default QueryLineageIterable queryLineagePaginator(Consumer<QueryLineageRequest.Builder> queryLineageRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
This is a variant of
queryLineage(software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); for (software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.QueryLineageIterable responses = client.queryLineagePaginator(request); responses.iterator().forEachRemaining(....);
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 viaQueryLineageRequest.builder()
- Parameters:
queryLineageRequest
- AConsumer
that will call methods onQueryLineageRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
registerDevices
default RegisterDevicesResponse registerDevices(RegisterDevicesRequest registerDevicesRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Register devices.
- Parameters:
registerDevicesRequest
-- Returns:
- Result of the RegisterDevices operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
registerDevices
default RegisterDevicesResponse registerDevices(Consumer<RegisterDevicesRequest.Builder> registerDevicesRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Register devices.
This is a convenience which creates an instance of the
RegisterDevicesRequest.Builder
avoiding the need to create one manually viaRegisterDevicesRequest.builder()
- Parameters:
registerDevicesRequest
- AConsumer
that will call methods onRegisterDevicesRequest.Builder
to create a request.- Returns:
- Result of the RegisterDevices operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
renderUiTemplate
default RenderUiTemplateResponse renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Renders the UI template so that you can preview the worker's experience.
- Parameters:
renderUiTemplateRequest
-- Returns:
- Result of the RenderUiTemplate operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
renderUiTemplate
default RenderUiTemplateResponse renderUiTemplate(Consumer<RenderUiTemplateRequest.Builder> renderUiTemplateRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaRenderUiTemplateRequest.builder()
- Parameters:
renderUiTemplateRequest
- AConsumer
that will call methods onRenderUiTemplateRequest.Builder
to create a request.- Returns:
- Result of the RenderUiTemplate operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
retryPipelineExecution
default RetryPipelineExecutionResponse retryPipelineExecution(RetryPipelineExecutionRequest retryPipelineExecutionRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Retry the execution of the pipeline.
- Parameters:
retryPipelineExecutionRequest
-- Returns:
- Result of the RetryPipelineExecution operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
retryPipelineExecution
default RetryPipelineExecutionResponse retryPipelineExecution(Consumer<RetryPipelineExecutionRequest.Builder> retryPipelineExecutionRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaRetryPipelineExecutionRequest.builder()
- Parameters:
retryPipelineExecutionRequest
- AConsumer
that will call methods onRetryPipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the RetryPipelineExecution operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
search
default SearchResponse search(SearchRequest searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the Search operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
search
default SearchResponse search(Consumer<SearchRequest.Builder> searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaSearchRequest.builder()
- Parameters:
searchRequest
- AConsumer
that will call methods onSearchRequest.Builder
to create a request.- Returns:
- Result of the Search operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
searchPaginator
default SearchIterable searchPaginator(SearchRequest searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
search(software.amazon.awssdk.services.sagemaker.model.SearchRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.SearchResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
searchPaginator
default SearchIterable searchPaginator(Consumer<SearchRequest.Builder> searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
This is a variant of
search(software.amazon.awssdk.services.sagemaker.model.SearchRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); for (software.amazon.awssdk.services.sagemaker.model.SearchResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request); responses.iterator().forEachRemaining(....);
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 viaSearchRequest.builder()
- Parameters:
searchRequest
- AConsumer
that will call methods onSearchRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
searchTrainingPlanOfferings
default SearchTrainingPlanOfferingsResponse searchTrainingPlanOfferings(SearchTrainingPlanOfferingsRequest searchTrainingPlanOfferingsRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Searches for available training plan offerings based on specified criteria.
-
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).
-
And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.
For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see
CreateTrainingPlan
.- Parameters:
searchTrainingPlanOfferingsRequest
-- Returns:
- Result of the SearchTrainingPlanOfferings operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
searchTrainingPlanOfferings
default SearchTrainingPlanOfferingsResponse searchTrainingPlanOfferings(Consumer<SearchTrainingPlanOfferingsRequest.Builder> searchTrainingPlanOfferingsRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Searches for available training plan offerings based on specified criteria.
-
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).
-
And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.
For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see
CreateTrainingPlan
.
This is a convenience which creates an instance of the
SearchTrainingPlanOfferingsRequest.Builder
avoiding the need to create one manually viaSearchTrainingPlanOfferingsRequest.builder()
- Parameters:
searchTrainingPlanOfferingsRequest
- AConsumer
that will call methods onSearchTrainingPlanOfferingsRequest.Builder
to create a request.- Returns:
- Result of the SearchTrainingPlanOfferings operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
sendPipelineExecutionStepFailure
default SendPipelineExecutionStepFailureResponse sendPipelineExecutionStepFailure(SendPipelineExecutionStepFailureRequest sendPipelineExecutionStepFailureRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the SendPipelineExecutionStepFailure operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
sendPipelineExecutionStepFailure
default SendPipelineExecutionStepFailureResponse sendPipelineExecutionStepFailure(Consumer<SendPipelineExecutionStepFailureRequest.Builder> sendPipelineExecutionStepFailureRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaSendPipelineExecutionStepFailureRequest.builder()
- Parameters:
sendPipelineExecutionStepFailureRequest
- AConsumer
that will call methods onSendPipelineExecutionStepFailureRequest.Builder
to create a request.- Returns:
- Result of the SendPipelineExecutionStepFailure operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
sendPipelineExecutionStepSuccess
default SendPipelineExecutionStepSuccessResponse sendPipelineExecutionStepSuccess(SendPipelineExecutionStepSuccessRequest sendPipelineExecutionStepSuccessRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the SendPipelineExecutionStepSuccess operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
sendPipelineExecutionStepSuccess
default SendPipelineExecutionStepSuccessResponse sendPipelineExecutionStepSuccess(Consumer<SendPipelineExecutionStepSuccessRequest.Builder> sendPipelineExecutionStepSuccessRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaSendPipelineExecutionStepSuccessRequest.builder()
- Parameters:
sendPipelineExecutionStepSuccessRequest
- AConsumer
that will call methods onSendPipelineExecutionStepSuccessRequest.Builder
to create a request.- Returns:
- Result of the SendPipelineExecutionStepSuccess operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startEdgeDeploymentStage
default StartEdgeDeploymentStageResponse startEdgeDeploymentStage(StartEdgeDeploymentStageRequest startEdgeDeploymentStageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Starts a stage in an edge deployment plan.
- Parameters:
startEdgeDeploymentStageRequest
-- Returns:
- Result of the StartEdgeDeploymentStage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startEdgeDeploymentStage
default StartEdgeDeploymentStageResponse startEdgeDeploymentStage(Consumer<StartEdgeDeploymentStageRequest.Builder> startEdgeDeploymentStageRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaStartEdgeDeploymentStageRequest.builder()
- Parameters:
startEdgeDeploymentStageRequest
- AConsumer
that will call methods onStartEdgeDeploymentStageRequest.Builder
to create a request.- Returns:
- Result of the StartEdgeDeploymentStage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startInferenceExperiment
default StartInferenceExperimentResponse startInferenceExperiment(StartInferenceExperimentRequest startInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Starts an inference experiment.
- Parameters:
startInferenceExperimentRequest
-- Returns:
- Result of the StartInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startInferenceExperiment
default StartInferenceExperimentResponse startInferenceExperiment(Consumer<StartInferenceExperimentRequest.Builder> startInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Starts an inference experiment.
This is a convenience which creates an instance of the
StartInferenceExperimentRequest.Builder
avoiding the need to create one manually viaStartInferenceExperimentRequest.builder()
- Parameters:
startInferenceExperimentRequest
- AConsumer
that will call methods onStartInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the StartInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startMlflowTrackingServer
default StartMlflowTrackingServerResponse startMlflowTrackingServer(StartMlflowTrackingServerRequest startMlflowTrackingServerRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Programmatically start an MLflow Tracking Server.
- Parameters:
startMlflowTrackingServerRequest
-- Returns:
- Result of the StartMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startMlflowTrackingServer
default StartMlflowTrackingServerResponse startMlflowTrackingServer(Consumer<StartMlflowTrackingServerRequest.Builder> startMlflowTrackingServerRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Programmatically start an MLflow Tracking Server.
This is a convenience which creates an instance of the
StartMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaStartMlflowTrackingServerRequest.builder()
- Parameters:
startMlflowTrackingServerRequest
- AConsumer
that will call methods onStartMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the StartMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startMonitoringSchedule
default StartMonitoringScheduleResponse startMonitoringSchedule(StartMonitoringScheduleRequest startMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the StartMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startMonitoringSchedule
default StartMonitoringScheduleResponse startMonitoringSchedule(Consumer<StartMonitoringScheduleRequest.Builder> startMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaStartMonitoringScheduleRequest.builder()
- Parameters:
startMonitoringScheduleRequest
- AConsumer
that will call methods onStartMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the StartMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startNotebookInstance
default StartNotebookInstanceResponse startNotebookInstance(StartNotebookInstanceRequest startNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to
InService
. A notebook instance's status must beInService
before you can connect to your Jupyter notebook.- Parameters:
startNotebookInstanceRequest
-- Returns:
- Result of the StartNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
startNotebookInstance
default StartNotebookInstanceResponse startNotebookInstance(Consumer<StartNotebookInstanceRequest.Builder> startNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to
InService
. A notebook instance's status must beInService
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 viaStartNotebookInstanceRequest.builder()
- Parameters:
startNotebookInstanceRequest
- AConsumer
that will call methods onStartNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the StartNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
startPipelineExecution
default StartPipelineExecutionResponse startPipelineExecution(StartPipelineExecutionRequest startPipelineExecutionRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Starts a pipeline execution.
- Parameters:
startPipelineExecutionRequest
-- Returns:
- Result of the StartPipelineExecution operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startPipelineExecution
default StartPipelineExecutionResponse startPipelineExecution(Consumer<StartPipelineExecutionRequest.Builder> startPipelineExecutionRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Starts a pipeline execution.
This is a convenience which creates an instance of the
StartPipelineExecutionRequest.Builder
avoiding the need to create one manually viaStartPipelineExecutionRequest.builder()
- Parameters:
startPipelineExecutionRequest
- AConsumer
that will call methods onStartPipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the StartPipelineExecution operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopAutoMLJob
default StopAutoMlJobResponse stopAutoMLJob(StopAutoMlJobRequest stopAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
A method for forcing a running job to shut down.
- Parameters:
stopAutoMlJobRequest
-- Returns:
- Result of the StopAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopAutoMLJob
default StopAutoMlJobResponse stopAutoMLJob(Consumer<StopAutoMlJobRequest.Builder> stopAutoMlJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaStopAutoMlJobRequest.builder()
- Parameters:
stopAutoMlJobRequest
- AConsumer
that will call methods onStopAutoMlJobRequest.Builder
to create a request.- Returns:
- Result of the StopAutoMLJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopCompilationJob
default StopCompilationJobResponse stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a model compilation job.
To stop a job, Amazon SageMaker AI 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 AI changes theCompilationJobStatus
of the job toStopping
. After Amazon SageMaker stops the job, it sets theCompilationJobStatus
toStopped
.- Parameters:
stopCompilationJobRequest
-- Returns:
- Result of the StopCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopCompilationJob
default StopCompilationJobResponse stopCompilationJob(Consumer<StopCompilationJobRequest.Builder> stopCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a model compilation job.
To stop a job, Amazon SageMaker AI 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 AI changes theCompilationJobStatus
of the job toStopping
. After Amazon SageMaker stops the job, it sets theCompilationJobStatus
toStopped
.
This is a convenience which creates an instance of the
StopCompilationJobRequest.Builder
avoiding the need to create one manually viaStopCompilationJobRequest.builder()
- Parameters:
stopCompilationJobRequest
- AConsumer
that will call methods onStopCompilationJobRequest.Builder
to create a request.- Returns:
- Result of the StopCompilationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopEdgeDeploymentStage
default StopEdgeDeploymentStageResponse stopEdgeDeploymentStage(StopEdgeDeploymentStageRequest stopEdgeDeploymentStageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Stops a stage in an edge deployment plan.
- Parameters:
stopEdgeDeploymentStageRequest
-- Returns:
- Result of the StopEdgeDeploymentStage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopEdgeDeploymentStage
default StopEdgeDeploymentStageResponse stopEdgeDeploymentStage(Consumer<StopEdgeDeploymentStageRequest.Builder> stopEdgeDeploymentStageRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaStopEdgeDeploymentStageRequest.builder()
- Parameters:
stopEdgeDeploymentStageRequest
- AConsumer
that will call methods onStopEdgeDeploymentStageRequest.Builder
to create a request.- Returns:
- Result of the StopEdgeDeploymentStage operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopEdgePackagingJob
default StopEdgePackagingJobResponse stopEdgePackagingJob(StopEdgePackagingJobRequest stopEdgePackagingJobRequest) throws AwsServiceException, SdkClientException, SageMakerException
Request to stop an edge packaging job.
- Parameters:
stopEdgePackagingJobRequest
-- Returns:
- Result of the StopEdgePackagingJob operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopEdgePackagingJob
default StopEdgePackagingJobResponse stopEdgePackagingJob(Consumer<StopEdgePackagingJobRequest.Builder> stopEdgePackagingJobRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaStopEdgePackagingJobRequest.builder()
- Parameters:
stopEdgePackagingJobRequest
- AConsumer
that will call methods onStopEdgePackagingJobRequest.Builder
to create a request.- Returns:
- Result of the StopEdgePackagingJob operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopHyperParameterTuningJob
default StopHyperParameterTuningJobResponse stopHyperParameterTuningJob(StopHyperParameterTuningJobRequest stopHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the StopHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopHyperParameterTuningJob
default StopHyperParameterTuningJobResponse stopHyperParameterTuningJob(Consumer<StopHyperParameterTuningJobRequest.Builder> stopHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaStopHyperParameterTuningJobRequest.builder()
- Parameters:
stopHyperParameterTuningJobRequest
- AConsumer
that will call methods onStopHyperParameterTuningJobRequest.Builder
to create a request.- Returns:
- Result of the StopHyperParameterTuningJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopInferenceExperiment
default StopInferenceExperimentResponse stopInferenceExperiment(StopInferenceExperimentRequest stopInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops an inference experiment.
- Parameters:
stopInferenceExperimentRequest
-- Returns:
- Result of the StopInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopInferenceExperiment
default StopInferenceExperimentResponse stopInferenceExperiment(Consumer<StopInferenceExperimentRequest.Builder> stopInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops an inference experiment.
This is a convenience which creates an instance of the
StopInferenceExperimentRequest.Builder
avoiding the need to create one manually viaStopInferenceExperimentRequest.builder()
- Parameters:
stopInferenceExperimentRequest
- AConsumer
that will call methods onStopInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the StopInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopInferenceRecommendationsJob
default StopInferenceRecommendationsJobResponse stopInferenceRecommendationsJob(StopInferenceRecommendationsJobRequest stopInferenceRecommendationsJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops an Inference Recommender job.
- Parameters:
stopInferenceRecommendationsJobRequest
-- Returns:
- Result of the StopInferenceRecommendationsJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopInferenceRecommendationsJob
default StopInferenceRecommendationsJobResponse stopInferenceRecommendationsJob(Consumer<StopInferenceRecommendationsJobRequest.Builder> stopInferenceRecommendationsJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops an Inference Recommender job.
This is a convenience which creates an instance of the
StopInferenceRecommendationsJobRequest.Builder
avoiding the need to create one manually viaStopInferenceRecommendationsJobRequest.builder()
- Parameters:
stopInferenceRecommendationsJobRequest
- AConsumer
that will call methods onStopInferenceRecommendationsJobRequest.Builder
to create a request.- Returns:
- Result of the StopInferenceRecommendationsJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopLabelingJob
default StopLabelingJobResponse stopLabelingJob(StopLabelingJobRequest stopLabelingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the StopLabelingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopLabelingJob
default StopLabelingJobResponse stopLabelingJob(Consumer<StopLabelingJobRequest.Builder> stopLabelingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaStopLabelingJobRequest.builder()
- Parameters:
stopLabelingJobRequest
- AConsumer
that will call methods onStopLabelingJobRequest.Builder
to create a request.- Returns:
- Result of the StopLabelingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopMlflowTrackingServer
default StopMlflowTrackingServerResponse stopMlflowTrackingServer(StopMlflowTrackingServerRequest stopMlflowTrackingServerRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Programmatically stop an MLflow Tracking Server.
- Parameters:
stopMlflowTrackingServerRequest
-- Returns:
- Result of the StopMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopMlflowTrackingServer
default StopMlflowTrackingServerResponse stopMlflowTrackingServer(Consumer<StopMlflowTrackingServerRequest.Builder> stopMlflowTrackingServerRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Programmatically stop an MLflow Tracking Server.
This is a convenience which creates an instance of the
StopMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaStopMlflowTrackingServerRequest.builder()
- Parameters:
stopMlflowTrackingServerRequest
- AConsumer
that will call methods onStopMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the StopMlflowTrackingServer operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopMonitoringSchedule
default StopMonitoringScheduleResponse stopMonitoringSchedule(StopMonitoringScheduleRequest stopMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a previously started monitoring schedule.
- Parameters:
stopMonitoringScheduleRequest
-- Returns:
- Result of the StopMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopMonitoringSchedule
default StopMonitoringScheduleResponse stopMonitoringSchedule(Consumer<StopMonitoringScheduleRequest.Builder> stopMonitoringScheduleRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaStopMonitoringScheduleRequest.builder()
- Parameters:
stopMonitoringScheduleRequest
- AConsumer
that will call methods onStopMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the StopMonitoringSchedule operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopNotebookInstance
default StopNotebookInstanceResponse stopNotebookInstance(StopNotebookInstanceRequest stopNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI 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:
- Result of the StopNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopNotebookInstance
default StopNotebookInstanceResponse stopNotebookInstance(Consumer<StopNotebookInstanceRequest.Builder> stopNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Terminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI 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 viaStopNotebookInstanceRequest.builder()
- Parameters:
stopNotebookInstanceRequest
- AConsumer
that will call methods onStopNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the StopNotebookInstance operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopOptimizationJob
default StopOptimizationJobResponse stopOptimizationJob(StopOptimizationJobRequest stopOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Ends a running inference optimization job.
- Parameters:
stopOptimizationJobRequest
-- Returns:
- Result of the StopOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopOptimizationJob
default StopOptimizationJobResponse stopOptimizationJob(Consumer<StopOptimizationJobRequest.Builder> stopOptimizationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Ends a running inference optimization job.
This is a convenience which creates an instance of the
StopOptimizationJobRequest.Builder
avoiding the need to create one manually viaStopOptimizationJobRequest.builder()
- Parameters:
stopOptimizationJobRequest
- AConsumer
that will call methods onStopOptimizationJobRequest.Builder
to create a request.- Returns:
- Result of the StopOptimizationJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopPipelineExecution
default StopPipelineExecutionResponse stopPipelineExecution(StopPipelineExecutionRequest stopPipelineExecutionRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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
orSendPipelineExecutionStepFailure
.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 isFailed
.- Parameters:
stopPipelineExecutionRequest
-- Returns:
- Result of the StopPipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopPipelineExecution
default StopPipelineExecutionResponse stopPipelineExecution(Consumer<StopPipelineExecutionRequest.Builder> stopPipelineExecutionRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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
orSendPipelineExecutionStepFailure
.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 isFailed
.
This is a convenience which creates an instance of the
StopPipelineExecutionRequest.Builder
avoiding the need to create one manually viaStopPipelineExecutionRequest.builder()
- Parameters:
stopPipelineExecutionRequest
- AConsumer
that will call methods onStopPipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the StopPipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopProcessingJob
default StopProcessingJobResponse stopProcessingJob(StopProcessingJobRequest stopProcessingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a processing job.
- Parameters:
stopProcessingJobRequest
-- Returns:
- Result of the StopProcessingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopProcessingJob
default StopProcessingJobResponse stopProcessingJob(Consumer<StopProcessingJobRequest.Builder> stopProcessingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a processing job.
This is a convenience which creates an instance of the
StopProcessingJobRequest.Builder
avoiding the need to create one manually viaStopProcessingJobRequest.builder()
- Parameters:
stopProcessingJobRequest
- AConsumer
that will call methods onStopProcessingJobRequest.Builder
to create a request.- Returns:
- Result of the StopProcessingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopTrainingJob
default StopTrainingJobResponse stopTrainingJob(StopTrainingJobRequest stopTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 toStopping
. After SageMaker stops the job, it sets the status toStopped
.- Parameters:
stopTrainingJobRequest
-- Returns:
- Result of the StopTrainingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopTrainingJob
default StopTrainingJobResponse stopTrainingJob(Consumer<StopTrainingJobRequest.Builder> stopTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 toStopping
. After SageMaker stops the job, it sets the status toStopped
.
This is a convenience which creates an instance of the
StopTrainingJobRequest.Builder
avoiding the need to create one manually viaStopTrainingJobRequest.builder()
- Parameters:
stopTrainingJobRequest
- AConsumer
that will call methods onStopTrainingJobRequest.Builder
to create a request.- Returns:
- Result of the StopTrainingJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopTransformJob
default StopTransformJobResponse stopTransformJob(StopTransformJobRequest stopTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a batch transform job.
When Amazon SageMaker receives a
StopTransformJob
request, the status of the job changes toStopping
. After Amazon SageMaker stops the job, the status is set toStopped
. 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:
- Result of the StopTransformJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopTransformJob
default StopTransformJobResponse stopTransformJob(Consumer<StopTransformJobRequest.Builder> stopTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a batch transform job.
When Amazon SageMaker receives a
StopTransformJob
request, the status of the job changes toStopping
. After Amazon SageMaker stops the job, the status is set toStopped
. 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 viaStopTransformJobRequest.builder()
- Parameters:
stopTransformJobRequest
- AConsumer
that will call methods onStopTransformJobRequest.Builder
to create a request.- Returns:
- Result of the StopTransformJob operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateAction
default UpdateActionResponse updateAction(UpdateActionRequest updateActionRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates an action.
- Parameters:
updateActionRequest
-- Returns:
- Result of the UpdateAction operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateAction
default UpdateActionResponse updateAction(Consumer<UpdateActionRequest.Builder> updateActionRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates an action.
This is a convenience which creates an instance of the
UpdateActionRequest.Builder
avoiding the need to create one manually viaUpdateActionRequest.builder()
- Parameters:
updateActionRequest
- AConsumer
that will call methods onUpdateActionRequest.Builder
to create a request.- Returns:
- Result of the UpdateAction operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateAppImageConfig
default UpdateAppImageConfigResponse updateAppImageConfig(UpdateAppImageConfigRequest updateAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the properties of an AppImageConfig.
- Parameters:
updateAppImageConfigRequest
-- Returns:
- Result of the UpdateAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateAppImageConfig
default UpdateAppImageConfigResponse updateAppImageConfig(Consumer<UpdateAppImageConfigRequest.Builder> updateAppImageConfigRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateAppImageConfigRequest.builder()
- Parameters:
updateAppImageConfigRequest
- AConsumer
that will call methods onUpdateAppImageConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppImageConfig operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateArtifact
default UpdateArtifactResponse updateArtifact(UpdateArtifactRequest updateArtifactRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates an artifact.
- Parameters:
updateArtifactRequest
-- Returns:
- Result of the UpdateArtifact operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateArtifact
default UpdateArtifactResponse updateArtifact(Consumer<UpdateArtifactRequest.Builder> updateArtifactRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates an artifact.
This is a convenience which creates an instance of the
UpdateArtifactRequest.Builder
avoiding the need to create one manually viaUpdateArtifactRequest.builder()
- Parameters:
updateArtifactRequest
- AConsumer
that will call methods onUpdateArtifactRequest.Builder
to create a request.- Returns:
- Result of the UpdateArtifact operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateCluster
default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws ResourceLimitExceededException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a SageMaker HyperPod cluster.
- Parameters:
updateClusterRequest
-- Returns:
- Result of the UpdateCluster operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateCluster
default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws ResourceLimitExceededException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a SageMaker HyperPod cluster.
This is a convenience which creates an instance of the
UpdateClusterRequest.Builder
avoiding the need to create one manually viaUpdateClusterRequest.builder()
- Parameters:
updateClusterRequest
- AConsumer
that will call methods onUpdateClusterRequest.Builder
to create a request.- Returns:
- Result of the UpdateCluster operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateClusterSchedulerConfig
default UpdateClusterSchedulerConfigResponse updateClusterSchedulerConfig(UpdateClusterSchedulerConfigRequest updateClusterSchedulerConfigRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Update the cluster policy configuration.
- Parameters:
updateClusterSchedulerConfigRequest
-- Returns:
- Result of the UpdateClusterSchedulerConfig operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateClusterSchedulerConfig
default UpdateClusterSchedulerConfigResponse updateClusterSchedulerConfig(Consumer<UpdateClusterSchedulerConfigRequest.Builder> updateClusterSchedulerConfigRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Update the cluster policy configuration.
This is a convenience which creates an instance of the
UpdateClusterSchedulerConfigRequest.Builder
avoiding the need to create one manually viaUpdateClusterSchedulerConfigRequest.builder()
- Parameters:
updateClusterSchedulerConfigRequest
- AConsumer
that will call methods onUpdateClusterSchedulerConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateClusterSchedulerConfig operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateClusterSoftware
default UpdateClusterSoftwareResponse updateClusterSoftware(UpdateClusterSoftwareRequest updateClusterSoftwareRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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.
The
UpgradeClusterSoftware
API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.- Parameters:
updateClusterSoftwareRequest
-- Returns:
- Result of the UpdateClusterSoftware operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateClusterSoftware
default UpdateClusterSoftwareResponse updateClusterSoftware(Consumer<UpdateClusterSoftwareRequest.Builder> updateClusterSoftwareRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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.
The
UpgradeClusterSoftware
API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.
This is a convenience which creates an instance of the
UpdateClusterSoftwareRequest.Builder
avoiding the need to create one manually viaUpdateClusterSoftwareRequest.builder()
- Parameters:
updateClusterSoftwareRequest
- AConsumer
that will call methods onUpdateClusterSoftwareRequest.Builder
to create a request.- Returns:
- Result of the UpdateClusterSoftware operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateCodeRepository
default UpdateCodeRepositoryResponse updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates the specified Git repository with the specified values.
- Parameters:
updateCodeRepositoryRequest
-- Returns:
- Result of the UpdateCodeRepository operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateCodeRepository
default UpdateCodeRepositoryResponse updateCodeRepository(Consumer<UpdateCodeRepositoryRequest.Builder> updateCodeRepositoryRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateCodeRepositoryRequest.builder()
- Parameters:
updateCodeRepositoryRequest
- AConsumer
that will call methods onUpdateCodeRepositoryRequest.Builder
to create a request.- Returns:
- Result of the UpdateCodeRepository operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateComputeQuota
default UpdateComputeQuotaResponse updateComputeQuota(UpdateComputeQuotaRequest updateComputeQuotaRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Update the compute allocation definition.
- Parameters:
updateComputeQuotaRequest
-- Returns:
- Result of the UpdateComputeQuota operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateComputeQuota
default UpdateComputeQuotaResponse updateComputeQuota(Consumer<UpdateComputeQuotaRequest.Builder> updateComputeQuotaRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Update the compute allocation definition.
This is a convenience which creates an instance of the
UpdateComputeQuotaRequest.Builder
avoiding the need to create one manually viaUpdateComputeQuotaRequest.builder()
- Parameters:
updateComputeQuotaRequest
- AConsumer
that will call methods onUpdateComputeQuotaRequest.Builder
to create a request.- Returns:
- Result of the UpdateComputeQuota operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateContext
default UpdateContextResponse updateContext(UpdateContextRequest updateContextRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a context.
- Parameters:
updateContextRequest
-- Returns:
- Result of the UpdateContext operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateContext
default UpdateContextResponse updateContext(Consumer<UpdateContextRequest.Builder> updateContextRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a context.
This is a convenience which creates an instance of the
UpdateContextRequest.Builder
avoiding the need to create one manually viaUpdateContextRequest.builder()
- Parameters:
updateContextRequest
- AConsumer
that will call methods onUpdateContextRequest.Builder
to create a request.- Returns:
- Result of the UpdateContext operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDeviceFleet
default UpdateDeviceFleetResponse updateDeviceFleet(UpdateDeviceFleetRequest updateDeviceFleetRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates a fleet of devices.
- Parameters:
updateDeviceFleetRequest
-- Returns:
- Result of the UpdateDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDeviceFleet
default UpdateDeviceFleetResponse updateDeviceFleet(Consumer<UpdateDeviceFleetRequest.Builder> updateDeviceFleetRequest) throws ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates a fleet of devices.
This is a convenience which creates an instance of the
UpdateDeviceFleetRequest.Builder
avoiding the need to create one manually viaUpdateDeviceFleetRequest.builder()
- Parameters:
updateDeviceFleetRequest
- AConsumer
that will call methods onUpdateDeviceFleetRequest.Builder
to create a request.- Returns:
- Result of the UpdateDeviceFleet operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDevices
default UpdateDevicesResponse updateDevices(UpdateDevicesRequest updateDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Updates one or more devices in a fleet.
- Parameters:
updateDevicesRequest
-- Returns:
- Result of the UpdateDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDevices
default UpdateDevicesResponse updateDevices(Consumer<UpdateDevicesRequest.Builder> updateDevicesRequest) throws AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateDevicesRequest.builder()
- Parameters:
updateDevicesRequest
- AConsumer
that will call methods onUpdateDevicesRequest.Builder
to create a request.- Returns:
- Result of the UpdateDevices operation returned by the service.
- Throws:
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDomain
default UpdateDomainResponse updateDomain(UpdateDomainRequest updateDomainRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the default settings for new user profiles in the domain.
- Parameters:
updateDomainRequest
-- Returns:
- Result of the UpdateDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateDomain
default UpdateDomainResponse updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateDomainRequest.builder()
- Parameters:
updateDomainRequest
- AConsumer
that will call methods onUpdateDomainRequest.Builder
to create a request.- Returns:
- Result of the UpdateDomain operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 previousEndpointConfig
(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 toInService
. 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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a newEndpointConfig
.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:
- Result of the UpdateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 previousEndpointConfig
(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 toInService
. 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 theUpdateEndpoint
orCreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a newEndpointConfig
.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 viaUpdateEndpointRequest.builder()
- Parameters:
updateEndpointRequest
- AConsumer
that will call methods onUpdateEndpointRequest.Builder
to create a request.- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateEndpointWeightsAndCapacities
default UpdateEndpointWeightsAndCapacitiesResponse updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest updateEndpointWeightsAndCapacitiesRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 toInService
. To check the status of an endpoint, use the DescribeEndpoint API.- Parameters:
updateEndpointWeightsAndCapacitiesRequest
-- Returns:
- Result of the UpdateEndpointWeightsAndCapacities operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateEndpointWeightsAndCapacities
default UpdateEndpointWeightsAndCapacitiesResponse updateEndpointWeightsAndCapacities(Consumer<UpdateEndpointWeightsAndCapacitiesRequest.Builder> updateEndpointWeightsAndCapacitiesRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 toInService
. 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 viaUpdateEndpointWeightsAndCapacitiesRequest.builder()
- Parameters:
updateEndpointWeightsAndCapacitiesRequest
- AConsumer
that will call methods onUpdateEndpointWeightsAndCapacitiesRequest.Builder
to create a request.- Returns:
- Result of the UpdateEndpointWeightsAndCapacities operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateExperiment
default UpdateExperimentResponse updateExperiment(UpdateExperimentRequest updateExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
- Parameters:
updateExperimentRequest
-- Returns:
- Result of the UpdateExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateExperiment
default UpdateExperimentResponse updateExperiment(Consumer<UpdateExperimentRequest.Builder> updateExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateExperimentRequest.builder()
- Parameters:
updateExperimentRequest
- AConsumer
that will call methods onUpdateExperimentRequest.Builder
to create a request.- Returns:
- Result of the UpdateExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFeatureGroup
default UpdateFeatureGroupResponse updateFeatureGroup(UpdateFeatureGroupRequest updateFeatureGroupRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 aTtlDuration
is specified, the defaultTtlDuration
applies for all records added to the feature group after the feature group is updated. If a record levelTtlDuration
exists from using thePutRecord
API, the record levelTtlDuration
applies to that record instead of the defaultTtlDuration
. To remove the defaultTtlDuration
from an existing feature group, use theUpdateFeatureGroup
API and set theTtlDuration
Unit
andValue
tonull
.- Parameters:
updateFeatureGroupRequest
-- Returns:
- Result of the UpdateFeatureGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFeatureGroup
default UpdateFeatureGroupResponse updateFeatureGroup(Consumer<UpdateFeatureGroupRequest.Builder> updateFeatureGroupRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 aTtlDuration
is specified, the defaultTtlDuration
applies for all records added to the feature group after the feature group is updated. If a record levelTtlDuration
exists from using thePutRecord
API, the record levelTtlDuration
applies to that record instead of the defaultTtlDuration
. To remove the defaultTtlDuration
from an existing feature group, use theUpdateFeatureGroup
API and set theTtlDuration
Unit
andValue
tonull
.
This is a convenience which creates an instance of the
UpdateFeatureGroupRequest.Builder
avoiding the need to create one manually viaUpdateFeatureGroupRequest.builder()
- Parameters:
updateFeatureGroupRequest
- AConsumer
that will call methods onUpdateFeatureGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateFeatureGroup operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFeatureMetadata
default UpdateFeatureMetadataResponse updateFeatureMetadata(UpdateFeatureMetadataRequest updateFeatureMetadataRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the description and parameters of the feature group.
- Parameters:
updateFeatureMetadataRequest
-- Returns:
- Result of the UpdateFeatureMetadata operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateFeatureMetadata
default UpdateFeatureMetadataResponse updateFeatureMetadata(Consumer<UpdateFeatureMetadataRequest.Builder> updateFeatureMetadataRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateFeatureMetadataRequest.builder()
- Parameters:
updateFeatureMetadataRequest
- AConsumer
that will call methods onUpdateFeatureMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateFeatureMetadata operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateHub
default UpdateHubResponse updateHub(UpdateHubRequest updateHubRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Update a hub.
- Parameters:
updateHubRequest
-- Returns:
- Result of the UpdateHub operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateHub
default UpdateHubResponse updateHub(Consumer<UpdateHubRequest.Builder> updateHubRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Update a hub.
This is a convenience which creates an instance of the
UpdateHubRequest.Builder
avoiding the need to create one manually viaUpdateHubRequest.builder()
- Parameters:
updateHubRequest
- AConsumer
that will call methods onUpdateHubRequest.Builder
to create a request.- Returns:
- Result of the UpdateHub operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateHubContent
default UpdateHubContentResponse updateHubContent(UpdateHubContentRequest updateHubContentRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates SageMaker hub content (either a
Model
orNotebook
resource).You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:
-
HubContentDescription
-
HubContentDisplayName
-
HubContentMarkdown
-
HubContentSearchKeywords
-
SupportStatus
For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.
If you want to update a
ModelReference
resource in your hub, use theUpdateHubContentResource
API instead.- Parameters:
updateHubContentRequest
-- Returns:
- Result of the UpdateHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
updateHubContent
default UpdateHubContentResponse updateHubContent(Consumer<UpdateHubContentRequest.Builder> updateHubContentRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates SageMaker hub content (either a
Model
orNotebook
resource).You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:
-
HubContentDescription
-
HubContentDisplayName
-
HubContentMarkdown
-
HubContentSearchKeywords
-
SupportStatus
For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.
If you want to update a
ModelReference
resource in your hub, use theUpdateHubContentResource
API instead.
This is a convenience which creates an instance of the
UpdateHubContentRequest.Builder
avoiding the need to create one manually viaUpdateHubContentRequest.builder()
- Parameters:
updateHubContentRequest
- AConsumer
that will call methods onUpdateHubContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateHubContent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
updateHubContentReference
default UpdateHubContentReferenceResponse updateHubContentReference(UpdateHubContentReferenceRequest updateHubContentReferenceRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates the contents of a SageMaker hub for a
ModelReference
resource. AModelReference
allows you to access public SageMaker JumpStart models from within your private hub.When using this API, you can update the
MinVersion
field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata.If you want to update a
Model
orNotebook
resource in your hub, use theUpdateHubContent
API instead.For more information about adding model references to your hub, see Add models to a private hub.
- Parameters:
updateHubContentReferenceRequest
-- Returns:
- Result of the UpdateHubContentReference operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateHubContentReference
default UpdateHubContentReferenceResponse updateHubContentReference(Consumer<UpdateHubContentReferenceRequest.Builder> updateHubContentReferenceRequest) throws ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, SageMakerException
Updates the contents of a SageMaker hub for a
ModelReference
resource. AModelReference
allows you to access public SageMaker JumpStart models from within your private hub.When using this API, you can update the
MinVersion
field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata.If you want to update a
Model
orNotebook
resource in your hub, use theUpdateHubContent
API instead.For more information about adding model references to your hub, see Add models to a private hub.
This is a convenience which creates an instance of the
UpdateHubContentReferenceRequest.Builder
avoiding the need to create one manually viaUpdateHubContentReferenceRequest.builder()
- Parameters:
updateHubContentReferenceRequest
- AConsumer
that will call methods onUpdateHubContentReferenceRequest.Builder
to create a request.- Returns:
- Result of the UpdateHubContentReference operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateImage
default UpdateImageResponse updateImage(UpdateImageRequest updateImageRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.
- Parameters:
updateImageRequest
-- Returns:
- Result of the UpdateImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateImage
default UpdateImageResponse updateImage(Consumer<UpdateImageRequest.Builder> updateImageRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the properties of a SageMaker AI 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 viaUpdateImageRequest.builder()
- Parameters:
updateImageRequest
- AConsumer
that will call methods onUpdateImageRequest.Builder
to create a request.- Returns:
- Result of the UpdateImage operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateImageVersion
default UpdateImageVersionResponse updateImageVersion(UpdateImageVersionRequest updateImageVersionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the properties of a SageMaker AI image version.
- Parameters:
updateImageVersionRequest
-- Returns:
- Result of the UpdateImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateImageVersion
default UpdateImageVersionResponse updateImageVersion(Consumer<UpdateImageVersionRequest.Builder> updateImageVersionRequest) throws ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the properties of a SageMaker AI image version.
This is a convenience which creates an instance of the
UpdateImageVersionRequest.Builder
avoiding the need to create one manually viaUpdateImageVersionRequest.builder()
- Parameters:
updateImageVersionRequest
- AConsumer
that will call methods onUpdateImageVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateImageVersion operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceComponent
default UpdateInferenceComponentResponse updateInferenceComponent(UpdateInferenceComponentRequest updateInferenceComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates an inference component.
- Parameters:
updateInferenceComponentRequest
-- Returns:
- Result of the UpdateInferenceComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceComponent
default UpdateInferenceComponentResponse updateInferenceComponent(Consumer<UpdateInferenceComponentRequest.Builder> updateInferenceComponentRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates an inference component.
This is a convenience which creates an instance of the
UpdateInferenceComponentRequest.Builder
avoiding the need to create one manually viaUpdateInferenceComponentRequest.builder()
- Parameters:
updateInferenceComponentRequest
- AConsumer
that will call methods onUpdateInferenceComponentRequest.Builder
to create a request.- Returns:
- Result of the UpdateInferenceComponent operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceComponentRuntimeConfig
default UpdateInferenceComponentRuntimeConfigResponse updateInferenceComponentRuntimeConfig(UpdateInferenceComponentRuntimeConfigRequest updateInferenceComponentRuntimeConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Runtime settings for a model that is deployed with an inference component.
- Parameters:
updateInferenceComponentRuntimeConfigRequest
-- Returns:
- Result of the UpdateInferenceComponentRuntimeConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceComponentRuntimeConfig
default UpdateInferenceComponentRuntimeConfigResponse updateInferenceComponentRuntimeConfig(Consumer<UpdateInferenceComponentRuntimeConfigRequest.Builder> updateInferenceComponentRuntimeConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateInferenceComponentRuntimeConfigRequest.builder()
- Parameters:
updateInferenceComponentRuntimeConfigRequest
- AConsumer
that will call methods onUpdateInferenceComponentRuntimeConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateInferenceComponentRuntimeConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceExperiment
default UpdateInferenceExperimentResponse updateInferenceExperiment(UpdateInferenceExperimentRequest updateInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the UpdateInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateInferenceExperiment
default UpdateInferenceExperimentResponse updateInferenceExperiment(Consumer<UpdateInferenceExperimentRequest.Builder> updateInferenceExperimentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateInferenceExperimentRequest.builder()
- Parameters:
updateInferenceExperimentRequest
- AConsumer
that will call methods onUpdateInferenceExperimentRequest.Builder
to create a request.- Returns:
- Result of the UpdateInferenceExperiment operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMlflowTrackingServer
default UpdateMlflowTrackingServerResponse updateMlflowTrackingServer(UpdateMlflowTrackingServerRequest updateMlflowTrackingServerRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates properties of an existing MLflow Tracking Server.
- Parameters:
updateMlflowTrackingServerRequest
-- Returns:
- Result of the UpdateMlflowTrackingServer operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMlflowTrackingServer
default UpdateMlflowTrackingServerResponse updateMlflowTrackingServer(Consumer<UpdateMlflowTrackingServerRequest.Builder> updateMlflowTrackingServerRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates properties of an existing MLflow Tracking Server.
This is a convenience which creates an instance of the
UpdateMlflowTrackingServerRequest.Builder
avoiding the need to create one manually viaUpdateMlflowTrackingServerRequest.builder()
- Parameters:
updateMlflowTrackingServerRequest
- AConsumer
that will call methods onUpdateMlflowTrackingServerRequest.Builder
to create a request.- Returns:
- Result of the UpdateMlflowTrackingServer operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateModelCard
default UpdateModelCardResponse updateModelCard(UpdateModelCardRequest updateModelCardRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Update an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
- Parameters:
updateModelCardRequest
-- Returns:
- Result of the UpdateModelCard operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateModelCard
default UpdateModelCardResponse updateModelCard(Consumer<UpdateModelCardRequest.Builder> updateModelCardRequest) throws ResourceNotFoundException, ResourceLimitExceededException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateModelCardRequest.builder()
- Parameters:
updateModelCardRequest
- AConsumer
that will call methods onUpdateModelCardRequest.Builder
to create a request.- Returns:
- Result of the UpdateModelCard operation returned by the service.
- Throws:
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 anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateModelPackage
default UpdateModelPackageResponse updateModelPackage(UpdateModelPackageRequest updateModelPackageRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a versioned model.
- Parameters:
updateModelPackageRequest
-- Returns:
- Result of the UpdateModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateModelPackage
default UpdateModelPackageResponse updateModelPackage(Consumer<UpdateModelPackageRequest.Builder> updateModelPackageRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a versioned model.
This is a convenience which creates an instance of the
UpdateModelPackageRequest.Builder
avoiding the need to create one manually viaUpdateModelPackageRequest.builder()
- Parameters:
updateModelPackageRequest
- AConsumer
that will call methods onUpdateModelPackageRequest.Builder
to create a request.- Returns:
- Result of the UpdateModelPackage operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMonitoringAlert
default UpdateMonitoringAlertResponse updateMonitoringAlert(UpdateMonitoringAlertRequest updateMonitoringAlertRequest) throws ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Update the parameters of a model monitor alert.
- Parameters:
updateMonitoringAlertRequest
-- Returns:
- Result of the UpdateMonitoringAlert operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMonitoringAlert
default UpdateMonitoringAlertResponse updateMonitoringAlert(Consumer<UpdateMonitoringAlertRequest.Builder> updateMonitoringAlertRequest) throws ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateMonitoringAlertRequest.builder()
- Parameters:
updateMonitoringAlertRequest
- AConsumer
that will call methods onUpdateMonitoringAlertRequest.Builder
to create a request.- Returns:
- Result of the UpdateMonitoringAlert operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMonitoringSchedule
default UpdateMonitoringScheduleResponse updateMonitoringSchedule(UpdateMonitoringScheduleRequest updateMonitoringScheduleRequest) throws ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a previously created schedule.
- Parameters:
updateMonitoringScheduleRequest
-- Returns:
- Result of the UpdateMonitoringSchedule operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateMonitoringSchedule
default UpdateMonitoringScheduleResponse updateMonitoringSchedule(Consumer<UpdateMonitoringScheduleRequest.Builder> updateMonitoringScheduleRequest) throws ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a previously created schedule.
This is a convenience which creates an instance of the
UpdateMonitoringScheduleRequest.Builder
avoiding the need to create one manually viaUpdateMonitoringScheduleRequest.builder()
- Parameters:
updateMonitoringScheduleRequest
- AConsumer
that will call methods onUpdateMonitoringScheduleRequest.Builder
to create a request.- Returns:
- Result of the UpdateMonitoringSchedule operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateNotebookInstance
default UpdateNotebookInstanceResponse updateNotebookInstance(UpdateNotebookInstanceRequest updateNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the UpdateNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateNotebookInstance
default UpdateNotebookInstanceResponse updateNotebookInstance(Consumer<UpdateNotebookInstanceRequest.Builder> updateNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateNotebookInstanceRequest.builder()
- Parameters:
updateNotebookInstanceRequest
- AConsumer
that will call methods onUpdateNotebookInstanceRequest.Builder
to create a request.- Returns:
- Result of the UpdateNotebookInstance operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateNotebookInstanceLifecycleConfig
default UpdateNotebookInstanceLifecycleConfigResponse updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
- Parameters:
updateNotebookInstanceLifecycleConfigRequest
-- Returns:
- Result of the UpdateNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateNotebookInstanceLifecycleConfig
default UpdateNotebookInstanceLifecycleConfigResponse updateNotebookInstanceLifecycleConfig(Consumer<UpdateNotebookInstanceLifecycleConfigRequest.Builder> updateNotebookInstanceLifecycleConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateNotebookInstanceLifecycleConfigRequest.builder()
- Parameters:
updateNotebookInstanceLifecycleConfigRequest
- AConsumer
that will call methods onUpdateNotebookInstanceLifecycleConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateNotebookInstanceLifecycleConfig operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePartnerApp
default UpdatePartnerAppResponse updatePartnerApp(UpdatePartnerAppRequest updatePartnerAppRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates all of the SageMaker Partner AI Apps in an account.
- Parameters:
updatePartnerAppRequest
-- Returns:
- Result of the UpdatePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePartnerApp
default UpdatePartnerAppResponse updatePartnerApp(Consumer<UpdatePartnerAppRequest.Builder> updatePartnerAppRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates all of the SageMaker Partner AI Apps in an account.
This is a convenience which creates an instance of the
UpdatePartnerAppRequest.Builder
avoiding the need to create one manually viaUpdatePartnerAppRequest.builder()
- Parameters:
updatePartnerAppRequest
- AConsumer
that will call methods onUpdatePartnerAppRequest.Builder
to create a request.- Returns:
- Result of the UpdatePartnerApp operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePipeline
default UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a pipeline.
- Parameters:
updatePipelineRequest
-- Returns:
- Result of the UpdatePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePipeline
default UpdatePipelineResponse updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a pipeline.
This is a convenience which creates an instance of the
UpdatePipelineRequest.Builder
avoiding the need to create one manually viaUpdatePipelineRequest.builder()
- Parameters:
updatePipelineRequest
- AConsumer
that will call methods onUpdatePipelineRequest.Builder
to create a request.- Returns:
- Result of the UpdatePipeline operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePipelineExecution
default UpdatePipelineExecutionResponse updatePipelineExecution(UpdatePipelineExecutionRequest updatePipelineExecutionRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a pipeline execution.
- Parameters:
updatePipelineExecutionRequest
-- Returns:
- Result of the UpdatePipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updatePipelineExecution
default UpdatePipelineExecutionResponse updatePipelineExecution(Consumer<UpdatePipelineExecutionRequest.Builder> updatePipelineExecutionRequest) throws ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, SageMakerException
Updates a pipeline execution.
This is a convenience which creates an instance of the
UpdatePipelineExecutionRequest.Builder
avoiding the need to create one manually viaUpdatePipelineExecutionRequest.builder()
- Parameters:
updatePipelineExecutionRequest
- AConsumer
that will call methods onUpdatePipelineExecutionRequest.Builder
to create a request.- Returns:
- Result of the UpdatePipelineExecution operation returned by the service.
- Throws:
ResourceNotFoundException
- Resource being access is not found.ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateProject
default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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:
- Result of the UpdateProject operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateProject
default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateProjectRequest.builder()
- Parameters:
updateProjectRequest
- AConsumer
that will call methods onUpdateProjectRequest.Builder
to create a request.- Returns:
- Result of the UpdateProject operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateSpace
default UpdateSpaceResponse updateSpace(UpdateSpaceRequest updateSpaceRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the settings of a space.
You can't edit the app type of a space in the
SpaceSettings
.- Parameters:
updateSpaceRequest
-- Returns:
- Result of the UpdateSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateSpace
default UpdateSpaceResponse updateSpace(Consumer<UpdateSpaceRequest.Builder> updateSpaceRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the settings of a space.
You can't edit the app type of a space in the
SpaceSettings
.
This is a convenience which creates an instance of the
UpdateSpaceRequest.Builder
avoiding the need to create one manually viaUpdateSpaceRequest.builder()
- Parameters:
updateSpaceRequest
- AConsumer
that will call methods onUpdateSpaceRequest.Builder
to create a request.- Returns:
- Result of the UpdateSpace operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrainingJob
default UpdateTrainingJobResponse updateTrainingJob(UpdateTrainingJobRequest updateTrainingJobRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.
- Parameters:
updateTrainingJobRequest
-- Returns:
- Result of the UpdateTrainingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrainingJob
default UpdateTrainingJobResponse updateTrainingJob(Consumer<UpdateTrainingJobRequest.Builder> updateTrainingJobRequest) throws ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateTrainingJobRequest.builder()
- Parameters:
updateTrainingJobRequest
- AConsumer
that will call methods onUpdateTrainingJobRequest.Builder
to create a request.- Returns:
- Result of the UpdateTrainingJob operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrial
default UpdateTrialResponse updateTrial(UpdateTrialRequest updateTrialRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates the display name of a trial.
- Parameters:
updateTrialRequest
-- Returns:
- Result of the UpdateTrial operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrial
default UpdateTrialResponse updateTrial(Consumer<UpdateTrialRequest.Builder> updateTrialRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateTrialRequest.builder()
- Parameters:
updateTrialRequest
- AConsumer
that will call methods onUpdateTrialRequest.Builder
to create a request.- Returns:
- Result of the UpdateTrial operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrialComponent
default UpdateTrialComponentResponse updateTrialComponent(UpdateTrialComponentRequest updateTrialComponentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates one or more properties of a trial component.
- Parameters:
updateTrialComponentRequest
-- Returns:
- Result of the UpdateTrialComponent operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateTrialComponent
default UpdateTrialComponentResponse updateTrialComponent(Consumer<UpdateTrialComponentRequest.Builder> updateTrialComponentRequest) throws ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateTrialComponentRequest.builder()
- Parameters:
updateTrialComponentRequest
- AConsumer
that will call methods onUpdateTrialComponentRequest.Builder
to create a request.- Returns:
- Result of the UpdateTrialComponent operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateUserProfile
default UpdateUserProfileResponse updateUserProfile(UpdateUserProfileRequest updateUserProfileRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a user profile.
- Parameters:
updateUserProfileRequest
-- Returns:
- Result of the UpdateUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateUserProfile
default UpdateUserProfileResponse updateUserProfile(Consumer<UpdateUserProfileRequest.Builder> updateUserProfileRequest) throws ResourceLimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Updates a user profile.
This is a convenience which creates an instance of the
UpdateUserProfileRequest.Builder
avoiding the need to create one manually viaUpdateUserProfileRequest.builder()
- Parameters:
updateUserProfileRequest
- AConsumer
that will call methods onUpdateUserProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateUserProfile operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateWorkforce
default UpdateWorkforceResponse updateWorkforce(UpdateWorkforceRequest updateWorkforceRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 aNot 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:
- Result of the UpdateWorkforce operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateWorkforce
default UpdateWorkforceResponse updateWorkforce(Consumer<UpdateWorkforceRequest.Builder> updateWorkforceRequest) throws ConflictException, AwsServiceException, SdkClientException, SageMakerException
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 aNot 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 viaUpdateWorkforceRequest.builder()
- Parameters:
updateWorkforceRequest
- AConsumer
that will call methods onUpdateWorkforceRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorkforce operation returned by the service.
- Throws:
ConflictException
- There was a conflict when you attempted to modify a SageMaker entity such as anExperiment
orArtifact
.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateWorkteam
default UpdateWorkteamResponse updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates an existing work team with new member definitions or description.
- Parameters:
updateWorkteamRequest
-- Returns:
- Result of the UpdateWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
updateWorkteam
default UpdateWorkteamResponse updateWorkteam(Consumer<UpdateWorkteamRequest.Builder> updateWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
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 viaUpdateWorkteamRequest.builder()
- Parameters:
updateWorkteamRequest
- AConsumer
that will call methods onUpdateWorkteamRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorkteam operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
- AWS API Documentation
-
waiter
default SageMakerWaiter waiter()
Create an instance ofSageMakerWaiter
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
SageMakerWaiter
-
create
static SageMakerClient create()
Create aSageMakerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static SageMakerClientBuilder builder()
Create a builder that can be used to configure and create aSageMakerClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SageMakerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-