@Generated(value="software.amazon.awssdk:codegen") public interface SageMakerClient extends SdkClient
builder()
method.
Definition of the public APIs exposed by SageMakerModifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Adds or overwrites one or more tags for the specified Amazon SageMaker resource.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds or overwrites one or more tags for the specified Amazon SageMaker resource.
|
static SageMakerClientBuilder |
builder()
Create a builder that can be used to configure and create a
SageMakerClient . |
static SageMakerClient |
create()
Create a
SageMakerClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAlgorithmResponse |
createAlgorithm(Consumer<CreateAlgorithmRequest.Builder> createAlgorithmRequest)
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
|
default CreateAlgorithmResponse |
createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest)
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
|
default CreateCodeRepositoryResponse |
createCodeRepository(Consumer<CreateCodeRepositoryRequest.Builder> createCodeRepositoryRequest)
Create a git repository as a resource in your Amazon SageMaker account.
|
default CreateCodeRepositoryResponse |
createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest)
Create a git repository as a resource in your Amazon SageMaker account.
|
default CreateCompilationJobResponse |
createCompilationJob(Consumer<CreateCompilationJobRequest.Builder> createCompilationJobRequest)
Starts a model compilation job.
|
default CreateCompilationJobResponse |
createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest)
Starts a model compilation job.
|
default CreateEndpointResponse |
createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest)
Creates an endpoint using the endpoint configuration specified in the request.
|
default CreateEndpointResponse |
createEndpoint(CreateEndpointRequest createEndpointRequest)
Creates an endpoint using the endpoint configuration specified in the request.
|
default CreateEndpointConfigResponse |
createEndpointConfig(Consumer<CreateEndpointConfigRequest.Builder> createEndpointConfigRequest)
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.
|
default CreateEndpointConfigResponse |
createEndpointConfig(CreateEndpointConfigRequest createEndpointConfigRequest)
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models.
|
default CreateHyperParameterTuningJobResponse |
createHyperParameterTuningJob(Consumer<CreateHyperParameterTuningJobRequest.Builder> createHyperParameterTuningJobRequest)
Starts a hyperparameter tuning job.
|
default CreateHyperParameterTuningJobResponse |
createHyperParameterTuningJob(CreateHyperParameterTuningJobRequest createHyperParameterTuningJobRequest)
Starts a hyperparameter tuning job.
|
default CreateLabelingJobResponse |
createLabelingJob(Consumer<CreateLabelingJobRequest.Builder> createLabelingJobRequest)
Creates a job that uses human workers to label the data objects in your input dataset.
|
default CreateLabelingJobResponse |
createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest)
Creates a job that uses human workers to label the data objects in your input dataset.
|
default CreateModelResponse |
createModel(Consumer<CreateModelRequest.Builder> createModelRequest)
Creates a model in Amazon SageMaker.
|
default CreateModelResponse |
createModel(CreateModelRequest createModelRequest)
Creates a model in Amazon SageMaker.
|
default CreateModelPackageResponse |
createModelPackage(Consumer<CreateModelPackageRequest.Builder> createModelPackageRequest)
Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace.
|
default CreateModelPackageResponse |
createModelPackage(CreateModelPackageRequest createModelPackageRequest)
Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace.
|
default CreateNotebookInstanceResponse |
createNotebookInstance(Consumer<CreateNotebookInstanceRequest.Builder> createNotebookInstanceRequest)
Creates an Amazon SageMaker notebook instance.
|
default CreateNotebookInstanceResponse |
createNotebookInstance(CreateNotebookInstanceRequest createNotebookInstanceRequest)
Creates an Amazon SageMaker notebook instance.
|
default CreateNotebookInstanceLifecycleConfigResponse |
createNotebookInstanceLifecycleConfig(Consumer<CreateNotebookInstanceLifecycleConfigRequest.Builder> createNotebookInstanceLifecycleConfigRequest)
Creates a lifecycle configuration that you can associate with a notebook instance.
|
default CreateNotebookInstanceLifecycleConfigResponse |
createNotebookInstanceLifecycleConfig(CreateNotebookInstanceLifecycleConfigRequest createNotebookInstanceLifecycleConfigRequest)
Creates a lifecycle configuration that you can associate with a notebook instance.
|
default CreatePresignedNotebookInstanceUrlResponse |
createPresignedNotebookInstanceUrl(Consumer<CreatePresignedNotebookInstanceUrlRequest.Builder> createPresignedNotebookInstanceUrlRequest)
Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
|
default CreatePresignedNotebookInstanceUrlResponse |
createPresignedNotebookInstanceUrl(CreatePresignedNotebookInstanceUrlRequest createPresignedNotebookInstanceUrlRequest)
Returns a URL that you can use to connect to the Jupyter server from a notebook instance.
|
default CreateTrainingJobResponse |
createTrainingJob(Consumer<CreateTrainingJobRequest.Builder> createTrainingJobRequest)
Starts a model training job.
|
default CreateTrainingJobResponse |
createTrainingJob(CreateTrainingJobRequest createTrainingJobRequest)
Starts a model training job.
|
default CreateTransformJobResponse |
createTransformJob(Consumer<CreateTransformJobRequest.Builder> createTransformJobRequest)
Starts a transform job.
|
default CreateTransformJobResponse |
createTransformJob(CreateTransformJobRequest createTransformJobRequest)
Starts a transform job.
|
default CreateWorkteamResponse |
createWorkteam(Consumer<CreateWorkteamRequest.Builder> createWorkteamRequest)
Creates a new work team for labeling your data.
|
default CreateWorkteamResponse |
createWorkteam(CreateWorkteamRequest createWorkteamRequest)
Creates a new work team for labeling your data.
|
default DeleteAlgorithmResponse |
deleteAlgorithm(Consumer<DeleteAlgorithmRequest.Builder> deleteAlgorithmRequest)
Removes the specified algorithm from your account.
|
default DeleteAlgorithmResponse |
deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest)
Removes the specified algorithm from your account.
|
default DeleteCodeRepositoryResponse |
deleteCodeRepository(Consumer<DeleteCodeRepositoryRequest.Builder> deleteCodeRepositoryRequest)
Deletes the specified git repository from your account.
|
default DeleteCodeRepositoryResponse |
deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest)
Deletes the specified git repository from your account.
|
default DeleteEndpointResponse |
deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)
Deletes an endpoint.
|
default DeleteEndpointResponse |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes an endpoint.
|
default DeleteEndpointConfigResponse |
deleteEndpointConfig(Consumer<DeleteEndpointConfigRequest.Builder> deleteEndpointConfigRequest)
Deletes an endpoint configuration.
|
default DeleteEndpointConfigResponse |
deleteEndpointConfig(DeleteEndpointConfigRequest deleteEndpointConfigRequest)
Deletes an endpoint configuration.
|
default DeleteModelResponse |
deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)
Deletes a model.
|
default DeleteModelResponse |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
default DeleteModelPackageResponse |
deleteModelPackage(Consumer<DeleteModelPackageRequest.Builder> deleteModelPackageRequest)
Deletes a model package.
|
default DeleteModelPackageResponse |
deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest)
Deletes a model package.
|
default DeleteNotebookInstanceResponse |
deleteNotebookInstance(Consumer<DeleteNotebookInstanceRequest.Builder> deleteNotebookInstanceRequest)
Deletes an Amazon SageMaker notebook instance.
|
default DeleteNotebookInstanceResponse |
deleteNotebookInstance(DeleteNotebookInstanceRequest deleteNotebookInstanceRequest)
Deletes an Amazon SageMaker notebook instance.
|
default DeleteNotebookInstanceLifecycleConfigResponse |
deleteNotebookInstanceLifecycleConfig(Consumer<DeleteNotebookInstanceLifecycleConfigRequest.Builder> deleteNotebookInstanceLifecycleConfigRequest)
Deletes a notebook instance lifecycle configuration.
|
default DeleteNotebookInstanceLifecycleConfigResponse |
deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest)
Deletes a notebook instance lifecycle configuration.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from an Amazon SageMaker resource.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from an Amazon SageMaker resource.
|
default DeleteWorkteamResponse |
deleteWorkteam(Consumer<DeleteWorkteamRequest.Builder> deleteWorkteamRequest)
Deletes an existing work team.
|
default DeleteWorkteamResponse |
deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest)
Deletes an existing work team.
|
default DescribeAlgorithmResponse |
describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)
Returns a description of the specified algorithm that is in your account.
|
default DescribeAlgorithmResponse |
describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
Returns a description of the specified algorithm that is in your account.
|
default DescribeCodeRepositoryResponse |
describeCodeRepository(Consumer<DescribeCodeRepositoryRequest.Builder> describeCodeRepositoryRequest)
Gets details about the specified git repository.
|
default DescribeCodeRepositoryResponse |
describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest)
Gets details about the specified git repository.
|
default DescribeCompilationJobResponse |
describeCompilationJob(Consumer<DescribeCompilationJobRequest.Builder> describeCompilationJobRequest)
Returns information about a model compilation job.
|
default DescribeCompilationJobResponse |
describeCompilationJob(DescribeCompilationJobRequest describeCompilationJobRequest)
Returns information about a model compilation job.
|
default DescribeEndpointResponse |
describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest)
Returns the description of an endpoint.
|
default DescribeEndpointResponse |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns the description of an endpoint.
|
default DescribeEndpointConfigResponse |
describeEndpointConfig(Consumer<DescribeEndpointConfigRequest.Builder> describeEndpointConfigRequest)
Returns the description of an endpoint configuration created using the
CreateEndpointConfig API. |
default DescribeEndpointConfigResponse |
describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest)
Returns the description of an endpoint configuration created using the
CreateEndpointConfig API. |
default DescribeHyperParameterTuningJobResponse |
describeHyperParameterTuningJob(Consumer<DescribeHyperParameterTuningJobRequest.Builder> describeHyperParameterTuningJobRequest)
Gets a description of a hyperparameter tuning job.
|
default DescribeHyperParameterTuningJobResponse |
describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest)
Gets a description of a hyperparameter tuning job.
|
default DescribeLabelingJobResponse |
describeLabelingJob(Consumer<DescribeLabelingJobRequest.Builder> describeLabelingJobRequest)
Gets information about a labeling job.
|
default DescribeLabelingJobResponse |
describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest)
Gets information about a labeling job.
|
default DescribeModelResponse |
describeModel(Consumer<DescribeModelRequest.Builder> describeModelRequest)
Describes a model that you created using the
CreateModel API. |
default DescribeModelResponse |
describeModel(DescribeModelRequest describeModelRequest)
Describes a model that you created using the
CreateModel API. |
default DescribeModelPackageResponse |
describeModelPackage(Consumer<DescribeModelPackageRequest.Builder> describeModelPackageRequest)
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list on
AWS Marketplace.
|
default DescribeModelPackageResponse |
describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest)
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list on
AWS Marketplace.
|
default DescribeNotebookInstanceResponse |
describeNotebookInstance(Consumer<DescribeNotebookInstanceRequest.Builder> describeNotebookInstanceRequest)
Returns information about a notebook instance.
|
default DescribeNotebookInstanceResponse |
describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest)
Returns information about a notebook instance.
|
default DescribeNotebookInstanceLifecycleConfigResponse |
describeNotebookInstanceLifecycleConfig(Consumer<DescribeNotebookInstanceLifecycleConfigRequest.Builder> describeNotebookInstanceLifecycleConfigRequest)
Returns a description of a notebook instance lifecycle configuration.
|
default DescribeNotebookInstanceLifecycleConfigResponse |
describeNotebookInstanceLifecycleConfig(DescribeNotebookInstanceLifecycleConfigRequest describeNotebookInstanceLifecycleConfigRequest)
Returns a description of a notebook instance lifecycle configuration.
|
default DescribeSubscribedWorkteamResponse |
describeSubscribedWorkteam(Consumer<DescribeSubscribedWorkteamRequest.Builder> describeSubscribedWorkteamRequest)
Gets information about a work team provided by a vendor.
|
default DescribeSubscribedWorkteamResponse |
describeSubscribedWorkteam(DescribeSubscribedWorkteamRequest describeSubscribedWorkteamRequest)
Gets information about a work team provided by a vendor.
|
default DescribeTrainingJobResponse |
describeTrainingJob(Consumer<DescribeTrainingJobRequest.Builder> describeTrainingJobRequest)
Returns information about a training job.
|
default DescribeTrainingJobResponse |
describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest)
Returns information about a training job.
|
default DescribeTransformJobResponse |
describeTransformJob(Consumer<DescribeTransformJobRequest.Builder> describeTransformJobRequest)
Returns information about a transform job.
|
default DescribeTransformJobResponse |
describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest)
Returns information about a transform job.
|
default DescribeWorkteamResponse |
describeWorkteam(Consumer<DescribeWorkteamRequest.Builder> describeWorkteamRequest)
Gets information about a specific work team.
|
default DescribeWorkteamResponse |
describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest)
Gets information about a specific work team.
|
default GetSearchSuggestionsResponse |
getSearchSuggestions(Consumer<GetSearchSuggestionsRequest.Builder> getSearchSuggestionsRequest)
Returns suggestions for the property name to use in
Search queries. |
default GetSearchSuggestionsResponse |
getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest)
Returns suggestions for the property name to use in
Search queries. |
default ListAlgorithmsResponse |
listAlgorithms()
Lists the machine learning algorithms that have been created.
|
default ListAlgorithmsResponse |
listAlgorithms(Consumer<ListAlgorithmsRequest.Builder> listAlgorithmsRequest)
Lists the machine learning algorithms that have been created.
|
default ListAlgorithmsResponse |
listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest)
Lists the machine learning algorithms that have been created.
|
default ListCodeRepositoriesResponse |
listCodeRepositories()
Gets a list of the git repositories in your account.
|
default ListCodeRepositoriesResponse |
listCodeRepositories(Consumer<ListCodeRepositoriesRequest.Builder> listCodeRepositoriesRequest)
Gets a list of the git repositories in your account.
|
default ListCodeRepositoriesResponse |
listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest)
Gets a list of the git repositories in your account.
|
default ListCompilationJobsResponse |
listCompilationJobs()
Lists model compilation jobs that satisfy various filters.
|
default ListCompilationJobsResponse |
listCompilationJobs(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest)
Lists model compilation jobs that satisfy various filters.
|
default ListCompilationJobsResponse |
listCompilationJobs(ListCompilationJobsRequest listCompilationJobsRequest)
Lists model compilation jobs that satisfy various filters.
|
default ListCompilationJobsIterable |
listCompilationJobsPaginator()
Lists model compilation jobs that satisfy various filters.
|
default ListCompilationJobsIterable |
listCompilationJobsPaginator(Consumer<ListCompilationJobsRequest.Builder> listCompilationJobsRequest)
Lists model compilation jobs that satisfy various filters.
|
default ListCompilationJobsIterable |
listCompilationJobsPaginator(ListCompilationJobsRequest listCompilationJobsRequest)
Lists model compilation jobs that satisfy various filters.
|
default ListEndpointConfigsResponse |
listEndpointConfigs()
Lists endpoint configurations.
|
default ListEndpointConfigsResponse |
listEndpointConfigs(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest)
Lists endpoint configurations.
|
default ListEndpointConfigsResponse |
listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest)
Lists endpoint configurations.
|
default ListEndpointConfigsIterable |
listEndpointConfigsPaginator()
Lists endpoint configurations.
|
default ListEndpointConfigsIterable |
listEndpointConfigsPaginator(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest)
Lists endpoint configurations.
|
default ListEndpointConfigsIterable |
listEndpointConfigsPaginator(ListEndpointConfigsRequest listEndpointConfigsRequest)
Lists endpoint configurations.
|
default ListEndpointsResponse |
listEndpoints()
Lists endpoints.
|
default ListEndpointsResponse |
listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Lists endpoints.
|
default ListEndpointsResponse |
listEndpoints(ListEndpointsRequest listEndpointsRequest)
Lists endpoints.
|
default ListEndpointsIterable |
listEndpointsPaginator()
Lists endpoints.
|
default ListEndpointsIterable |
listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest)
Lists endpoints.
|
default ListEndpointsIterable |
listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest)
Lists endpoints.
|
default ListHyperParameterTuningJobsResponse |
listHyperParameterTuningJobs()
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListHyperParameterTuningJobsResponse |
listHyperParameterTuningJobs(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest)
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListHyperParameterTuningJobsResponse |
listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListHyperParameterTuningJobsIterable |
listHyperParameterTuningJobsPaginator()
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListHyperParameterTuningJobsIterable |
listHyperParameterTuningJobsPaginator(Consumer<ListHyperParameterTuningJobsRequest.Builder> listHyperParameterTuningJobsRequest)
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListHyperParameterTuningJobsIterable |
listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest)
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs
launched in your account.
|
default ListLabelingJobsResponse |
listLabelingJobs()
Gets a list of labeling jobs.
|
default ListLabelingJobsResponse |
listLabelingJobs(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest)
Gets a list of labeling jobs.
|
default ListLabelingJobsResponse |
listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest)
Gets a list of labeling jobs.
|
default ListLabelingJobsForWorkteamResponse |
listLabelingJobsForWorkteam(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest)
Gets a list of labeling jobs assigned to a specified work team.
|
default ListLabelingJobsForWorkteamResponse |
listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)
Gets a list of labeling jobs assigned to a specified work team.
|
default ListLabelingJobsForWorkteamIterable |
listLabelingJobsForWorkteamPaginator(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest)
Gets a list of labeling jobs assigned to a specified work team.
|
default ListLabelingJobsForWorkteamIterable |
listLabelingJobsForWorkteamPaginator(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest)
Gets a list of labeling jobs assigned to a specified work team.
|
default ListLabelingJobsIterable |
listLabelingJobsPaginator()
Gets a list of labeling jobs.
|
default ListLabelingJobsIterable |
listLabelingJobsPaginator(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest)
Gets a list of labeling jobs.
|
default ListLabelingJobsIterable |
listLabelingJobsPaginator(ListLabelingJobsRequest listLabelingJobsRequest)
Gets a list of labeling jobs.
|
default ListModelPackagesResponse |
listModelPackages()
Lists the model packages that have been created.
|
default ListModelPackagesResponse |
listModelPackages(Consumer<ListModelPackagesRequest.Builder> listModelPackagesRequest)
Lists the model packages that have been created.
|
default ListModelPackagesResponse |
listModelPackages(ListModelPackagesRequest listModelPackagesRequest)
Lists the model packages that have been created.
|
default ListModelsResponse |
listModels()
Lists models created with the CreateModel API.
|
default ListModelsResponse |
listModels(Consumer<ListModelsRequest.Builder> listModelsRequest)
Lists models created with the CreateModel API.
|
default ListModelsResponse |
listModels(ListModelsRequest listModelsRequest)
Lists models created with the CreateModel API.
|
default ListModelsIterable |
listModelsPaginator()
Lists models created with the CreateModel API.
|
default ListModelsIterable |
listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest)
Lists models created with the CreateModel API.
|
default ListModelsIterable |
listModelsPaginator(ListModelsRequest listModelsRequest)
Lists models created with the CreateModel API.
|
default ListNotebookInstanceLifecycleConfigsResponse |
listNotebookInstanceLifecycleConfigs()
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstanceLifecycleConfigsResponse |
listNotebookInstanceLifecycleConfigs(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest)
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstanceLifecycleConfigsResponse |
listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstanceLifecycleConfigsIterable |
listNotebookInstanceLifecycleConfigsPaginator()
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstanceLifecycleConfigsIterable |
listNotebookInstanceLifecycleConfigsPaginator(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest)
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstanceLifecycleConfigsIterable |
listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest)
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig
API.
|
default ListNotebookInstancesResponse |
listNotebookInstances()
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListNotebookInstancesResponse |
listNotebookInstances(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest)
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListNotebookInstancesResponse |
listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest)
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListNotebookInstancesIterable |
listNotebookInstancesPaginator()
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListNotebookInstancesIterable |
listNotebookInstancesPaginator(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest)
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListNotebookInstancesIterable |
listNotebookInstancesPaginator(ListNotebookInstancesRequest listNotebookInstancesRequest)
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
|
default ListSubscribedWorkteamsResponse |
listSubscribedWorkteams()
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListSubscribedWorkteamsResponse |
listSubscribedWorkteams(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest)
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListSubscribedWorkteamsResponse |
listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListSubscribedWorkteamsIterable |
listSubscribedWorkteamsPaginator()
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListSubscribedWorkteamsIterable |
listSubscribedWorkteamsPaginator(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest)
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListSubscribedWorkteamsIterable |
listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest)
Gets a list of the work teams that you are subscribed to in the AWS Marketplace.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns the tags for the specified Amazon SageMaker resource.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Returns the tags for the specified Amazon SageMaker resource.
|
default ListTagsIterable |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns the tags for the specified Amazon SageMaker resource.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Returns the tags for the specified Amazon SageMaker resource.
|
default ListTrainingJobsResponse |
listTrainingJobs()
Lists training jobs.
|
default ListTrainingJobsResponse |
listTrainingJobs(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest)
Lists training jobs.
|
default ListTrainingJobsResponse |
listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest)
Lists training jobs.
|
default ListTrainingJobsForHyperParameterTuningJobResponse |
listTrainingJobsForHyperParameterTuningJob(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest)
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job
launched.
|
default ListTrainingJobsForHyperParameterTuningJobResponse |
listTrainingJobsForHyperParameterTuningJob(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job
launched.
|
default ListTrainingJobsForHyperParameterTuningJobIterable |
listTrainingJobsForHyperParameterTuningJobPaginator(Consumer<ListTrainingJobsForHyperParameterTuningJobRequest.Builder> listTrainingJobsForHyperParameterTuningJobRequest)
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job
launched.
|
default ListTrainingJobsForHyperParameterTuningJobIterable |
listTrainingJobsForHyperParameterTuningJobPaginator(ListTrainingJobsForHyperParameterTuningJobRequest listTrainingJobsForHyperParameterTuningJobRequest)
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job
launched.
|
default ListTrainingJobsIterable |
listTrainingJobsPaginator()
Lists training jobs.
|
default ListTrainingJobsIterable |
listTrainingJobsPaginator(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest)
Lists training jobs.
|
default ListTrainingJobsIterable |
listTrainingJobsPaginator(ListTrainingJobsRequest listTrainingJobsRequest)
Lists training jobs.
|
default ListTransformJobsResponse |
listTransformJobs()
Lists transform jobs.
|
default ListTransformJobsResponse |
listTransformJobs(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest)
Lists transform jobs.
|
default ListTransformJobsResponse |
listTransformJobs(ListTransformJobsRequest listTransformJobsRequest)
Lists transform jobs.
|
default ListTransformJobsIterable |
listTransformJobsPaginator()
Lists transform jobs.
|
default ListTransformJobsIterable |
listTransformJobsPaginator(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest)
Lists transform jobs.
|
default ListTransformJobsIterable |
listTransformJobsPaginator(ListTransformJobsRequest listTransformJobsRequest)
Lists transform jobs.
|
default ListWorkteamsResponse |
listWorkteams()
Gets a list of work teams that you have defined in a region.
|
default ListWorkteamsResponse |
listWorkteams(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest)
Gets a list of work teams that you have defined in a region.
|
default ListWorkteamsResponse |
listWorkteams(ListWorkteamsRequest listWorkteamsRequest)
Gets a list of work teams that you have defined in a region.
|
default ListWorkteamsIterable |
listWorkteamsPaginator()
Gets a list of work teams that you have defined in a region.
|
default ListWorkteamsIterable |
listWorkteamsPaginator(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest)
Gets a list of work teams that you have defined in a region.
|
default ListWorkteamsIterable |
listWorkteamsPaginator(ListWorkteamsRequest listWorkteamsRequest)
Gets a list of work teams that you have defined in a region.
|
default RenderUiTemplateResponse |
renderUiTemplate(Consumer<RenderUiTemplateRequest.Builder> renderUiTemplateRequest)
Renders the UI template so that you can preview the worker's experience.
|
default RenderUiTemplateResponse |
renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest)
Renders the UI template so that you can preview the worker's experience.
|
default SearchResponse |
search(Consumer<SearchRequest.Builder> searchRequest)
Finds Amazon SageMaker resources that match a search query.
|
default SearchResponse |
search(SearchRequest searchRequest)
Finds Amazon SageMaker resources that match a search query.
|
default SearchIterable |
searchPaginator(Consumer<SearchRequest.Builder> searchRequest)
Finds Amazon SageMaker resources that match a search query.
|
default SearchIterable |
searchPaginator(SearchRequest searchRequest)
Finds Amazon SageMaker resources that match a search query.
|
static ServiceMetadata |
serviceMetadata() |
default StartNotebookInstanceResponse |
startNotebookInstance(Consumer<StartNotebookInstanceRequest.Builder> startNotebookInstanceRequest)
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
|
default StartNotebookInstanceResponse |
startNotebookInstance(StartNotebookInstanceRequest startNotebookInstanceRequest)
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume.
|
default StopCompilationJobResponse |
stopCompilationJob(Consumer<StopCompilationJobRequest.Builder> stopCompilationJobRequest)
Stops a model compilation job.
|
default StopCompilationJobResponse |
stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest)
Stops a model compilation job.
|
default StopHyperParameterTuningJobResponse |
stopHyperParameterTuningJob(Consumer<StopHyperParameterTuningJobRequest.Builder> stopHyperParameterTuningJobRequest)
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
|
default StopHyperParameterTuningJobResponse |
stopHyperParameterTuningJob(StopHyperParameterTuningJobRequest stopHyperParameterTuningJobRequest)
Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
|
default StopLabelingJobResponse |
stopLabelingJob(Consumer<StopLabelingJobRequest.Builder> stopLabelingJobRequest)
Stops a running labeling job.
|
default StopLabelingJobResponse |
stopLabelingJob(StopLabelingJobRequest stopLabelingJobRequest)
Stops a running labeling job.
|
default StopNotebookInstanceResponse |
stopNotebookInstance(Consumer<StopNotebookInstanceRequest.Builder> stopNotebookInstanceRequest)
Terminates the ML compute instance.
|
default StopNotebookInstanceResponse |
stopNotebookInstance(StopNotebookInstanceRequest stopNotebookInstanceRequest)
Terminates the ML compute instance.
|
default StopTrainingJobResponse |
stopTrainingJob(Consumer<StopTrainingJobRequest.Builder> stopTrainingJobRequest)
Stops a training job.
|
default StopTrainingJobResponse |
stopTrainingJob(StopTrainingJobRequest stopTrainingJobRequest)
Stops a training job.
|
default StopTransformJobResponse |
stopTransformJob(Consumer<StopTransformJobRequest.Builder> stopTransformJobRequest)
Stops a transform job.
|
default StopTransformJobResponse |
stopTransformJob(StopTransformJobRequest stopTransformJobRequest)
Stops a transform job.
|
default UpdateCodeRepositoryResponse |
updateCodeRepository(Consumer<UpdateCodeRepositoryRequest.Builder> updateCodeRepositoryRequest)
Updates the specified git repository with the specified values.
|
default UpdateCodeRepositoryResponse |
updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest)
Updates the specified git repository with the specified values.
|
default UpdateEndpointResponse |
updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest)
Deploys the new
EndpointConfig specified in the request, switches to using newly created endpoint,
and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is
no availability loss). |
default UpdateEndpointResponse |
updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
Deploys the new
EndpointConfig specified in the request, switches to using newly created endpoint,
and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is
no availability loss). |
default UpdateEndpointWeightsAndCapacitiesResponse |
updateEndpointWeightsAndCapacities(Consumer<UpdateEndpointWeightsAndCapacitiesRequest.Builder> updateEndpointWeightsAndCapacitiesRequest)
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant
associated with an existing endpoint.
|
default UpdateEndpointWeightsAndCapacitiesResponse |
updateEndpointWeightsAndCapacities(UpdateEndpointWeightsAndCapacitiesRequest updateEndpointWeightsAndCapacitiesRequest)
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant
associated with an existing endpoint.
|
default UpdateNotebookInstanceResponse |
updateNotebookInstance(Consumer<UpdateNotebookInstanceRequest.Builder> updateNotebookInstanceRequest)
Updates a notebook instance.
|
default UpdateNotebookInstanceResponse |
updateNotebookInstance(UpdateNotebookInstanceRequest updateNotebookInstanceRequest)
Updates a notebook instance.
|
default UpdateNotebookInstanceLifecycleConfigResponse |
updateNotebookInstanceLifecycleConfig(Consumer<UpdateNotebookInstanceLifecycleConfigRequest.Builder> updateNotebookInstanceLifecycleConfigRequest)
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig
API.
|
default UpdateNotebookInstanceLifecycleConfigResponse |
updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest)
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig
API.
|
default UpdateWorkteamResponse |
updateWorkteam(Consumer<UpdateWorkteamRequest.Builder> updateWorkteamRequest)
Updates an existing work team with new member definitions or description.
|
default UpdateWorkteamResponse |
updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest)
Updates an existing work team with new member definitions or description.
|
serviceName
close
static final String SERVICE_NAME
static SageMakerClient create()
SageMakerClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SageMakerClientBuilder builder()
SageMakerClient
.default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, models, 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 AWS Tagging Strategies.
Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the
hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter
tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter
tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you
first create the tuning job by specifying them in the Tags
parameter of
CreateHyperParameterTuningJob
addTagsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, models, 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 AWS Tagging Strategies.
Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the
hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter
tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter
tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you
first create the tuning job by specifying them in the Tags
parameter of
CreateHyperParameterTuningJob
This is a convenience which creates an instance of the AddTagsRequest.Builder
avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest
- A Consumer
that will call methods on AddTagsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAlgorithmResponse createAlgorithm(CreateAlgorithmRequest createAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
createAlgorithmRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAlgorithmResponse createAlgorithm(Consumer<CreateAlgorithmRequest.Builder> createAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
This is a convenience which creates an instance of the CreateAlgorithmRequest.Builder
avoiding the need
to create one manually via CreateAlgorithmRequest.builder()
createAlgorithmRequest
- A Consumer
that will call methods on CreateAlgorithmInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCodeRepositoryResponse createCodeRepository(CreateCodeRepositoryRequest createCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Create a git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use git source control for the notebooks you create. The git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in AWS CodeCommit or in any other git repository.
createCodeRepositoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCodeRepositoryResponse createCodeRepository(Consumer<CreateCodeRepositoryRequest.Builder> createCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Create a git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use git source control for the notebooks you create. The git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in AWS CodeCommit or in any other git repository.
This is a convenience which creates an instance of the CreateCodeRepositoryRequest.Builder
avoiding the
need to create one manually via CreateCodeRepositoryRequest.builder()
createCodeRepositoryRequest
- A Consumer
that will call methods on CreateCodeRepositoryInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCompilationJobResponse createCompilationJob(CreateCompilationJobRequest createCompilationJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job
You can also provide a Tag
to track the model compilation job's resource use and costs. The response
body contains the CompilationJobArn
for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
createCompilationJobRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
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 saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job
You can also provide a Tag
to track the model compilation job's resource use and costs. The response
body contains the CompilationJobArn
for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
This is a convenience which creates an instance of the CreateCompilationJobRequest.Builder
avoiding the
need to create one manually via CreateCompilationJobRequest.builder()
createCompilationJobRequest
- A Consumer
that will call methods on CreateCompilationJobRequest.Builder
to create a
request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API only for hosting models using Amazon SageMaker hosting services.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating
. After it
creates the endpoint, it sets the status to InService
. Amazon SageMaker can then process incoming
requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.
createEndpointRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API only for hosting models using Amazon SageMaker hosting services.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating
. After it
creates the endpoint, it sets the status to InService
. Amazon SageMaker can then process incoming
requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.
This is a convenience which creates an instance of the CreateEndpointRequest.Builder
avoiding the need to
create one manually via CreateEndpointRequest.builder()
createEndpointRequest
- A Consumer
that will call methods on CreateEndpointInput.Builder
to create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateEndpointConfigResponse createEndpointConfig(CreateEndpointConfigRequest createEndpointConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an endpoint configuration that Amazon 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 Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define one or more ProductionVariant
s, each of which identifies a model. Each
ProductionVariant
parameter also describes the resources that you want Amazon 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. Amazon SageMaker distributes two-thirds of the traffic to Model
A, and one-third to model B.
createEndpointConfigRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateEndpointConfigResponse createEndpointConfig(Consumer<CreateEndpointConfigRequest.Builder> createEndpointConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an endpoint configuration that Amazon 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 Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define one or more ProductionVariant
s, each of which identifies a model. Each
ProductionVariant
parameter also describes the resources that you want Amazon 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. Amazon SageMaker distributes two-thirds of the traffic to Model
A, and one-third to model B.
This is a convenience which creates an instance of the CreateEndpointConfigRequest.Builder
avoiding the
need to create one manually via CreateEndpointConfigRequest.builder()
createEndpointConfigRequest
- A Consumer
that will call methods on CreateEndpointConfigInput.Builder
to create a
request.ResourceLimitExceededException
- You have exceeded an Amazon 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
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.
createHyperParameterTuningJobRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
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.
This is a convenience which creates an instance of the CreateHyperParameterTuningJobRequest.Builder
avoiding the need to create one manually via CreateHyperParameterTuningJobRequest.builder()
createHyperParameterTuningJobRequest
- A Consumer
that will call methods on CreateHyperParameterTuningJobRequest.Builder
to
create a request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateLabelingJobResponse createLabelingJob(CreateLabelingJobRequest createLabelingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a job that uses human 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 the data is highly confidential or a specific set of skills is required.
One or more vendors that you select from the Amazon Marketplace. Vendors provide expertise in specific areas. Vendors are selected by AWS and meet a minimum standard of data security requirements.
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.
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.
createLabelingJobRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateLabelingJobResponse createLabelingJob(Consumer<CreateLabelingJobRequest.Builder> createLabelingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a job that uses human 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 the data is highly confidential or a specific set of skills is required.
One or more vendors that you select from the Amazon Marketplace. Vendors provide expertise in specific areas. Vendors are selected by AWS and meet a minimum standard of data security requirements.
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.
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.
This is a convenience which creates an instance of the CreateLabelingJobRequest.Builder
avoiding the need
to create one manually via CreateLabelingJobRequest.builder()
createLabelingJobRequest
- A Consumer
that will call methods on CreateLabelingJobRequest.Builder
to create a request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateModelResponse createModel(CreateModelRequest createModelRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and 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 Amazon SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig
API, and then
create an endpoint with the CreateEndpoint
API. Amazon 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. Amazon
SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the CreateModel
request, you must define a container with the PrimaryContainer
parameter.
In the request, you also provide an IAM role that Amazon 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 AWS resources, you grant necessary permissions via this role.
createModelRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateModelResponse createModel(Consumer<CreateModelRequest.Builder> createModelRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and 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 Amazon SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig
API, and then
create an endpoint with the CreateEndpoint
API. Amazon 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. Amazon
SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the CreateModel
request, you must define a container with the PrimaryContainer
parameter.
In the request, you also provide an IAM role that Amazon 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 AWS resources, you grant necessary permissions via this role.
This is a convenience which creates an instance of the CreateModelRequest.Builder
avoiding the need to
create one manually via CreateModelRequest.builder()
createModelRequest
- A Consumer
that will call methods on CreateModelInput.Builder
to create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateModelPackageResponse createModelPackage(CreateModelPackageRequest createModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
createModelPackageRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateModelPackageResponse createModelPackage(Consumer<CreateModelPackageRequest.Builder> createModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
This is a convenience which creates an instance of the CreateModelPackageRequest.Builder
avoiding the
need to create one manually via CreateModelPackageRequest.builder()
createModelPackageRequest
- A Consumer
that will call methods on CreateModelPackageInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateNotebookInstanceResponse createNotebookInstance(CreateNotebookInstanceRequest createNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance
request, specify the type of ML compute instance that you want to run.
Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model
training, and attaches an ML storage volume to the notebook instance.
Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, Amazon SageMaker does the following:
Creates a network interface in the Amazon SageMaker VPC.
(Option) If you specified SubnetId
, Amazon SageMaker creates a network interface in your own VPC,
which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon
SageMaker 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 Amazon SageMaker VPC. If you specified
SubnetId
of your VPC, Amazon SageMaker specifies both network interfaces when launching this
instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security
groups allow it.
After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN).
After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.
For more information, see How It Works.
createNotebookInstanceRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateNotebookInstanceResponse createNotebookInstance(Consumer<CreateNotebookInstanceRequest.Builder> createNotebookInstanceRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance
request, specify the type of ML compute instance that you want to run.
Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model
training, and attaches an ML storage volume to the notebook instance.
Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, Amazon SageMaker does the following:
Creates a network interface in the Amazon SageMaker VPC.
(Option) If you specified SubnetId
, Amazon SageMaker creates a network interface in your own VPC,
which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon
SageMaker 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 Amazon SageMaker VPC. If you specified
SubnetId
of your VPC, Amazon SageMaker specifies both network interfaces when launching this
instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security
groups allow it.
After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN).
After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.
For more information, see How It Works.
This is a convenience which creates an instance of the CreateNotebookInstanceRequest.Builder
avoiding the
need to create one manually via CreateNotebookInstanceRequest.builder()
createNotebookInstanceRequest
- A Consumer
that will call methods on CreateNotebookInstanceInput.Builder
to create a
request.ResourceLimitExceededException
- You have exceeded an Amazon 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
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 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.
createNotebookInstanceLifecycleConfigRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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 CloudWatch Logs for notebook instance lifecycle configurations in log group
/aws/sagemaker/NotebookInstances
in log stream
[notebook-instance-name]/[LifecycleConfigHook]
.
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
This is a convenience which creates an instance of the
CreateNotebookInstanceLifecycleConfigRequest.Builder
avoiding the need to create one manually via
CreateNotebookInstanceLifecycleConfigRequest.builder()
createNotebookInstanceLifecycleConfigRequest
- A Consumer
that will call methods on CreateNotebookInstanceLifecycleConfigInput.Builder
to
create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
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 Amazon SageMaker
console, when you choose Open
next to a notebook instance, Amazon SageMaker opens a new tab showing
the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the
page.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To
restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in
the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook
instance. Use the NotIpAddress
condition operator and the aws:SourceIP
condition
context key to specify the list of IP addresses that you want to have access to the notebook instance. For more
information, see Limit Access to a Notebook Instance by IP Address.
createPresignedNotebookInstanceUrlRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 Amazon SageMaker
console, when you choose Open
next to a notebook instance, Amazon SageMaker opens a new tab showing
the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the
page.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To
restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in
the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook
instance. Use the NotIpAddress
condition operator and the aws:SourceIP
condition
context key to specify the list of IP addresses that you want to have access to the notebook instance. For more
information, see Limit Access to a Notebook Instance by IP Address.
This is a convenience which creates an instance of the CreatePresignedNotebookInstanceUrlRequest.Builder
avoiding the need to create one manually via CreatePresignedNotebookInstanceUrlRequest.builder()
createPresignedNotebookInstanceUrlRequest
- A Consumer
that will call methods on CreatePresignedNotebookInstanceUrlInput.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrainingJobResponse createTrainingJob(CreateTrainingJobRequest createTrainingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a deep learning service other than Amazon SageMaker, provided that you know how to use them for inferences.
In the request body, you provide the following:
AlgorithmSpecification
- Identifies the training algorithm to use.
HyperParameters
- Specify these algorithm-specific parameters to influence the quality of the final
model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig
- Describes the training dataset and the Amazon S3 location where it is stored.
OutputDataConfig
- Identifies the Amazon S3 location where you want Amazon 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.
RoleARN
- The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your
behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can
successfully complete model training.
StoppingCondition
- Sets a duration for training. Use this parameter to cap model training costs.
For more information about Amazon SageMaker, see How It Works.
createTrainingJobRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateTrainingJobResponse createTrainingJob(Consumer<CreateTrainingJobRequest.Builder> createTrainingJobRequest) throws ResourceInUseException, ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a deep learning service other than Amazon SageMaker, provided that you know how to use them for inferences.
In the request body, you provide the following:
AlgorithmSpecification
- Identifies the training algorithm to use.
HyperParameters
- Specify these algorithm-specific parameters to influence the quality of the final
model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig
- Describes the training dataset and the Amazon S3 location where it is stored.
OutputDataConfig
- Identifies the Amazon S3 location where you want Amazon 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.
RoleARN
- The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your
behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can
successfully complete model training.
StoppingCondition
- Sets a duration for training. Use this parameter to cap model training costs.
For more information about Amazon SageMaker, see How It Works.
This is a convenience which creates an instance of the CreateTrainingJobRequest.Builder
avoiding the need
to create one manually via CreateTrainingJobRequest.builder()
createTrainingJobRequest
- A Consumer
that will call methods on CreateTrainingJobRequest.Builder
to create a request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateTransformJobResponse createTransformJob(CreateTransformJobRequest createTransformJobRequest) throws ResourceInUseException, ResourceLimitExceededException, 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 AWS Region in an
AWS account.
ModelName
- Identifies the model to use. ModelName
must be the name of an existing
Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see
CreateModel.
TransformInput
- Describes the dataset to be transformed and the Amazon S3 location where it is
stored.
TransformOutput
- Identifies the Amazon S3 location where you want Amazon SageMaker to save the
results from the transform job.
TransformResources
- Identifies the ML compute instances for the transform job.
For more information about how batch transformation works Amazon SageMaker, see How It Works.
createTransformJobRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default CreateTransformJobResponse createTransformJob(Consumer<CreateTransformJobRequest.Builder> createTransformJobRequest) throws ResourceInUseException, ResourceLimitExceededException, 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 AWS Region in an
AWS account.
ModelName
- Identifies the model to use. ModelName
must be the name of an existing
Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see
CreateModel.
TransformInput
- Describes the dataset to be transformed and the Amazon S3 location where it is
stored.
TransformOutput
- Identifies the Amazon S3 location where you want Amazon SageMaker to save the
results from the transform job.
TransformResources
- Identifies the ML compute instances for the transform job.
For more information about how batch transformation works Amazon SageMaker, see How It Works.
This is a convenience which creates an instance of the CreateTransformJobRequest.Builder
avoiding the
need to create one manually via CreateTransformJobRequest.builder()
createTransformJobRequest
- A Consumer
that will call methods on CreateTransformJobRequest.Builder
to create a
request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
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.
createWorkteamRequest
- ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
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 via CreateWorkteamRequest.builder()
createWorkteamRequest
- A Consumer
that will call methods on CreateWorkteamRequest.Builder
to create a request.ResourceInUseException
- Resource being accessed is in use.ResourceLimitExceededException
- You have exceeded an Amazon 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
default DeleteAlgorithmResponse deleteAlgorithm(DeleteAlgorithmRequest deleteAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Removes the specified algorithm from your account.
deleteAlgorithmRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAlgorithmResponse deleteAlgorithm(Consumer<DeleteAlgorithmRequest.Builder> deleteAlgorithmRequest) throws 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 via DeleteAlgorithmRequest.builder()
deleteAlgorithmRequest
- A Consumer
that will call methods on DeleteAlgorithmInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCodeRepositoryResponse deleteCodeRepository(DeleteCodeRepositoryRequest deleteCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes the specified git repository from your account.
deleteCodeRepositoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteCodeRepositoryRequest.builder()
deleteCodeRepositoryRequest
- A Consumer
that will call methods on DeleteCodeRepositoryInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
deleteEndpointRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
This is a convenience which creates an instance of the DeleteEndpointRequest.Builder
avoiding the need to
create one manually via DeleteEndpointRequest.builder()
deleteEndpointRequest
- A Consumer
that will call methods on DeleteEndpointInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteEndpointConfigRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
This is a convenience which creates an instance of the DeleteEndpointConfigRequest.Builder
avoiding the
need to create one manually via DeleteEndpointConfigRequest.builder()
deleteEndpointConfigRequest
- A Consumer
that will call methods on DeleteEndpointConfigInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model. The DeleteModel
API deletes only the model entry that was created in Amazon
SageMaker when you called the CreateModel API. It does not
delete model artifacts, inference code, or the IAM role that you specified when creating the model.
deleteModelRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 Amazon
SageMaker when you called the CreateModel API. It does not
delete model artifacts, inference code, or the IAM role that you specified when creating the model.
This is a convenience which creates an instance of the DeleteModelRequest.Builder
avoiding the need to
create one manually via DeleteModelRequest.builder()
deleteModelRequest
- A Consumer
that will call methods on DeleteModelInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteModelPackageResponse deleteModelPackage(DeleteModelPackageRequest deleteModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model package.
A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
deleteModelPackageRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteModelPackageResponse deleteModelPackage(Consumer<DeleteModelPackageRequest.Builder> deleteModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a model package.
A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
This is a convenience which creates an instance of the DeleteModelPackageRequest.Builder
avoiding the
need to create one manually via DeleteModelPackageRequest.builder()
deleteModelPackageRequest
- A Consumer
that will call methods on DeleteModelPackageInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteNotebookInstanceResponse deleteNotebookInstance(DeleteNotebookInstanceRequest deleteNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the
StopNotebookInstance
API.
When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
deleteNotebookInstanceRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteNotebookInstanceResponse deleteNotebookInstance(Consumer<DeleteNotebookInstanceRequest.Builder> deleteNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the
StopNotebookInstance
API.
When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
This is a convenience which creates an instance of the DeleteNotebookInstanceRequest.Builder
avoiding the
need to create one manually via DeleteNotebookInstanceRequest.builder()
deleteNotebookInstanceRequest
- A Consumer
that will call methods on DeleteNotebookInstanceInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteNotebookInstanceLifecycleConfigResponse deleteNotebookInstanceLifecycleConfig(DeleteNotebookInstanceLifecycleConfigRequest deleteNotebookInstanceLifecycleConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes a notebook instance lifecycle configuration.
deleteNotebookInstanceLifecycleConfigRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
DeleteNotebookInstanceLifecycleConfigRequest.builder()
deleteNotebookInstanceLifecycleConfigRequest
- A Consumer
that will call methods on DeleteNotebookInstanceLifecycleConfigInput.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes the specified tags from an Amazon 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.
deleteTagsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Deletes the specified tags from an Amazon 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.
This is a convenience which creates an instance of the DeleteTagsRequest.Builder
avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest
- A Consumer
that will call methods on DeleteTagsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteWorkteamResponse deleteWorkteam(DeleteWorkteamRequest deleteWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Deletes an existing work team. This operation can't be undone.
deleteWorkteamRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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 via DeleteWorkteamRequest.builder()
deleteWorkteamRequest
- A Consumer
that will call methods on DeleteWorkteamRequest.Builder
to create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default DescribeAlgorithmResponse describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified algorithm that is in your account.
describeAlgorithmRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeAlgorithmRequest.builder()
describeAlgorithmRequest
- A Consumer
that will call methods on DescribeAlgorithmInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCodeRepositoryResponse describeCodeRepository(DescribeCodeRepositoryRequest describeCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets details about the specified git repository.
describeCodeRepositoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeCodeRepositoryRequest.builder()
describeCodeRepositoryRequest
- A Consumer
that will call methods on DescribeCodeRepositoryInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeCompilationJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeCompilationJobRequest.builder()
describeCompilationJobRequest
- A Consumer
that will call methods on DescribeCompilationJobRequest.Builder
to create a
request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the description of an endpoint.
describeEndpointRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeEndpointRequest.builder()
describeEndpointRequest
- A Consumer
that will call methods on DescribeEndpointInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEndpointConfigResponse describeEndpointConfig(DescribeEndpointConfigRequest describeEndpointConfigRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the description of an endpoint configuration created using the CreateEndpointConfig
API.
describeEndpointConfigRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeEndpointConfigRequest.builder()
describeEndpointConfigRequest
- A Consumer
that will call methods on DescribeEndpointConfigInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHyperParameterTuningJobResponse describeHyperParameterTuningJob(DescribeHyperParameterTuningJobRequest describeHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a description of a hyperparameter tuning job.
describeHyperParameterTuningJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHyperParameterTuningJobResponse describeHyperParameterTuningJob(Consumer<DescribeHyperParameterTuningJobRequest.Builder> describeHyperParameterTuningJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a description of a hyperparameter tuning job.
This is a convenience which creates an instance of the DescribeHyperParameterTuningJobRequest.Builder
avoiding the need to create one manually via DescribeHyperParameterTuningJobRequest.builder()
describeHyperParameterTuningJobRequest
- A Consumer
that will call methods on DescribeHyperParameterTuningJobRequest.Builder
to
create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeLabelingJobResponse describeLabelingJob(DescribeLabelingJobRequest describeLabelingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets information about a labeling job.
describeLabelingJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeLabelingJobRequest.builder()
describeLabelingJobRequest
- A Consumer
that will call methods on DescribeLabelingJobRequest.Builder
to create a
request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeModelResponse describeModel(DescribeModelRequest describeModelRequest) throws AwsServiceException, SdkClientException, SageMakerException
Describes a model that you created using the CreateModel
API.
describeModelRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeModelRequest.builder()
describeModelRequest
- A Consumer
that will call methods on DescribeModelInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeModelPackageResponse describeModelPackage(DescribeModelPackageRequest describeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list on AWS Marketplace.
Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
describeModelPackageRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeModelPackageResponse describeModelPackage(Consumer<DescribeModelPackageRequest.Builder> describeModelPackageRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list on AWS Marketplace.
Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
This is a convenience which creates an instance of the DescribeModelPackageRequest.Builder
avoiding the
need to create one manually via DescribeModelPackageRequest.builder()
describeModelPackageRequest
- A Consumer
that will call methods on DescribeModelPackageInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeNotebookInstanceResponse describeNotebookInstance(DescribeNotebookInstanceRequest describeNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns information about a notebook instance.
describeNotebookInstanceRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeNotebookInstanceRequest.builder()
describeNotebookInstanceRequest
- A Consumer
that will call methods on DescribeNotebookInstanceInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
describeNotebookInstanceLifecycleConfigRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
DescribeNotebookInstanceLifecycleConfigRequest.builder()
describeNotebookInstanceLifecycleConfigRequest
- A Consumer
that will call methods on DescribeNotebookInstanceLifecycleConfigInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS Marketplace.
describeSubscribedWorkteamRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS Marketplace.
This is a convenience which creates an instance of the DescribeSubscribedWorkteamRequest.Builder
avoiding
the need to create one manually via DescribeSubscribedWorkteamRequest.builder()
describeSubscribedWorkteamRequest
- A Consumer
that will call methods on DescribeSubscribedWorkteamRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrainingJobResponse describeTrainingJob(DescribeTrainingJobRequest describeTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about a training job.
describeTrainingJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrainingJobResponse describeTrainingJob(Consumer<DescribeTrainingJobRequest.Builder> describeTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about a training job.
This is a convenience which creates an instance of the DescribeTrainingJobRequest.Builder
avoiding the
need to create one manually via DescribeTrainingJobRequest.builder()
describeTrainingJobRequest
- A Consumer
that will call methods on DescribeTrainingJobRequest.Builder
to create a
request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTransformJobResponse describeTransformJob(DescribeTransformJobRequest describeTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Returns information about a transform job.
describeTransformJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DescribeTransformJobRequest.builder()
describeTransformJobRequest
- A Consumer
that will call methods on DescribeTransformJobRequest.Builder
to create a
request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeWorkteamResponse describeWorkteam(DescribeWorkteamRequest describeWorkteamRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
describeWorkteamRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
This is a convenience which creates an instance of the DescribeWorkteamRequest.Builder
avoiding the need
to create one manually via DescribeWorkteamRequest.builder()
describeWorkteamRequest
- A Consumer
that will call methods on DescribeWorkteamRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSearchSuggestionsResponse getSearchSuggestions(GetSearchSuggestionsRequest getSearchSuggestionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns suggestions for the property name to use in Search
queries. Provides suggestions for
HyperParameters
, Tags
, and Metrics
.
getSearchSuggestionsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSearchSuggestionsResponse getSearchSuggestions(Consumer<GetSearchSuggestionsRequest.Builder> getSearchSuggestionsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns suggestions for the property name to use in Search
queries. Provides suggestions for
HyperParameters
, Tags
, and Metrics
.
This is a convenience which creates an instance of the GetSearchSuggestionsRequest.Builder
avoiding the
need to create one manually via GetSearchSuggestionsRequest.builder()
getSearchSuggestionsRequest
- A Consumer
that will call methods on GetSearchSuggestionsRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAlgorithmsResponse listAlgorithms() throws AwsServiceException, SdkClientException, SageMakerException
Lists the machine learning algorithms that have been 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
listAlgorithms(ListAlgorithmsRequest)
,
AWS API
Documentationdefault ListAlgorithmsResponse listAlgorithms(ListAlgorithmsRequest listAlgorithmsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the machine learning algorithms that have been created.
listAlgorithmsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListAlgorithmsRequest.builder()
listAlgorithmsRequest
- A Consumer
that will call methods on ListAlgorithmsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCodeRepositoriesResponse listCodeRepositories() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the git repositories in your account.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCodeRepositories(ListCodeRepositoriesRequest)
,
AWS
API Documentationdefault ListCodeRepositoriesResponse listCodeRepositories(ListCodeRepositoriesRequest listCodeRepositoriesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the git repositories in your account.
listCodeRepositoriesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListCodeRepositoriesRequest.builder()
listCodeRepositoriesRequest
- A Consumer
that will call methods on ListCodeRepositoriesInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCompilationJobs(ListCompilationJobsRequest)
,
AWS
API Documentationdefault 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.
listCompilationJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListCompilationJobsRequest.builder()
listCompilationJobsRequest
- A Consumer
that will call methods on ListCompilationJobsRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCompilationJobsIterable listCompilationJobsPaginator() 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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCompilationJobsPaginator(ListCompilationJobsRequest)
,
AWS
API Documentationdefault ListCompilationJobsIterable listCompilationJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation.
listCompilationJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCompilationJobsIterable listCompilationJobsPaginator(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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListCompilationJobsIterable responses = client.listCompilationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listCompilationJobs(software.amazon.awssdk.services.sagemaker.model.ListCompilationJobsRequest)
operation.
This is a convenience which creates an instance of the ListCompilationJobsRequest.Builder
avoiding the
need to create one manually via ListCompilationJobsRequest.builder()
listCompilationJobsRequest
- A Consumer
that will call methods on ListCompilationJobsRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointConfigsResponse listEndpointConfigs() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEndpointConfigs(ListEndpointConfigsRequest)
,
AWS
API Documentationdefault ListEndpointConfigsResponse listEndpointConfigs(ListEndpointConfigsRequest listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
listEndpointConfigsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListEndpointConfigsRequest.builder()
listEndpointConfigsRequest
- A Consumer
that will call methods on ListEndpointConfigsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointConfigsIterable listEndpointConfigsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEndpointConfigsPaginator(ListEndpointConfigsRequest)
,
AWS
API Documentationdefault ListEndpointConfigsIterable listEndpointConfigsPaginator(ListEndpointConfigsRequest listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation.
listEndpointConfigsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointConfigsIterable listEndpointConfigsPaginator(Consumer<ListEndpointConfigsRequest.Builder> listEndpointConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoint configurations.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointConfigsIterable responses = client.listEndpointConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpointConfigs(software.amazon.awssdk.services.sagemaker.model.ListEndpointConfigsRequest)
operation.
This is a convenience which creates an instance of the ListEndpointConfigsRequest.Builder
avoiding the
need to create one manually via ListEndpointConfigsRequest.builder()
listEndpointConfigsRequest
- A Consumer
that will call methods on ListEndpointConfigsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointsResponse listEndpoints() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEndpoints(ListEndpointsRequest)
,
AWS API
Documentationdefault ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
listEndpointsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListEndpointsRequest.builder()
listEndpointsRequest
- A Consumer
that will call methods on ListEndpointsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointsIterable listEndpointsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listEndpointsPaginator(ListEndpointsRequest)
,
AWS API
Documentationdefault ListEndpointsIterable listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation.
listEndpointsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListEndpointsIterable listEndpointsPaginator(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists endpoints.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListEndpointsIterable responses = client.listEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listEndpoints(software.amazon.awssdk.services.sagemaker.model.ListEndpointsRequest)
operation.
This is a convenience which creates an instance of the ListEndpointsRequest.Builder
avoiding the need to
create one manually via ListEndpointsRequest.builder()
listEndpointsRequest
- A Consumer
that will call methods on ListEndpointsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHyperParameterTuningJobsResponse listHyperParameterTuningJobs() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest)
,
AWS API Documentationdefault ListHyperParameterTuningJobsResponse listHyperParameterTuningJobs(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
listHyperParameterTuningJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListHyperParameterTuningJobsRequest.builder()
listHyperParameterTuningJobsRequest
- A Consumer
that will call methods on ListHyperParameterTuningJobsRequest.Builder
to create
a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest)
,
AWS API Documentationdefault ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator(ListHyperParameterTuningJobsRequest listHyperParameterTuningJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation.
listHyperParameterTuningJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListHyperParameterTuningJobsIterable listHyperParameterTuningJobsPaginator(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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListHyperParameterTuningJobsIterable responses = client.listHyperParameterTuningJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listHyperParameterTuningJobs(software.amazon.awssdk.services.sagemaker.model.ListHyperParameterTuningJobsRequest)
operation.
This is a convenience which creates an instance of the ListHyperParameterTuningJobsRequest.Builder
avoiding the need to create one manually via ListHyperParameterTuningJobsRequest.builder()
listHyperParameterTuningJobsRequest
- A Consumer
that will call methods on ListHyperParameterTuningJobsRequest.Builder
to create
a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsResponse listLabelingJobs() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listLabelingJobs(ListLabelingJobsRequest)
,
AWS API
Documentationdefault ListLabelingJobsResponse listLabelingJobs(ListLabelingJobsRequest listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
listLabelingJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListLabelingJobsRequest.builder()
listLabelingJobsRequest
- A Consumer
that will call methods on ListLabelingJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsIterable listLabelingJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listLabelingJobsPaginator(ListLabelingJobsRequest)
,
AWS API
Documentationdefault ListLabelingJobsIterable listLabelingJobsPaginator(ListLabelingJobsRequest listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation.
listLabelingJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsIterable listLabelingJobsPaginator(Consumer<ListLabelingJobsRequest.Builder> listLabelingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsIterable responses = client.listLabelingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLabelingJobs(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsRequest)
operation.
This is a convenience which creates an instance of the ListLabelingJobsRequest.Builder
avoiding the need
to create one manually via ListLabelingJobsRequest.builder()
listLabelingJobsRequest
- A Consumer
that will call methods on ListLabelingJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsForWorkteamResponse listLabelingJobsForWorkteam(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs assigned to a specified work team.
listLabelingJobsForWorkteamRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListLabelingJobsForWorkteamRequest.builder()
listLabelingJobsForWorkteamRequest
- A Consumer
that will call methods on ListLabelingJobsForWorkteamRequest.Builder
to create
a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsForWorkteamIterable listLabelingJobsForWorkteamPaginator(ListLabelingJobsForWorkteamRequest listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs assigned to a specified work team.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest)
operation.
listLabelingJobsForWorkteamRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLabelingJobsForWorkteamIterable listLabelingJobsForWorkteamPaginator(Consumer<ListLabelingJobsForWorkteamRequest.Builder> listLabelingJobsForWorkteamRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Gets a list of labeling jobs assigned to a specified work team.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListLabelingJobsForWorkteamIterable responses = client.listLabelingJobsForWorkteamPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listLabelingJobsForWorkteam(software.amazon.awssdk.services.sagemaker.model.ListLabelingJobsForWorkteamRequest)
operation.
This is a convenience which creates an instance of the ListLabelingJobsForWorkteamRequest.Builder
avoiding the need to create one manually via ListLabelingJobsForWorkteamRequest.builder()
listLabelingJobsForWorkteamRequest
- A Consumer
that will call methods on ListLabelingJobsForWorkteamRequest.Builder
to create
a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListModelPackagesResponse listModelPackages() throws AwsServiceException, SdkClientException, SageMakerException
Lists the model packages that have been 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
listModelPackages(ListModelPackagesRequest)
,
AWS
API Documentationdefault ListModelPackagesResponse listModelPackages(ListModelPackagesRequest listModelPackagesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists the model packages that have been created.
listModelPackagesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListModelPackagesRequest.builder()
listModelPackagesRequest
- A Consumer
that will call methods on ListModelPackagesInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListModelsResponse listModels() throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the CreateModel API.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listModels(ListModelsRequest)
,
AWS API
Documentationdefault ListModelsResponse listModels(ListModelsRequest listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the CreateModel API.
listModelsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListModelsRequest.builder()
listModelsRequest
- A Consumer
that will call methods on ListModelsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListModelsIterable listModelsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the CreateModel API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listModelsPaginator(ListModelsRequest)
,
AWS API
Documentationdefault ListModelsIterable listModelsPaginator(ListModelsRequest listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the CreateModel API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation.
listModelsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListModelsIterable listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists models created with the CreateModel API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listModels(software.amazon.awssdk.services.sagemaker.model.ListModelsRequest)
operation.
This is a convenience which creates an instance of the ListModelsRequest.Builder
avoiding the need to
create one manually via ListModelsRequest.builder()
listModelsRequest
- A Consumer
that will call methods on ListModelsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstanceLifecycleConfigsResponse listNotebookInstanceLifecycleConfigs() throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest)
,
AWS API Documentationdefault ListNotebookInstanceLifecycleConfigsResponse listNotebookInstanceLifecycleConfigs(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
listNotebookInstanceLifecycleConfigsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
ListNotebookInstanceLifecycleConfigsRequest.builder()
listNotebookInstanceLifecycleConfigsRequest
- A Consumer
that will call methods on ListNotebookInstanceLifecycleConfigsInput.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest)
,
AWS API Documentationdefault ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator(ListNotebookInstanceLifecycleConfigsRequest listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation.
listNotebookInstanceLifecycleConfigsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstanceLifecycleConfigsIterable listNotebookInstanceLifecycleConfigsPaginator(Consumer<ListNotebookInstanceLifecycleConfigsRequest.Builder> listNotebookInstanceLifecycleConfigsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstanceLifecycleConfigsIterable responses = client.listNotebookInstanceLifecycleConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstanceLifecycleConfigs(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstanceLifecycleConfigsRequest)
operation.
This is a convenience which creates an instance of the
ListNotebookInstanceLifecycleConfigsRequest.Builder
avoiding the need to create one manually via
ListNotebookInstanceLifecycleConfigsRequest.builder()
listNotebookInstanceLifecycleConfigsRequest
- A Consumer
that will call methods on ListNotebookInstanceLifecycleConfigsInput.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstancesResponse listNotebookInstances() throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listNotebookInstances(ListNotebookInstancesRequest)
,
AWS API Documentationdefault ListNotebookInstancesResponse listNotebookInstances(ListNotebookInstancesRequest listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
listNotebookInstancesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstancesResponse listNotebookInstances(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
This is a convenience which creates an instance of the ListNotebookInstancesRequest.Builder
avoiding the
need to create one manually via ListNotebookInstancesRequest.builder()
listNotebookInstancesRequest
- A Consumer
that will call methods on ListNotebookInstancesInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstancesIterable listNotebookInstancesPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listNotebookInstancesPaginator(ListNotebookInstancesRequest)
,
AWS API Documentationdefault ListNotebookInstancesIterable listNotebookInstancesPaginator(ListNotebookInstancesRequest listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation.
listNotebookInstancesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListNotebookInstancesIterable listNotebookInstancesPaginator(Consumer<ListNotebookInstancesRequest.Builder> listNotebookInstancesRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListNotebookInstancesIterable responses = client.listNotebookInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNotebookInstances(software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest)
operation.
This is a convenience which creates an instance of the ListNotebookInstancesRequest.Builder
avoiding the
need to create one manually via ListNotebookInstancesRequest.builder()
listNotebookInstancesRequest
- A Consumer
that will call methods on ListNotebookInstancesInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscribedWorkteamsResponse listSubscribedWorkteams() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSubscribedWorkteams(ListSubscribedWorkteamsRequest)
,
AWS API Documentationdefault ListSubscribedWorkteamsResponse listSubscribedWorkteams(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
listSubscribedWorkteamsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
This is a convenience which creates an instance of the ListSubscribedWorkteamsRequest.Builder
avoiding
the need to create one manually via ListSubscribedWorkteamsRequest.builder()
listSubscribedWorkteamsRequest
- A Consumer
that will call methods on ListSubscribedWorkteamsRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest)
,
AWS API Documentationdefault ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator(ListSubscribedWorkteamsRequest listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation.
listSubscribedWorkteamsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSubscribedWorkteamsIterable listSubscribedWorkteamsPaginator(Consumer<ListSubscribedWorkteamsRequest.Builder> listSubscribedWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work
team satisfies the filter specified in the NameContains
parameter.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListSubscribedWorkteamsIterable responses = client.listSubscribedWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listSubscribedWorkteams(software.amazon.awssdk.services.sagemaker.model.ListSubscribedWorkteamsRequest)
operation.
This is a convenience which creates an instance of the ListSubscribedWorkteamsRequest.Builder
avoiding
the need to create one manually via ListSubscribedWorkteamsRequest.builder()
listSubscribedWorkteamsRequest
- A Consumer
that will call methods on ListSubscribedWorkteamsRequest.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the tags for the specified Amazon SageMaker resource.
listTagsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the tags for the specified Amazon SageMaker resource.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the tags for the specified Amazon SageMaker resource.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest)
operation.
listTagsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Returns the tags for the specified Amazon SageMaker resource.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.sagemaker.model.ListTagsRequest)
operation.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsInput.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsResponse listTrainingJobs() throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTrainingJobs(ListTrainingJobsRequest)
,
AWS API
Documentationdefault ListTrainingJobsResponse listTrainingJobs(ListTrainingJobsRequest listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
listTrainingJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsResponse listTrainingJobs(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
This is a convenience which creates an instance of the ListTrainingJobsRequest.Builder
avoiding the need
to create one manually via ListTrainingJobsRequest.builder()
listTrainingJobsRequest
- A Consumer
that will call methods on ListTrainingJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsIterable listTrainingJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTrainingJobsPaginator(ListTrainingJobsRequest)
,
AWS API
Documentationdefault ListTrainingJobsIterable listTrainingJobsPaginator(ListTrainingJobsRequest listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation.
listTrainingJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsIterable listTrainingJobsPaginator(Consumer<ListTrainingJobsRequest.Builder> listTrainingJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists training jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsIterable responses = client.listTrainingJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTrainingJobs(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsRequest)
operation.
This is a convenience which creates an instance of the ListTrainingJobsRequest.Builder
avoiding the need
to create one manually via ListTrainingJobsRequest.builder()
listTrainingJobsRequest
- A Consumer
that will call methods on ListTrainingJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listTrainingJobsForHyperParameterTuningJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via
ListTrainingJobsForHyperParameterTuningJobRequest.builder()
listTrainingJobsForHyperParameterTuningJobRequest
- A Consumer
that will call methods on
ListTrainingJobsForHyperParameterTuningJobRequest.Builder
to create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsForHyperParameterTuningJobIterable listTrainingJobsForHyperParameterTuningJobPaginator(ListTrainingJobsForHyperParameterTuningJobRequest 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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest)
operation.
listTrainingJobsForHyperParameterTuningJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTrainingJobsForHyperParameterTuningJobIterable listTrainingJobsForHyperParameterTuningJobPaginator(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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTrainingJobsForHyperParameterTuningJobIterable responses = client.listTrainingJobsForHyperParameterTuningJobPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTrainingJobsForHyperParameterTuningJob(software.amazon.awssdk.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest)
operation.
This is a convenience which creates an instance of the
ListTrainingJobsForHyperParameterTuningJobRequest.Builder
avoiding the need to create one manually via
ListTrainingJobsForHyperParameterTuningJobRequest.builder()
listTrainingJobsForHyperParameterTuningJobRequest
- A Consumer
that will call methods on
ListTrainingJobsForHyperParameterTuningJobRequest.Builder
to create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTransformJobsResponse listTransformJobs() throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTransformJobs(ListTransformJobsRequest)
,
AWS
API Documentationdefault ListTransformJobsResponse listTransformJobs(ListTransformJobsRequest listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
listTransformJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListTransformJobsRequest.builder()
listTransformJobsRequest
- A Consumer
that will call methods on ListTransformJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTransformJobsIterable listTransformJobsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTransformJobsPaginator(ListTransformJobsRequest)
,
AWS
API Documentationdefault ListTransformJobsIterable listTransformJobsPaginator(ListTransformJobsRequest listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation.
listTransformJobsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTransformJobsIterable listTransformJobsPaginator(Consumer<ListTransformJobsRequest.Builder> listTransformJobsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Lists transform jobs.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListTransformJobsIterable responses = client.listTransformJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTransformJobs(software.amazon.awssdk.services.sagemaker.model.ListTransformJobsRequest)
operation.
This is a convenience which creates an instance of the ListTransformJobsRequest.Builder
avoiding the need
to create one manually via ListTransformJobsRequest.builder()
listTransformJobsRequest
- A Consumer
that will call methods on ListTransformJobsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkteamsResponse listWorkteams() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of 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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listWorkteams(ListWorkteamsRequest)
,
AWS API
Documentationdefault ListWorkteamsResponse listWorkteams(ListWorkteamsRequest listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of 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.
listWorkteamsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkteamsResponse listWorkteams(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the
filter specified in the NameContains
parameter.
This is a convenience which creates an instance of the ListWorkteamsRequest.Builder
avoiding the need to
create one manually via ListWorkteamsRequest.builder()
listWorkteamsRequest
- A Consumer
that will call methods on ListWorkteamsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkteamsIterable listWorkteamsPaginator() throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of 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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listWorkteamsPaginator(ListWorkteamsRequest)
,
AWS API
Documentationdefault ListWorkteamsIterable listWorkteamsPaginator(ListWorkteamsRequest listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of 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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation.
listWorkteamsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkteamsIterable listWorkteamsPaginator(Consumer<ListWorkteamsRequest.Builder> listWorkteamsRequest) throws AwsServiceException, SdkClientException, SageMakerException
Gets a list of 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 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 Stream
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.ListWorkteamsIterable responses = client.listWorkteamsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkteams(software.amazon.awssdk.services.sagemaker.model.ListWorkteamsRequest)
operation.
This is a convenience which creates an instance of the ListWorkteamsRequest.Builder
avoiding the need to
create one manually via ListWorkteamsRequest.builder()
listWorkteamsRequest
- A Consumer
that will call methods on ListWorkteamsRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RenderUiTemplateResponse renderUiTemplate(RenderUiTemplateRequest renderUiTemplateRequest) throws AwsServiceException, SdkClientException, SageMakerException
Renders the UI template so that you can preview the worker's experience.
renderUiTemplateRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RenderUiTemplateResponse renderUiTemplate(Consumer<RenderUiTemplateRequest.Builder> renderUiTemplateRequest) throws 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 via RenderUiTemplateRequest.builder()
renderUiTemplateRequest
- A Consumer
that will call methods on RenderUiTemplateRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResponse search(SearchRequest searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of
SearchResult
objects in the response. The search results can be sorted by any resrouce property in a
ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
searchRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchResponse search(Consumer<SearchRequest.Builder> searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of
SearchResult
objects in the response. The search results can be sorted by any resrouce property in a
ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
This is a convenience which creates an instance of the SearchRequest.Builder
avoiding the need to create
one manually via SearchRequest.builder()
searchRequest
- A Consumer
that will call methods on SearchRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchIterable searchPaginator(SearchRequest searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of
SearchResult
objects in the response. The search results can be sorted by any resrouce property in a
ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
search(software.amazon.awssdk.services.sagemaker.model.SearchRequest)
operation.
searchRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SearchIterable searchPaginator(Consumer<SearchRequest.Builder> searchRequest) throws AwsServiceException, SdkClientException, SageMakerException
Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of
SearchResult
objects in the response. The search results can be sorted by any resrouce property in a
ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
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 Stream
software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sagemaker.paginators.SearchIterable responses = client.searchPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
search(software.amazon.awssdk.services.sagemaker.model.SearchRequest)
operation.
This is a convenience which creates an instance of the SearchRequest.Builder
avoiding the need to create
one manually via SearchRequest.builder()
searchRequest
- A Consumer
that will call methods on SearchRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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, Amazon SageMaker sets the notebook instance status to
InService
. A notebook instance's status must be InService
before you can connect to
your Jupyter notebook.
startNotebookInstanceRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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, Amazon SageMaker sets the notebook instance status to
InService
. A notebook instance's status must be InService
before you can connect to
your Jupyter notebook.
This is a convenience which creates an instance of the StartNotebookInstanceRequest.Builder
avoiding the
need to create one manually via StartNotebookInstanceRequest.builder()
startNotebookInstanceRequest
- A Consumer
that will call methods on StartNotebookInstanceInput.Builder
to create a
request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default StopCompilationJobResponse stopCompilationJob(StopCompilationJobRequest stopCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn’t stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob
request, Amazon SageMaker changes the
CompilationJobSummary$CompilationJobStatus of the job to Stopping
. After Amazon SageMaker
stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped
.
stopCompilationJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopCompilationJobResponse stopCompilationJob(Consumer<StopCompilationJobRequest.Builder> stopCompilationJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn’t stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob
request, Amazon SageMaker changes the
CompilationJobSummary$CompilationJobStatus of the job to Stopping
. After Amazon SageMaker
stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped
.
This is a convenience which creates an instance of the StopCompilationJobRequest.Builder
avoiding the
need to create one manually via StopCompilationJobRequest.builder()
stopCompilationJobRequest
- A Consumer
that will call methods on StopCompilationJobRequest.Builder
to create a
request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
stopHyperParameterTuningJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via StopHyperParameterTuningJobRequest.builder()
stopHyperParameterTuningJobRequest
- A Consumer
that will call methods on StopHyperParameterTuningJobRequest.Builder
to create
a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
stopLabelingJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via StopLabelingJobRequest.builder()
stopLabelingJobRequest
- A Consumer
that will call methods on StopLabelingJobRequest.Builder
to create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopNotebookInstanceResponse stopNotebookInstance(StopNotebookInstanceRequest stopNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume.
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.
stopNotebookInstanceRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopNotebookInstanceResponse stopNotebookInstance(Consumer<StopNotebookInstanceRequest.Builder> stopNotebookInstanceRequest) throws AwsServiceException, SdkClientException, SageMakerException
Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume.
To access data on the ML storage volume for a notebook instance that has been terminated, call the
StartNotebookInstance
API. StartNotebookInstance
launches another ML compute instance,
configures it, and attaches the preserved ML storage volume so you can continue your work.
This is a convenience which creates an instance of the StopNotebookInstanceRequest.Builder
avoiding the
need to create one manually via StopNotebookInstanceRequest.builder()
stopNotebookInstanceRequest
- A Consumer
that will call methods on StopNotebookInstanceInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTrainingJobResponse stopTrainingJob(StopTrainingJobRequest stopTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a training job. To stop a job, Amazon 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.
Training algorithms provided by Amazon SageMaker save the intermediate results of a model training job. This intermediate data is a valid model artifact. You can use the model artifacts that are saved when Amazon SageMaker stops a training job to create a model.
When it receives a StopTrainingJob
request, Amazon SageMaker changes the status of the job to
Stopping
. After Amazon SageMaker stops the job, it sets the status to Stopped
.
stopTrainingJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTrainingJobResponse stopTrainingJob(Consumer<StopTrainingJobRequest.Builder> stopTrainingJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a training job. To stop a job, Amazon 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.
Training algorithms provided by Amazon SageMaker save the intermediate results of a model training job. This intermediate data is a valid model artifact. You can use the model artifacts that are saved when Amazon SageMaker stops a training job to create a model.
When it receives a StopTrainingJob
request, Amazon SageMaker changes the status of the job to
Stopping
. After Amazon SageMaker stops the job, it sets the status to Stopped
.
This is a convenience which creates an instance of the StopTrainingJobRequest.Builder
avoiding the need
to create one manually via StopTrainingJobRequest.builder()
stopTrainingJobRequest
- A Consumer
that will call methods on StopTrainingJobRequest.Builder
to create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTransformJobResponse stopTransformJob(StopTransformJobRequest stopTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a transform job.
When Amazon SageMaker receives a StopTransformJob
request, the status of the job changes to
Stopping
. After Amazon SageMaker stops the job, the status is set to Stopped
. When you
stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
stopTransformJobRequest
- ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTransformJobResponse stopTransformJob(Consumer<StopTransformJobRequest.Builder> stopTransformJobRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, SageMakerException
Stops a transform job.
When Amazon SageMaker receives a StopTransformJob
request, the status of the job changes to
Stopping
. After Amazon SageMaker stops the job, the status is set to Stopped
. When you
stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
This is a convenience which creates an instance of the StopTransformJobRequest.Builder
avoiding the need
to create one manually via StopTransformJobRequest.builder()
stopTransformJobRequest
- A Consumer
that will call methods on StopTransformJobRequest.Builder
to create a request.ResourceNotFoundException
- Resource being access is not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateCodeRepositoryResponse updateCodeRepository(UpdateCodeRepositoryRequest updateCodeRepositoryRequest) throws AwsServiceException, SdkClientException, SageMakerException
Updates the specified git repository with the specified values.
updateCodeRepositoryRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateCodeRepositoryResponse updateCodeRepository(Consumer<UpdateCodeRepositoryRequest.Builder> updateCodeRepositoryRequest) throws 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 via UpdateCodeRepositoryRequest.builder()
updateCodeRepositoryRequest
- A Consumer
that will call methods on UpdateCodeRepositoryInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SageMakerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Deploys the new EndpointConfig
specified in the request, switches to using newly created endpoint,
and then deletes resources provisioned for the endpoint using the previous EndpointConfig
(there is
no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating
. After updating
the endpoint, it sets the status to InService
. To check the status of an endpoint, use the DescribeEndpoint API.
You cannot update an endpoint with the current EndpointConfig
. To update an endpoint, you must
create a new EndpointConfig
.
updateEndpointRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
default UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Deploys the new EndpointConfig
specified in the request, switches to using newly created endpoint,
and then deletes resources provisioned for the endpoint using the previous EndpointConfig
(there is
no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating
. After updating
the endpoint, it sets the status to InService
. To check the status of an endpoint, use the DescribeEndpoint API.
You cannot update an endpoint with the current EndpointConfig
. To update an endpoint, you must
create a new EndpointConfig
.
This is a convenience which creates an instance of the UpdateEndpointRequest.Builder
avoiding the need to
create one manually via UpdateEndpointRequest.builder()
updateEndpointRequest
- A Consumer
that will call methods on UpdateEndpointInput.Builder
to create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
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, Amazon SageMaker sets the endpoint status to
Updating
. After updating the endpoint, it sets the status to InService
. To check the
status of an endpoint, use the DescribeEndpoint API.
updateEndpointWeightsAndCapacitiesRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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, Amazon SageMaker sets the endpoint status to
Updating
. After updating the endpoint, it sets the status to InService
. To check the
status of an endpoint, use the DescribeEndpoint API.
This is a convenience which creates an instance of the UpdateEndpointWeightsAndCapacitiesRequest.Builder
avoiding the need to create one manually via UpdateEndpointWeightsAndCapacitiesRequest.builder()
updateEndpointWeightsAndCapacitiesRequest
- A Consumer
that will call methods on UpdateEndpointWeightsAndCapacitiesInput.Builder
to
create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
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. You can also update the VPC security groups.
updateNotebookInstanceRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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. You can also update the VPC security groups.
This is a convenience which creates an instance of the UpdateNotebookInstanceRequest.Builder
avoiding the
need to create one manually via UpdateNotebookInstanceRequest.builder()
updateNotebookInstanceRequest
- A Consumer
that will call methods on UpdateNotebookInstanceInput.Builder
to create a
request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default UpdateNotebookInstanceLifecycleConfigResponse updateNotebookInstanceLifecycleConfig(UpdateNotebookInstanceLifecycleConfigRequest updateNotebookInstanceLifecycleConfigRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
updateNotebookInstanceLifecycleConfigRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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 via
UpdateNotebookInstanceLifecycleConfigRequest.builder()
updateNotebookInstanceLifecycleConfigRequest
- A Consumer
that will call methods on UpdateNotebookInstanceLifecycleConfigInput.Builder
to
create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
default UpdateWorkteamResponse updateWorkteam(UpdateWorkteamRequest updateWorkteamRequest) throws ResourceLimitExceededException, AwsServiceException, SdkClientException, SageMakerException
Updates an existing work team with new member definitions or description.
updateWorkteamRequest
- ResourceLimitExceededException
- You have exceeded an Amazon 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
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 via UpdateWorkteamRequest.builder()
updateWorkteamRequest
- A Consumer
that will call methods on UpdateWorkteamRequest.Builder
to create a request.ResourceLimitExceededException
- You have exceeded an Amazon 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
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.