UNPKG

334 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class SageMaker extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: SageMaker.Types.ClientConfiguration)
14 config: Config & SageMaker.Types.ClientConfiguration;
15 /**
16 * 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, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see 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
17 */
18 addTags(params: SageMaker.Types.AddTagsInput, callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request<SageMaker.Types.AddTagsOutput, AWSError>;
19 /**
20 * 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, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see 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
21 */
22 addTags(callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request<SageMaker.Types.AddTagsOutput, AWSError>;
23 /**
24 * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
25 */
26 createAlgorithm(params: SageMaker.Types.CreateAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
27 /**
28 * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
29 */
30 createAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
31 /**
32 * Creates 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.
33 */
34 createCodeRepository(params: SageMaker.Types.CreateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
35 /**
36 * Creates 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.
37 */
38 createCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
39 /**
40 * 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.
41 */
42 createCompilationJob(params: SageMaker.Types.CreateCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request<SageMaker.Types.CreateCompilationJobResponse, AWSError>;
43 /**
44 * 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.
45 */
46 createCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request<SageMaker.Types.CreateCompilationJobResponse, AWSError>;
47 /**
48 * 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. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. 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.
49 */
50 createEndpoint(params: SageMaker.Types.CreateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
51 /**
52 * 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. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. 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.
53 */
54 createEndpoint(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
55 /**
56 * 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 ProductionVariants, 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.
57 */
58 createEndpointConfig(params: SageMaker.Types.CreateEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
59 /**
60 * 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 ProductionVariants, 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.
61 */
62 createEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
63 /**
64 * 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.
65 */
66 createHyperParameterTuningJob(params: SageMaker.Types.CreateHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.CreateHyperParameterTuningJobResponse, AWSError>;
67 /**
68 * 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.
69 */
70 createHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.CreateHyperParameterTuningJobResponse, AWSError>;
71 /**
72 * Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers: A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling. The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data. The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
73 */
74 createLabelingJob(params: SageMaker.Types.CreateLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request<SageMaker.Types.CreateLabelingJobResponse, AWSError>;
75 /**
76 * Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers: A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas. The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling. The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data. The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
77 */
78 createLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request<SageMaker.Types.CreateLabelingJobResponse, AWSError>;
79 /**
80 * 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.
81 */
82 createModel(params: SageMaker.Types.CreateModelInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
83 /**
84 * 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.
85 */
86 createModel(callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
87 /**
88 * 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. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.
89 */
90 createModelPackage(params: SageMaker.Types.CreateModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
91 /**
92 * 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. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.
93 */
94 createModelPackage(callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
95 /**
96 * 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). You can't change the name of a notebook instance after you create it. 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.
97 */
98 createNotebookInstance(params: SageMaker.Types.CreateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
99 /**
100 * 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). You can't change the name of a notebook instance after you create it. 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.
101 */
102 createNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
103 /**
104 * 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.
105 */
106 createNotebookInstanceLifecycleConfig(params: SageMaker.Types.CreateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput, AWSError>;
107 /**
108 * 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.
109 */
110 createNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput, AWSError>;
111 /**
112 * 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. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
113 */
114 createPresignedNotebookInstanceUrl(params: SageMaker.Types.CreatePresignedNotebookInstanceUrlInput, callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
115 /**
116 * 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. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
117 */
118 createPresignedNotebookInstanceUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
119 /**
120 * 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 machine 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 enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket 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. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleARN - The Amazon Resource 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 - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to to wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
121 */
122 createTrainingJob(params: SageMaker.Types.CreateTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
123 /**
124 * 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 machine 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 enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket 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. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleARN - The Amazon Resource 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 - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to to wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
125 */
126 createTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
127 /**
128 * 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.
129 */
130 createTransformJob(params: SageMaker.Types.CreateTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request<SageMaker.Types.CreateTransformJobResponse, AWSError>;
131 /**
132 * 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.
133 */
134 createTransformJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request<SageMaker.Types.CreateTransformJobResponse, AWSError>;
135 /**
136 * 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.
137 */
138 createWorkteam(params: SageMaker.Types.CreateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request<SageMaker.Types.CreateWorkteamResponse, AWSError>;
139 /**
140 * 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.
141 */
142 createWorkteam(callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request<SageMaker.Types.CreateWorkteamResponse, AWSError>;
143 /**
144 * Removes the specified algorithm from your account.
145 */
146 deleteAlgorithm(params: SageMaker.Types.DeleteAlgorithmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
147 /**
148 * Removes the specified algorithm from your account.
149 */
150 deleteAlgorithm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
151 /**
152 * Deletes the specified Git repository from your account.
153 */
154 deleteCodeRepository(params: SageMaker.Types.DeleteCodeRepositoryInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
155 /**
156 * Deletes the specified Git repository from your account.
157 */
158 deleteCodeRepository(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
159 /**
160 * 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.
161 */
162 deleteEndpoint(params: SageMaker.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
163 /**
164 * 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.
165 */
166 deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
167 /**
168 * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
169 */
170 deleteEndpointConfig(params: SageMaker.Types.DeleteEndpointConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
171 /**
172 * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
173 */
174 deleteEndpointConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
175 /**
176 * 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.
177 */
178 deleteModel(params: SageMaker.Types.DeleteModelInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
179 /**
180 * 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.
181 */
182 deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
183 /**
184 * 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.
185 */
186 deleteModelPackage(params: SageMaker.Types.DeleteModelPackageInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
187 /**
188 * 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.
189 */
190 deleteModelPackage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
191 /**
192 * 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.
193 */
194 deleteNotebookInstance(params: SageMaker.Types.DeleteNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
195 /**
196 * 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.
197 */
198 deleteNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
199 /**
200 * Deletes a notebook instance lifecycle configuration.
201 */
202 deleteNotebookInstanceLifecycleConfig(params: SageMaker.Types.DeleteNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
203 /**
204 * Deletes a notebook instance lifecycle configuration.
205 */
206 deleteNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
207 /**
208 * 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.
209 */
210 deleteTags(params: SageMaker.Types.DeleteTagsInput, callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
211 /**
212 * 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.
213 */
214 deleteTags(callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
215 /**
216 * Deletes an existing work team. This operation can't be undone.
217 */
218 deleteWorkteam(params: SageMaker.Types.DeleteWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request<SageMaker.Types.DeleteWorkteamResponse, AWSError>;
219 /**
220 * Deletes an existing work team. This operation can't be undone.
221 */
222 deleteWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request<SageMaker.Types.DeleteWorkteamResponse, AWSError>;
223 /**
224 * Returns a description of the specified algorithm that is in your account.
225 */
226 describeAlgorithm(params: SageMaker.Types.DescribeAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request<SageMaker.Types.DescribeAlgorithmOutput, AWSError>;
227 /**
228 * Returns a description of the specified algorithm that is in your account.
229 */
230 describeAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request<SageMaker.Types.DescribeAlgorithmOutput, AWSError>;
231 /**
232 * Gets details about the specified Git repository.
233 */
234 describeCodeRepository(params: SageMaker.Types.DescribeCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request<SageMaker.Types.DescribeCodeRepositoryOutput, AWSError>;
235 /**
236 * Gets details about the specified Git repository.
237 */
238 describeCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request<SageMaker.Types.DescribeCodeRepositoryOutput, AWSError>;
239 /**
240 * 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.
241 */
242 describeCompilationJob(params: SageMaker.Types.DescribeCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request<SageMaker.Types.DescribeCompilationJobResponse, AWSError>;
243 /**
244 * 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.
245 */
246 describeCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request<SageMaker.Types.DescribeCompilationJobResponse, AWSError>;
247 /**
248 * Returns the description of an endpoint.
249 */
250 describeEndpoint(params: SageMaker.Types.DescribeEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
251 /**
252 * Returns the description of an endpoint.
253 */
254 describeEndpoint(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
255 /**
256 * Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
257 */
258 describeEndpointConfig(params: SageMaker.Types.DescribeEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request<SageMaker.Types.DescribeEndpointConfigOutput, AWSError>;
259 /**
260 * Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
261 */
262 describeEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request<SageMaker.Types.DescribeEndpointConfigOutput, AWSError>;
263 /**
264 * Gets a description of a hyperparameter tuning job.
265 */
266 describeHyperParameterTuningJob(params: SageMaker.Types.DescribeHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.DescribeHyperParameterTuningJobResponse, AWSError>;
267 /**
268 * Gets a description of a hyperparameter tuning job.
269 */
270 describeHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.DescribeHyperParameterTuningJobResponse, AWSError>;
271 /**
272 * Gets information about a labeling job.
273 */
274 describeLabelingJob(params: SageMaker.Types.DescribeLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request<SageMaker.Types.DescribeLabelingJobResponse, AWSError>;
275 /**
276 * Gets information about a labeling job.
277 */
278 describeLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request<SageMaker.Types.DescribeLabelingJobResponse, AWSError>;
279 /**
280 * Describes a model that you created using the CreateModel API.
281 */
282 describeModel(params: SageMaker.Types.DescribeModelInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request<SageMaker.Types.DescribeModelOutput, AWSError>;
283 /**
284 * Describes a model that you created using the CreateModel API.
285 */
286 describeModel(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request<SageMaker.Types.DescribeModelOutput, AWSError>;
287 /**
288 * Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace. To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
289 */
290 describeModelPackage(params: SageMaker.Types.DescribeModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request<SageMaker.Types.DescribeModelPackageOutput, AWSError>;
291 /**
292 * Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace. To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
293 */
294 describeModelPackage(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request<SageMaker.Types.DescribeModelPackageOutput, AWSError>;
295 /**
296 * Returns information about a notebook instance.
297 */
298 describeNotebookInstance(params: SageMaker.Types.DescribeNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
299 /**
300 * Returns information about a notebook instance.
301 */
302 describeNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
303 /**
304 * 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.
305 */
306 describeNotebookInstanceLifecycleConfig(params: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput, AWSError>;
307 /**
308 * 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.
309 */
310 describeNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput, AWSError>;
311 /**
312 * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
313 */
314 describeSubscribedWorkteam(params: SageMaker.Types.DescribeSubscribedWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request<SageMaker.Types.DescribeSubscribedWorkteamResponse, AWSError>;
315 /**
316 * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
317 */
318 describeSubscribedWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request<SageMaker.Types.DescribeSubscribedWorkteamResponse, AWSError>;
319 /**
320 * Returns information about a training job.
321 */
322 describeTrainingJob(params: SageMaker.Types.DescribeTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
323 /**
324 * Returns information about a training job.
325 */
326 describeTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
327 /**
328 * Returns information about a transform job.
329 */
330 describeTransformJob(params: SageMaker.Types.DescribeTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
331 /**
332 * Returns information about a transform job.
333 */
334 describeTransformJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
335 /**
336 * 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).
337 */
338 describeWorkteam(params: SageMaker.Types.DescribeWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request<SageMaker.Types.DescribeWorkteamResponse, AWSError>;
339 /**
340 * 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).
341 */
342 describeWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request<SageMaker.Types.DescribeWorkteamResponse, AWSError>;
343 /**
344 * An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
345 */
346 getSearchSuggestions(params: SageMaker.Types.GetSearchSuggestionsRequest, callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request<SageMaker.Types.GetSearchSuggestionsResponse, AWSError>;
347 /**
348 * An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
349 */
350 getSearchSuggestions(callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request<SageMaker.Types.GetSearchSuggestionsResponse, AWSError>;
351 /**
352 * Lists the machine learning algorithms that have been created.
353 */
354 listAlgorithms(params: SageMaker.Types.ListAlgorithmsInput, callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request<SageMaker.Types.ListAlgorithmsOutput, AWSError>;
355 /**
356 * Lists the machine learning algorithms that have been created.
357 */
358 listAlgorithms(callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request<SageMaker.Types.ListAlgorithmsOutput, AWSError>;
359 /**
360 * Gets a list of the Git repositories in your account.
361 */
362 listCodeRepositories(params: SageMaker.Types.ListCodeRepositoriesInput, callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request<SageMaker.Types.ListCodeRepositoriesOutput, AWSError>;
363 /**
364 * Gets a list of the Git repositories in your account.
365 */
366 listCodeRepositories(callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request<SageMaker.Types.ListCodeRepositoriesOutput, AWSError>;
367 /**
368 * 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.
369 */
370 listCompilationJobs(params: SageMaker.Types.ListCompilationJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request<SageMaker.Types.ListCompilationJobsResponse, AWSError>;
371 /**
372 * 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.
373 */
374 listCompilationJobs(callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request<SageMaker.Types.ListCompilationJobsResponse, AWSError>;
375 /**
376 * Lists endpoint configurations.
377 */
378 listEndpointConfigs(params: SageMaker.Types.ListEndpointConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request<SageMaker.Types.ListEndpointConfigsOutput, AWSError>;
379 /**
380 * Lists endpoint configurations.
381 */
382 listEndpointConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request<SageMaker.Types.ListEndpointConfigsOutput, AWSError>;
383 /**
384 * Lists endpoints.
385 */
386 listEndpoints(params: SageMaker.Types.ListEndpointsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request<SageMaker.Types.ListEndpointsOutput, AWSError>;
387 /**
388 * Lists endpoints.
389 */
390 listEndpoints(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request<SageMaker.Types.ListEndpointsOutput, AWSError>;
391 /**
392 * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
393 */
394 listHyperParameterTuningJobs(params: SageMaker.Types.ListHyperParameterTuningJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request<SageMaker.Types.ListHyperParameterTuningJobsResponse, AWSError>;
395 /**
396 * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
397 */
398 listHyperParameterTuningJobs(callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request<SageMaker.Types.ListHyperParameterTuningJobsResponse, AWSError>;
399 /**
400 * Gets a list of labeling jobs.
401 */
402 listLabelingJobs(params: SageMaker.Types.ListLabelingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request<SageMaker.Types.ListLabelingJobsResponse, AWSError>;
403 /**
404 * Gets a list of labeling jobs.
405 */
406 listLabelingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request<SageMaker.Types.ListLabelingJobsResponse, AWSError>;
407 /**
408 * Gets a list of labeling jobs assigned to a specified work team.
409 */
410 listLabelingJobsForWorkteam(params: SageMaker.Types.ListLabelingJobsForWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request<SageMaker.Types.ListLabelingJobsForWorkteamResponse, AWSError>;
411 /**
412 * Gets a list of labeling jobs assigned to a specified work team.
413 */
414 listLabelingJobsForWorkteam(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request<SageMaker.Types.ListLabelingJobsForWorkteamResponse, AWSError>;
415 /**
416 * Lists the model packages that have been created.
417 */
418 listModelPackages(params: SageMaker.Types.ListModelPackagesInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request<SageMaker.Types.ListModelPackagesOutput, AWSError>;
419 /**
420 * Lists the model packages that have been created.
421 */
422 listModelPackages(callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request<SageMaker.Types.ListModelPackagesOutput, AWSError>;
423 /**
424 * Lists models created with the CreateModel API.
425 */
426 listModels(params: SageMaker.Types.ListModelsInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request<SageMaker.Types.ListModelsOutput, AWSError>;
427 /**
428 * Lists models created with the CreateModel API.
429 */
430 listModels(callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request<SageMaker.Types.ListModelsOutput, AWSError>;
431 /**
432 * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
433 */
434 listNotebookInstanceLifecycleConfigs(params: SageMaker.Types.ListNotebookInstanceLifecycleConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request<SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput, AWSError>;
435 /**
436 * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
437 */
438 listNotebookInstanceLifecycleConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request<SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput, AWSError>;
439 /**
440 * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
441 */
442 listNotebookInstances(params: SageMaker.Types.ListNotebookInstancesInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
443 /**
444 * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
445 */
446 listNotebookInstances(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
447 /**
448 * 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.
449 */
450 listSubscribedWorkteams(params: SageMaker.Types.ListSubscribedWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request<SageMaker.Types.ListSubscribedWorkteamsResponse, AWSError>;
451 /**
452 * 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.
453 */
454 listSubscribedWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request<SageMaker.Types.ListSubscribedWorkteamsResponse, AWSError>;
455 /**
456 * Returns the tags for the specified Amazon SageMaker resource.
457 */
458 listTags(params: SageMaker.Types.ListTagsInput, callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
459 /**
460 * Returns the tags for the specified Amazon SageMaker resource.
461 */
462 listTags(callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
463 /**
464 * Lists training jobs.
465 */
466 listTrainingJobs(params: SageMaker.Types.ListTrainingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request<SageMaker.Types.ListTrainingJobsResponse, AWSError>;
467 /**
468 * Lists training jobs.
469 */
470 listTrainingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request<SageMaker.Types.ListTrainingJobsResponse, AWSError>;
471 /**
472 * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
473 */
474 listTrainingJobsForHyperParameterTuningJob(params: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse, AWSError>;
475 /**
476 * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
477 */
478 listTrainingJobsForHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse, AWSError>;
479 /**
480 * Lists transform jobs.
481 */
482 listTransformJobs(params: SageMaker.Types.ListTransformJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request<SageMaker.Types.ListTransformJobsResponse, AWSError>;
483 /**
484 * Lists transform jobs.
485 */
486 listTransformJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request<SageMaker.Types.ListTransformJobsResponse, AWSError>;
487 /**
488 * 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.
489 */
490 listWorkteams(params: SageMaker.Types.ListWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request<SageMaker.Types.ListWorkteamsResponse, AWSError>;
491 /**
492 * 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.
493 */
494 listWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request<SageMaker.Types.ListWorkteamsResponse, AWSError>;
495 /**
496 * Renders the UI template so that you can preview the worker's experience.
497 */
498 renderUiTemplate(params: SageMaker.Types.RenderUiTemplateRequest, callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request<SageMaker.Types.RenderUiTemplateResponse, AWSError>;
499 /**
500 * Renders the UI template so that you can preview the worker's experience.
501 */
502 renderUiTemplate(callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request<SageMaker.Types.RenderUiTemplateResponse, AWSError>;
503 /**
504 * Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numerical, text, Booleans, and timestamps.
505 */
506 search(params: SageMaker.Types.SearchRequest, callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request<SageMaker.Types.SearchResponse, AWSError>;
507 /**
508 * Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numerical, text, Booleans, and timestamps.
509 */
510 search(callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request<SageMaker.Types.SearchResponse, AWSError>;
511 /**
512 * 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.
513 */
514 startNotebookInstance(params: SageMaker.Types.StartNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
515 /**
516 * 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.
517 */
518 startNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
519 /**
520 * 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.
521 */
522 stopCompilationJob(params: SageMaker.Types.StopCompilationJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
523 /**
524 * 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.
525 */
526 stopCompilationJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
527 /**
528 * 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.
529 */
530 stopHyperParameterTuningJob(params: SageMaker.Types.StopHyperParameterTuningJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
531 /**
532 * 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.
533 */
534 stopHyperParameterTuningJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
535 /**
536 * 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.
537 */
538 stopLabelingJob(params: SageMaker.Types.StopLabelingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
539 /**
540 * 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.
541 */
542 stopLabelingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
543 /**
544 * 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. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
545 */
546 stopNotebookInstance(params: SageMaker.Types.StopNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
547 /**
548 * 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. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
549 */
550 stopNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
551 /**
552 * 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. 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.
553 */
554 stopTrainingJob(params: SageMaker.Types.StopTrainingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
555 /**
556 * 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. 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.
557 */
558 stopTrainingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
559 /**
560 * 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.
561 */
562 stopTransformJob(params: SageMaker.Types.StopTransformJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
563 /**
564 * 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.
565 */
566 stopTransformJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
567 /**
568 * Updates the specified Git repository with the specified values.
569 */
570 updateCodeRepository(params: SageMaker.Types.UpdateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request<SageMaker.Types.UpdateCodeRepositoryOutput, AWSError>;
571 /**
572 * Updates the specified Git repository with the specified values.
573 */
574 updateCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request<SageMaker.Types.UpdateCodeRepositoryOutput, AWSError>;
575 /**
576 * 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 must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
577 */
578 updateEndpoint(params: SageMaker.Types.UpdateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
579 /**
580 * 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 must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
581 */
582 updateEndpoint(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
583 /**
584 * 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.
585 */
586 updateEndpointWeightsAndCapacities(params: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
587 /**
588 * 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.
589 */
590 updateEndpointWeightsAndCapacities(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
591 /**
592 * 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.
593 */
594 updateNotebookInstance(params: SageMaker.Types.UpdateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceOutput, AWSError>;
595 /**
596 * 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.
597 */
598 updateNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceOutput, AWSError>;
599 /**
600 * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
601 */
602 updateNotebookInstanceLifecycleConfig(params: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput, AWSError>;
603 /**
604 * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
605 */
606 updateNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput, AWSError>;
607 /**
608 * Updates an existing work team with new member definitions or description.
609 */
610 updateWorkteam(params: SageMaker.Types.UpdateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request<SageMaker.Types.UpdateWorkteamResponse, AWSError>;
611 /**
612 * Updates an existing work team with new member definitions or description.
613 */
614 updateWorkteam(callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request<SageMaker.Types.UpdateWorkteamResponse, AWSError>;
615 /**
616 * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
617 */
618 waitFor(state: "notebookInstanceInService", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
619 /**
620 * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
621 */
622 waitFor(state: "notebookInstanceInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
623 /**
624 * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
625 */
626 waitFor(state: "notebookInstanceStopped", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
627 /**
628 * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
629 */
630 waitFor(state: "notebookInstanceStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
631 /**
632 * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
633 */
634 waitFor(state: "notebookInstanceDeleted", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
635 /**
636 * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
637 */
638 waitFor(state: "notebookInstanceDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
639 /**
640 * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times).
641 */
642 waitFor(state: "trainingJobCompletedOrStopped", params: SageMaker.Types.DescribeTrainingJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
643 /**
644 * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times).
645 */
646 waitFor(state: "trainingJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
647 /**
648 * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times).
649 */
650 waitFor(state: "endpointInService", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
651 /**
652 * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times).
653 */
654 waitFor(state: "endpointInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
655 /**
656 * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times).
657 */
658 waitFor(state: "endpointDeleted", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
659 /**
660 * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times).
661 */
662 waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
663 /**
664 * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times).
665 */
666 waitFor(state: "transformJobCompletedOrStopped", params: SageMaker.Types.DescribeTransformJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
667 /**
668 * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times).
669 */
670 waitFor(state: "transformJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
671}
672declare namespace SageMaker {
673 export type Accept = string;
674 export type AccountId = string;
675 export interface AddTagsInput {
676 /**
677 * The Amazon Resource Name (ARN) of the resource that you want to tag.
678 */
679 ResourceArn: ResourceArn;
680 /**
681 * An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string.
682 */
683 Tags: TagList;
684 }
685 export interface AddTagsOutput {
686 /**
687 * A list of tags associated with the Amazon SageMaker resource.
688 */
689 Tags?: TagList;
690 }
691 export type AdditionalCodeRepositoryNamesOrUrls = CodeRepositoryNameOrUrl[];
692 export type AlgorithmArn = string;
693 export type AlgorithmImage = string;
694 export type AlgorithmSortBy = "Name"|"CreationTime"|string;
695 export interface AlgorithmSpecification {
696 /**
697 * The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
698 */
699 TrainingImage?: AlgorithmImage;
700 /**
701 * The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.
702 */
703 AlgorithmName?: ArnOrName;
704 /**
705 * The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container. In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any. For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.
706 */
707 TrainingInputMode: TrainingInputMode;
708 /**
709 * A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.
710 */
711 MetricDefinitions?: MetricDefinitionList;
712 }
713 export type AlgorithmStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string;
714 export interface AlgorithmStatusDetails {
715 /**
716 * The status of algorithm validation.
717 */
718 ValidationStatuses?: AlgorithmStatusItemList;
719 /**
720 * The status of the scan of the algorithm's Docker image container.
721 */
722 ImageScanStatuses?: AlgorithmStatusItemList;
723 }
724 export interface AlgorithmStatusItem {
725 /**
726 * The name of the algorithm for which the overall status is being reported.
727 */
728 Name: EntityName;
729 /**
730 * The current status.
731 */
732 Status: DetailedAlgorithmStatus;
733 /**
734 * if the overall status is Failed, the reason for the failure.
735 */
736 FailureReason?: String;
737 }
738 export type AlgorithmStatusItemList = AlgorithmStatusItem[];
739 export interface AlgorithmSummary {
740 /**
741 * The name of the algorithm that is described by the summary.
742 */
743 AlgorithmName: EntityName;
744 /**
745 * The Amazon Resource Name (ARN) of the algorithm.
746 */
747 AlgorithmArn: AlgorithmArn;
748 /**
749 * A brief description of the algorithm.
750 */
751 AlgorithmDescription?: EntityDescription;
752 /**
753 * A timestamp that shows when the algorithm was created.
754 */
755 CreationTime: CreationTime;
756 /**
757 * The overall status of the algorithm.
758 */
759 AlgorithmStatus: AlgorithmStatus;
760 }
761 export type AlgorithmSummaryList = AlgorithmSummary[];
762 export interface AlgorithmValidationProfile {
763 /**
764 * The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
765 */
766 ProfileName: EntityName;
767 /**
768 * The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.
769 */
770 TrainingJobDefinition: TrainingJobDefinition;
771 /**
772 * The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.
773 */
774 TransformJobDefinition?: TransformJobDefinition;
775 }
776 export type AlgorithmValidationProfiles = AlgorithmValidationProfile[];
777 export interface AlgorithmValidationSpecification {
778 /**
779 * The IAM roles that Amazon SageMaker uses to run the training jobs.
780 */
781 ValidationRole: RoleArn;
782 /**
783 * An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.
784 */
785 ValidationProfiles: AlgorithmValidationProfiles;
786 }
787 export interface AnnotationConsolidationConfig {
788 /**
789 * The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation. For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions: Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes. arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label. arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label. arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition For more information, see Annotation Consolidation.
790 */
791 AnnotationConsolidationLambdaArn: LambdaFunctionArn;
792 }
793 export type ArnOrName = string;
794 export type AssemblyType = "None"|"Line"|string;
795 export type AttributeName = string;
796 export type AttributeNames = AttributeName[];
797 export type BatchStrategy = "MultiRecord"|"SingleRecord"|string;
798 export type BillableTimeInSeconds = number;
799 export type Boolean = boolean;
800 export type BooleanOperator = "And"|"Or"|string;
801 export type Branch = string;
802 export interface CategoricalParameterRange {
803 /**
804 * The name of the categorical hyperparameter to tune.
805 */
806 Name: ParameterKey;
807 /**
808 * A list of the categories for the hyperparameter.
809 */
810 Values: ParameterValues;
811 }
812 export interface CategoricalParameterRangeSpecification {
813 /**
814 * The allowed categories for the hyperparameter.
815 */
816 Values: ParameterValues;
817 }
818 export type CategoricalParameterRanges = CategoricalParameterRange[];
819 export type Cents = number;
820 export type CertifyForMarketplace = boolean;
821 export interface Channel {
822 /**
823 * The name of the channel.
824 */
825 ChannelName: ChannelName;
826 /**
827 * The location of the channel data.
828 */
829 DataSource: DataSource;
830 /**
831 * The MIME type of the data.
832 */
833 ContentType?: ContentType;
834 /**
835 * If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.
836 */
837 CompressionType?: CompressionType;
838 /**
839 * Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO. In File mode, leave this field unset or set it to None.
840 */
841 RecordWrapperType?: RecordWrapper;
842 /**
843 * (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode. To use a model for incremental training, choose File input model.
844 */
845 InputMode?: TrainingInputMode;
846 /**
847 * A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value. For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
848 */
849 ShuffleConfig?: ShuffleConfig;
850 }
851 export type ChannelName = string;
852 export interface ChannelSpecification {
853 /**
854 * The name of the channel.
855 */
856 Name: ChannelName;
857 /**
858 * A brief description of the channel.
859 */
860 Description?: EntityDescription;
861 /**
862 * Indicates whether the channel is required by the algorithm.
863 */
864 IsRequired?: Boolean;
865 /**
866 * The supported MIME types for the data.
867 */
868 SupportedContentTypes: ContentTypes;
869 /**
870 * The allowed compression types, if data compression is used.
871 */
872 SupportedCompressionTypes?: CompressionTypes;
873 /**
874 * The allowed input mode, either FILE or PIPE. In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
875 */
876 SupportedInputModes: InputModes;
877 }
878 export type ChannelSpecifications = ChannelSpecification[];
879 export interface CheckpointConfig {
880 /**
881 * Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
882 */
883 S3Uri: S3Uri;
884 /**
885 * (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
886 */
887 LocalPath?: DirectoryPath;
888 }
889 export type CodeRepositoryArn = string;
890 export type CodeRepositoryContains = string;
891 export type CodeRepositoryNameContains = string;
892 export type CodeRepositoryNameOrUrl = string;
893 export type CodeRepositorySortBy = "Name"|"CreationTime"|"LastModifiedTime"|string;
894 export type CodeRepositorySortOrder = "Ascending"|"Descending"|string;
895 export interface CodeRepositorySummary {
896 /**
897 * The name of the Git repository.
898 */
899 CodeRepositoryName: EntityName;
900 /**
901 * The Amazon Resource Name (ARN) of the Git repository.
902 */
903 CodeRepositoryArn: CodeRepositoryArn;
904 /**
905 * The date and time that the Git repository was created.
906 */
907 CreationTime: CreationTime;
908 /**
909 * The date and time that the Git repository was last modified.
910 */
911 LastModifiedTime: LastModifiedTime;
912 /**
913 * Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.
914 */
915 GitConfig?: GitConfig;
916 }
917 export type CodeRepositorySummaryList = CodeRepositorySummary[];
918 export type CognitoClientId = string;
919 export interface CognitoMemberDefinition {
920 /**
921 * An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
922 */
923 UserPool: CognitoUserPool;
924 /**
925 * An identifier for a user group.
926 */
927 UserGroup: CognitoUserGroup;
928 /**
929 * An identifier for an application client. You must create the app client ID using Amazon Cognito.
930 */
931 ClientId: CognitoClientId;
932 }
933 export type CognitoUserGroup = string;
934 export type CognitoUserPool = string;
935 export type CompilationJobArn = string;
936 export type CompilationJobStatus = "INPROGRESS"|"COMPLETED"|"FAILED"|"STARTING"|"STOPPING"|"STOPPED"|string;
937 export type CompilationJobSummaries = CompilationJobSummary[];
938 export interface CompilationJobSummary {
939 /**
940 * The name of the model compilation job that you want a summary for.
941 */
942 CompilationJobName: EntityName;
943 /**
944 * The Amazon Resource Name (ARN) of the model compilation job.
945 */
946 CompilationJobArn: CompilationJobArn;
947 /**
948 * The time when the model compilation job was created.
949 */
950 CreationTime: CreationTime;
951 /**
952 * The time when the model compilation job started.
953 */
954 CompilationStartTime?: Timestamp;
955 /**
956 * The time when the model compilation job completed.
957 */
958 CompilationEndTime?: Timestamp;
959 /**
960 * The type of device that the model will run on after compilation has completed.
961 */
962 CompilationTargetDevice: TargetDevice;
963 /**
964 * The time when the model compilation job was last modified.
965 */
966 LastModifiedTime?: LastModifiedTime;
967 /**
968 * The status of the model compilation job.
969 */
970 CompilationJobStatus: CompilationJobStatus;
971 }
972 export type CompressionType = "None"|"Gzip"|string;
973 export type CompressionTypes = CompressionType[];
974 export interface ContainerDefinition {
975 /**
976 * This parameter is ignored for models that contain only a PrimaryContainer. When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.
977 */
978 ContainerHostname?: ContainerHostname;
979 /**
980 * The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker
981 */
982 Image?: Image;
983 /**
984 * The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters. If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. 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 in an AWS Region in the AWS Identity and Access Management User Guide. If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.
985 */
986 ModelDataUrl?: Url;
987 /**
988 * The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
989 */
990 Environment?: EnvironmentMap;
991 /**
992 * The name or Amazon Resource Name (ARN) of the model package to use to create the model.
993 */
994 ModelPackageName?: ArnOrName;
995 }
996 export type ContainerDefinitionList = ContainerDefinition[];
997 export type ContainerHostname = string;
998 export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string;
999 export type ContentClassifiers = ContentClassifier[];
1000 export type ContentType = string;
1001 export type ContentTypes = ContentType[];
1002 export interface ContinuousParameterRange {
1003 /**
1004 * The name of the continuous hyperparameter to tune.
1005 */
1006 Name: ParameterKey;
1007 /**
1008 * The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.
1009 */
1010 MinValue: ParameterValue;
1011 /**
1012 * The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
1013 */
1014 MaxValue: ParameterValue;
1015 /**
1016 * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0. ReverseLogarithmic Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. Reverse logarithmic scaling works only for ranges that are entirely within the range 0&lt;=x&lt;1.0.
1017 */
1018 ScalingType?: HyperParameterScalingType;
1019 }
1020 export interface ContinuousParameterRangeSpecification {
1021 /**
1022 * The minimum floating-point value allowed.
1023 */
1024 MinValue: ParameterValue;
1025 /**
1026 * The maximum floating-point value allowed.
1027 */
1028 MaxValue: ParameterValue;
1029 }
1030 export type ContinuousParameterRanges = ContinuousParameterRange[];
1031 export interface CreateAlgorithmInput {
1032 /**
1033 * The name of the algorithm.
1034 */
1035 AlgorithmName: EntityName;
1036 /**
1037 * A description of the algorithm.
1038 */
1039 AlgorithmDescription?: EntityDescription;
1040 /**
1041 * Specifies details about training jobs run by this algorithm, including the following: The Amazon ECR path of the container and the version digest of the algorithm. The hyperparameters that the algorithm supports. The instance types that the algorithm supports for training. Whether the algorithm supports distributed training. The metrics that the algorithm emits to Amazon CloudWatch. Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs. The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.
1042 */
1043 TrainingSpecification: TrainingSpecification;
1044 /**
1045 * Specifies details about inference jobs that the algorithm runs, including the following: The Amazon ECR paths of containers that contain the inference code and model artifacts. The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference. The input and output content formats that the algorithm supports for inference.
1046 */
1047 InferenceSpecification?: InferenceSpecification;
1048 /**
1049 * Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.
1050 */
1051 ValidationSpecification?: AlgorithmValidationSpecification;
1052 /**
1053 * Whether to certify the algorithm so that it can be listed in AWS Marketplace.
1054 */
1055 CertifyForMarketplace?: CertifyForMarketplace;
1056 }
1057 export interface CreateAlgorithmOutput {
1058 /**
1059 * The Amazon Resource Name (ARN) of the new algorithm.
1060 */
1061 AlgorithmArn: AlgorithmArn;
1062 }
1063 export interface CreateCodeRepositoryInput {
1064 /**
1065 * The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
1066 */
1067 CodeRepositoryName: EntityName;
1068 /**
1069 * Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
1070 */
1071 GitConfig: GitConfig;
1072 }
1073 export interface CreateCodeRepositoryOutput {
1074 /**
1075 * The Amazon Resource Name (ARN) of the new repository.
1076 */
1077 CodeRepositoryArn: CodeRepositoryArn;
1078 }
1079 export interface CreateCompilationJobRequest {
1080 /**
1081 * A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.
1082 */
1083 CompilationJobName: EntityName;
1084 /**
1085 * The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. During model compilation, Amazon SageMaker needs your permission to: Read input data from an S3 bucket Write model artifacts to an S3 bucket Write logs to Amazon CloudWatch Logs Publish metrics to Amazon CloudWatch You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
1086 */
1087 RoleArn: RoleArn;
1088 /**
1089 * Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
1090 */
1091 InputConfig: InputConfig;
1092 /**
1093 * Provides information about the output location for the compiled model and the target device the model runs on.
1094 */
1095 OutputConfig: OutputConfig;
1096 /**
1097 * Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
1098 */
1099 StoppingCondition: StoppingCondition;
1100 }
1101 export interface CreateCompilationJobResponse {
1102 /**
1103 * If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format: CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.
1104 */
1105 CompilationJobArn: CompilationJobArn;
1106 }
1107 export interface CreateEndpointConfigInput {
1108 /**
1109 * The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
1110 */
1111 EndpointConfigName: EndpointConfigName;
1112 /**
1113 * An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
1114 */
1115 ProductionVariants: ProductionVariantList;
1116 /**
1117 * A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1118 */
1119 Tags?: TagList;
1120 /**
1121 * The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. Nitro-based instances do not support encryption with AWS KMS. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances, the call to CreateEndpointConfig fails. For a list of nitro-based instances, see Nitro-based Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For more information about storage volumes on nitro-based instances, see Amazon EBS and NVMe on Linux Instances.
1122 */
1123 KmsKeyId?: KmsKeyId;
1124 }
1125 export interface CreateEndpointConfigOutput {
1126 /**
1127 * The Amazon Resource Name (ARN) of the endpoint configuration.
1128 */
1129 EndpointConfigArn: EndpointConfigArn;
1130 }
1131 export interface CreateEndpointInput {
1132 /**
1133 * The name of the endpoint. The name must be unique within an AWS Region in your AWS account.
1134 */
1135 EndpointName: EndpointName;
1136 /**
1137 * The name of an endpoint configuration. For more information, see CreateEndpointConfig.
1138 */
1139 EndpointConfigName: EndpointConfigName;
1140 /**
1141 * An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.
1142 */
1143 Tags?: TagList;
1144 }
1145 export interface CreateEndpointOutput {
1146 /**
1147 * The Amazon Resource Name (ARN) of the endpoint.
1148 */
1149 EndpointArn: EndpointArn;
1150 }
1151 export interface CreateHyperParameterTuningJobRequest {
1152 /**
1153 * The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
1154 */
1155 HyperParameterTuningJobName: HyperParameterTuningJobName;
1156 /**
1157 * The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning
1158 */
1159 HyperParameterTuningJobConfig: HyperParameterTuningJobConfig;
1160 /**
1161 * The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.
1162 */
1163 TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
1164 /**
1165 * Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job. All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job. All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.
1166 */
1167 WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
1168 /**
1169 * An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies. Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
1170 */
1171 Tags?: TagList;
1172 }
1173 export interface CreateHyperParameterTuningJobResponse {
1174 /**
1175 * The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
1176 */
1177 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
1178 }
1179 export interface CreateLabelingJobRequest {
1180 /**
1181 * The name of the labeling job. This name is used to identify the job in a list of labeling jobs.
1182 */
1183 LabelingJobName: LabelingJobName;
1184 /**
1185 * The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".
1186 */
1187 LabelAttributeName: LabelAttributeName;
1188 /**
1189 * Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
1190 */
1191 InputConfig: LabelingJobInputConfig;
1192 /**
1193 * The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
1194 */
1195 OutputConfig: LabelingJobOutputConfig;
1196 /**
1197 * The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
1198 */
1199 RoleArn: RoleArn;
1200 /**
1201 * The S3 URL of the file that defines the categories used to label the data objects. The file is a JSON structure in the following format: { "document-version": "2018-11-28" "labels": [ { "label": "label 1" }, { "label": "label 2" }, ... { "label": "label n" } ] }
1202 */
1203 LabelCategoryConfigS3Uri?: S3Uri;
1204 /**
1205 * A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
1206 */
1207 StoppingConditions?: LabelingJobStoppingConditions;
1208 /**
1209 * Configures the information required to perform automated data labeling.
1210 */
1211 LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig;
1212 /**
1213 * Configures the information required for human workers to complete a labeling task.
1214 */
1215 HumanTaskConfig: HumanTaskConfig;
1216 /**
1217 * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1218 */
1219 Tags?: TagList;
1220 }
1221 export interface CreateLabelingJobResponse {
1222 /**
1223 * The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
1224 */
1225 LabelingJobArn: LabelingJobArn;
1226 }
1227 export interface CreateModelInput {
1228 /**
1229 * The name of the new model.
1230 */
1231 ModelName: ModelName;
1232 /**
1233 * The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
1234 */
1235 PrimaryContainer?: ContainerDefinition;
1236 /**
1237 * Specifies the containers in the inference pipeline.
1238 */
1239 Containers?: ContainerDefinitionList;
1240 /**
1241 * The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
1242 */
1243 ExecutionRoleArn: RoleArn;
1244 /**
1245 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1246 */
1247 Tags?: TagList;
1248 /**
1249 * A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.
1250 */
1251 VpcConfig?: VpcConfig;
1252 /**
1253 * Isolates the model container. No inbound or outbound network calls can be made to or from the model container. The Semantic Segmentation built-in algorithm does not support network isolation.
1254 */
1255 EnableNetworkIsolation?: Boolean;
1256 }
1257 export interface CreateModelOutput {
1258 /**
1259 * The ARN of the model created in Amazon SageMaker.
1260 */
1261 ModelArn: ModelArn;
1262 }
1263 export interface CreateModelPackageInput {
1264 /**
1265 * The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
1266 */
1267 ModelPackageName: EntityName;
1268 /**
1269 * A description of the model package.
1270 */
1271 ModelPackageDescription?: EntityDescription;
1272 /**
1273 * Specifies details about inference jobs that can be run with models based on this model package, including the following: The Amazon ECR paths of containers that contain the inference code and model artifacts. The instance types that the model package supports for transform jobs and real-time endpoints used for inference. The input and output content formats that the model package supports for inference.
1274 */
1275 InferenceSpecification?: InferenceSpecification;
1276 /**
1277 * Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
1278 */
1279 ValidationSpecification?: ModelPackageValidationSpecification;
1280 /**
1281 * Details about the algorithm that was used to create the model package.
1282 */
1283 SourceAlgorithmSpecification?: SourceAlgorithmSpecification;
1284 /**
1285 * Whether to certify the model package for listing on AWS Marketplace.
1286 */
1287 CertifyForMarketplace?: CertifyForMarketplace;
1288 }
1289 export interface CreateModelPackageOutput {
1290 /**
1291 * The Amazon Resource Name (ARN) of the new model package.
1292 */
1293 ModelPackageArn: ModelPackageArn;
1294 }
1295 export interface CreateNotebookInstanceInput {
1296 /**
1297 * The name of the new notebook instance.
1298 */
1299 NotebookInstanceName: NotebookInstanceName;
1300 /**
1301 * The type of ML compute instance to launch for the notebook instance.
1302 */
1303 InstanceType: InstanceType;
1304 /**
1305 * The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
1306 */
1307 SubnetId?: SubnetId;
1308 /**
1309 * The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
1310 */
1311 SecurityGroupIds?: SecurityGroupIds;
1312 /**
1313 * When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissionsto to assume this role. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
1314 */
1315 RoleArn: RoleArn;
1316 /**
1317 * The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.
1318 */
1319 KmsKeyId?: KmsKeyId;
1320 /**
1321 * A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.
1322 */
1323 Tags?: TagList;
1324 /**
1325 * The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
1326 */
1327 LifecycleConfigName?: NotebookInstanceLifecycleConfigName;
1328 /**
1329 * Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC. For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.
1330 */
1331 DirectInternetAccess?: DirectInternetAccess;
1332 /**
1333 * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
1334 */
1335 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
1336 /**
1337 * A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
1338 */
1339 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
1340 /**
1341 * A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
1342 */
1343 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
1344 /**
1345 * An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
1346 */
1347 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
1348 /**
1349 * Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
1350 */
1351 RootAccess?: RootAccess;
1352 }
1353 export interface CreateNotebookInstanceLifecycleConfigInput {
1354 /**
1355 * The name of the lifecycle configuration.
1356 */
1357 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
1358 /**
1359 * A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
1360 */
1361 OnCreate?: NotebookInstanceLifecycleConfigList;
1362 /**
1363 * A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
1364 */
1365 OnStart?: NotebookInstanceLifecycleConfigList;
1366 }
1367 export interface CreateNotebookInstanceLifecycleConfigOutput {
1368 /**
1369 * The Amazon Resource Name (ARN) of the lifecycle configuration.
1370 */
1371 NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn;
1372 }
1373 export interface CreateNotebookInstanceOutput {
1374 /**
1375 * The Amazon Resource Name (ARN) of the notebook instance.
1376 */
1377 NotebookInstanceArn?: NotebookInstanceArn;
1378 }
1379 export interface CreatePresignedNotebookInstanceUrlInput {
1380 /**
1381 * The name of the notebook instance.
1382 */
1383 NotebookInstanceName: NotebookInstanceName;
1384 /**
1385 * The duration of the session, in seconds. The default is 12 hours.
1386 */
1387 SessionExpirationDurationInSeconds?: SessionExpirationDurationInSeconds;
1388 }
1389 export interface CreatePresignedNotebookInstanceUrlOutput {
1390 /**
1391 * A JSON object that contains the URL string.
1392 */
1393 AuthorizedUrl?: NotebookInstanceUrl;
1394 }
1395 export interface CreateTrainingJobRequest {
1396 /**
1397 * The name of the training job. The name must be unique within an AWS Region in an AWS account.
1398 */
1399 TrainingJobName: TrainingJobName;
1400 /**
1401 * Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms. You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
1402 */
1403 HyperParameters?: HyperParameters;
1404 /**
1405 * The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
1406 */
1407 AlgorithmSpecification: AlgorithmSpecification;
1408 /**
1409 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
1410 */
1411 RoleArn: RoleArn;
1412 /**
1413 * An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.
1414 */
1415 InputDataConfig?: InputDataConfig;
1416 /**
1417 * Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
1418 */
1419 OutputDataConfig: OutputDataConfig;
1420 /**
1421 * The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
1422 */
1423 ResourceConfig: ResourceConfig;
1424 /**
1425 * A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
1426 */
1427 VpcConfig?: VpcConfig;
1428 /**
1429 * Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
1430 */
1431 StoppingCondition: StoppingCondition;
1432 /**
1433 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1434 */
1435 Tags?: TagList;
1436 /**
1437 * Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation.
1438 */
1439 EnableNetworkIsolation?: Boolean;
1440 /**
1441 * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
1442 */
1443 EnableInterContainerTrafficEncryption?: Boolean;
1444 /**
1445 * To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run. The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
1446 */
1447 EnableManagedSpotTraining?: Boolean;
1448 /**
1449 * Contains information about the output location for managed spot training checkpoint data.
1450 */
1451 CheckpointConfig?: CheckpointConfig;
1452 }
1453 export interface CreateTrainingJobResponse {
1454 /**
1455 * The Amazon Resource Name (ARN) of the training job.
1456 */
1457 TrainingJobArn: TrainingJobArn;
1458 }
1459 export interface CreateTransformJobRequest {
1460 /**
1461 * The name of the transform job. The name must be unique within an AWS Region in an AWS account.
1462 */
1463 TransformJobName: TransformJobName;
1464 /**
1465 * The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.
1466 */
1467 ModelName: ModelName;
1468 /**
1469 * The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the optimal settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.
1470 */
1471 MaxConcurrentTransforms?: MaxConcurrentTransforms;
1472 /**
1473 * The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.
1474 */
1475 MaxPayloadInMB?: MaxPayloadInMB;
1476 /**
1477 * Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord. To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line. To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.
1478 */
1479 BatchStrategy?: BatchStrategy;
1480 /**
1481 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
1482 */
1483 Environment?: TransformEnvironmentMap;
1484 /**
1485 * Describes the input source and the way the transform job consumes it.
1486 */
1487 TransformInput: TransformInput;
1488 /**
1489 * Describes the results of the transform job.
1490 */
1491 TransformOutput: TransformOutput;
1492 /**
1493 * Describes the resources, including ML instance types and ML instance count, to use for the transform job.
1494 */
1495 TransformResources: TransformResources;
1496 /**
1497 * The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
1498 */
1499 DataProcessing?: DataProcessing;
1500 /**
1501 * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1502 */
1503 Tags?: TagList;
1504 }
1505 export interface CreateTransformJobResponse {
1506 /**
1507 * The Amazon Resource Name (ARN) of the transform job.
1508 */
1509 TransformJobArn: TransformJobArn;
1510 }
1511 export interface CreateWorkteamRequest {
1512 /**
1513 * The name of the work team. Use this name to identify the work team.
1514 */
1515 WorkteamName: WorkteamName;
1516 /**
1517 * A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.
1518 */
1519 MemberDefinitions: MemberDefinitions;
1520 /**
1521 * A description of the work team.
1522 */
1523 Description: String200;
1524 /**
1525 * Configures notification of workers regarding available or expiring work items.
1526 */
1527 NotificationConfiguration?: NotificationConfiguration;
1528 /**
1529 * An array of key-value pairs. For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1530 */
1531 Tags?: TagList;
1532 }
1533 export interface CreateWorkteamResponse {
1534 /**
1535 * The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
1536 */
1537 WorkteamArn?: WorkteamArn;
1538 }
1539 export type CreationTime = Date;
1540 export type DataInputConfig = string;
1541 export interface DataProcessing {
1542 /**
1543 * A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $. Examples: "$", "$[1:]", "$.features"
1544 */
1545 InputFilter?: JsonPath;
1546 /**
1547 * A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error. Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"
1548 */
1549 OutputFilter?: JsonPath;
1550 /**
1551 * Specifies the source of the data to join with the transformed data. The valid values are None and Input The default value is None which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput. For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.
1552 */
1553 JoinSource?: JoinSource;
1554 }
1555 export interface DataSource {
1556 /**
1557 * The S3 location of the data source that is associated with a channel.
1558 */
1559 S3DataSource?: S3DataSource;
1560 /**
1561 * The file system that is associated with a channel.
1562 */
1563 FileSystemDataSource?: FileSystemDataSource;
1564 }
1565 export interface DeleteAlgorithmInput {
1566 /**
1567 * The name of the algorithm to delete.
1568 */
1569 AlgorithmName: EntityName;
1570 }
1571 export interface DeleteCodeRepositoryInput {
1572 /**
1573 * The name of the Git repository to delete.
1574 */
1575 CodeRepositoryName: EntityName;
1576 }
1577 export interface DeleteEndpointConfigInput {
1578 /**
1579 * The name of the endpoint configuration that you want to delete.
1580 */
1581 EndpointConfigName: EndpointConfigName;
1582 }
1583 export interface DeleteEndpointInput {
1584 /**
1585 * The name of the endpoint that you want to delete.
1586 */
1587 EndpointName: EndpointName;
1588 }
1589 export interface DeleteModelInput {
1590 /**
1591 * The name of the model to delete.
1592 */
1593 ModelName: ModelName;
1594 }
1595 export interface DeleteModelPackageInput {
1596 /**
1597 * The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
1598 */
1599 ModelPackageName: EntityName;
1600 }
1601 export interface DeleteNotebookInstanceInput {
1602 /**
1603 * The name of the Amazon SageMaker notebook instance to delete.
1604 */
1605 NotebookInstanceName: NotebookInstanceName;
1606 }
1607 export interface DeleteNotebookInstanceLifecycleConfigInput {
1608 /**
1609 * The name of the lifecycle configuration to delete.
1610 */
1611 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
1612 }
1613 export interface DeleteTagsInput {
1614 /**
1615 * The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
1616 */
1617 ResourceArn: ResourceArn;
1618 /**
1619 * An array or one or more tag keys to delete.
1620 */
1621 TagKeys: TagKeyList;
1622 }
1623 export interface DeleteTagsOutput {
1624 }
1625 export interface DeleteWorkteamRequest {
1626 /**
1627 * The name of the work team to delete.
1628 */
1629 WorkteamName: WorkteamName;
1630 }
1631 export interface DeleteWorkteamResponse {
1632 /**
1633 * Returns true if the work team was successfully deleted; otherwise, returns false.
1634 */
1635 Success: Success;
1636 }
1637 export interface DeployedImage {
1638 /**
1639 * The image path you specified when you created the model.
1640 */
1641 SpecifiedImage?: Image;
1642 /**
1643 * The specific digest path of the image hosted in this ProductionVariant.
1644 */
1645 ResolvedImage?: Image;
1646 /**
1647 * The date and time when the image path for the model resolved to the ResolvedImage
1648 */
1649 ResolutionTime?: Timestamp;
1650 }
1651 export type DeployedImages = DeployedImage[];
1652 export interface DescribeAlgorithmInput {
1653 /**
1654 * The name of the algorithm to describe.
1655 */
1656 AlgorithmName: ArnOrName;
1657 }
1658 export interface DescribeAlgorithmOutput {
1659 /**
1660 * The name of the algorithm being described.
1661 */
1662 AlgorithmName: EntityName;
1663 /**
1664 * The Amazon Resource Name (ARN) of the algorithm.
1665 */
1666 AlgorithmArn: AlgorithmArn;
1667 /**
1668 * A brief summary about the algorithm.
1669 */
1670 AlgorithmDescription?: EntityDescription;
1671 /**
1672 * A timestamp specifying when the algorithm was created.
1673 */
1674 CreationTime: CreationTime;
1675 /**
1676 * Details about training jobs run by this algorithm.
1677 */
1678 TrainingSpecification: TrainingSpecification;
1679 /**
1680 * Details about inference jobs that the algorithm runs.
1681 */
1682 InferenceSpecification?: InferenceSpecification;
1683 /**
1684 * Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
1685 */
1686 ValidationSpecification?: AlgorithmValidationSpecification;
1687 /**
1688 * The current status of the algorithm.
1689 */
1690 AlgorithmStatus: AlgorithmStatus;
1691 /**
1692 * Details about the current status of the algorithm.
1693 */
1694 AlgorithmStatusDetails: AlgorithmStatusDetails;
1695 /**
1696 * The product identifier of the algorithm.
1697 */
1698 ProductId?: ProductId;
1699 /**
1700 * Whether the algorithm is certified to be listed in AWS Marketplace.
1701 */
1702 CertifyForMarketplace?: CertifyForMarketplace;
1703 }
1704 export interface DescribeCodeRepositoryInput {
1705 /**
1706 * The name of the Git repository to describe.
1707 */
1708 CodeRepositoryName: EntityName;
1709 }
1710 export interface DescribeCodeRepositoryOutput {
1711 /**
1712 * The name of the Git repository.
1713 */
1714 CodeRepositoryName: EntityName;
1715 /**
1716 * The Amazon Resource Name (ARN) of the Git repository.
1717 */
1718 CodeRepositoryArn: CodeRepositoryArn;
1719 /**
1720 * The date and time that the repository was created.
1721 */
1722 CreationTime: CreationTime;
1723 /**
1724 * The date and time that the repository was last changed.
1725 */
1726 LastModifiedTime: LastModifiedTime;
1727 /**
1728 * Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository.
1729 */
1730 GitConfig?: GitConfig;
1731 }
1732 export interface DescribeCompilationJobRequest {
1733 /**
1734 * The name of the model compilation job that you want information about.
1735 */
1736 CompilationJobName: EntityName;
1737 }
1738 export interface DescribeCompilationJobResponse {
1739 /**
1740 * The name of the model compilation job.
1741 */
1742 CompilationJobName: EntityName;
1743 /**
1744 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
1745 */
1746 CompilationJobArn: CompilationJobArn;
1747 /**
1748 * The status of the model compilation job.
1749 */
1750 CompilationJobStatus: CompilationJobStatus;
1751 /**
1752 * The time when the model compilation job started the CompilationJob instances. You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.
1753 */
1754 CompilationStartTime?: Timestamp;
1755 /**
1756 * The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
1757 */
1758 CompilationEndTime?: Timestamp;
1759 /**
1760 * Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
1761 */
1762 StoppingCondition: StoppingCondition;
1763 /**
1764 * The time that the model compilation job was created.
1765 */
1766 CreationTime: CreationTime;
1767 /**
1768 * The time that the status of the model compilation job was last modified.
1769 */
1770 LastModifiedTime: LastModifiedTime;
1771 /**
1772 * If a model compilation job failed, the reason it failed.
1773 */
1774 FailureReason: FailureReason;
1775 /**
1776 * Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
1777 */
1778 ModelArtifacts: ModelArtifacts;
1779 /**
1780 * The Amazon Resource Name (ARN) of the model compilation job.
1781 */
1782 RoleArn: RoleArn;
1783 /**
1784 * Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
1785 */
1786 InputConfig: InputConfig;
1787 /**
1788 * Information about the output location for the compiled model and the target device that the model runs on.
1789 */
1790 OutputConfig: OutputConfig;
1791 }
1792 export interface DescribeEndpointConfigInput {
1793 /**
1794 * The name of the endpoint configuration.
1795 */
1796 EndpointConfigName: EndpointConfigName;
1797 }
1798 export interface DescribeEndpointConfigOutput {
1799 /**
1800 * Name of the Amazon SageMaker endpoint configuration.
1801 */
1802 EndpointConfigName: EndpointConfigName;
1803 /**
1804 * The Amazon Resource Name (ARN) of the endpoint configuration.
1805 */
1806 EndpointConfigArn: EndpointConfigArn;
1807 /**
1808 * An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
1809 */
1810 ProductionVariants: ProductionVariantList;
1811 /**
1812 * AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
1813 */
1814 KmsKeyId?: KmsKeyId;
1815 /**
1816 * A timestamp that shows when the endpoint configuration was created.
1817 */
1818 CreationTime: Timestamp;
1819 }
1820 export interface DescribeEndpointInput {
1821 /**
1822 * The name of the endpoint.
1823 */
1824 EndpointName: EndpointName;
1825 }
1826 export interface DescribeEndpointOutput {
1827 /**
1828 * Name of the endpoint.
1829 */
1830 EndpointName: EndpointName;
1831 /**
1832 * The Amazon Resource Name (ARN) of the endpoint.
1833 */
1834 EndpointArn: EndpointArn;
1835 /**
1836 * The name of the endpoint configuration associated with this endpoint.
1837 */
1838 EndpointConfigName: EndpointConfigName;
1839 /**
1840 * An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
1841 */
1842 ProductionVariants?: ProductionVariantSummaryList;
1843 /**
1844 * The status of the endpoint. OutOfService: Endpoint is not available to take incoming requests. Creating: CreateEndpoint is executing. Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. InService: Endpoint is available to process incoming requests. Deleting: DeleteEndpoint is executing. Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
1845 */
1846 EndpointStatus: EndpointStatus;
1847 /**
1848 * If the status of the endpoint is Failed, the reason why it failed.
1849 */
1850 FailureReason?: FailureReason;
1851 /**
1852 * A timestamp that shows when the endpoint was created.
1853 */
1854 CreationTime: Timestamp;
1855 /**
1856 * A timestamp that shows when the endpoint was last modified.
1857 */
1858 LastModifiedTime: Timestamp;
1859 }
1860 export interface DescribeHyperParameterTuningJobRequest {
1861 /**
1862 * The name of the tuning job to describe.
1863 */
1864 HyperParameterTuningJobName: HyperParameterTuningJobName;
1865 }
1866 export interface DescribeHyperParameterTuningJobResponse {
1867 /**
1868 * The name of the tuning job.
1869 */
1870 HyperParameterTuningJobName: HyperParameterTuningJobName;
1871 /**
1872 * The Amazon Resource Name (ARN) of the tuning job.
1873 */
1874 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
1875 /**
1876 * The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
1877 */
1878 HyperParameterTuningJobConfig: HyperParameterTuningJobConfig;
1879 /**
1880 * The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
1881 */
1882 TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
1883 /**
1884 * The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
1885 */
1886 HyperParameterTuningJobStatus: HyperParameterTuningJobStatus;
1887 /**
1888 * The date and time that the tuning job started.
1889 */
1890 CreationTime: Timestamp;
1891 /**
1892 * The date and time that the tuning job ended.
1893 */
1894 HyperParameterTuningEndTime?: Timestamp;
1895 /**
1896 * The date and time that the status of the tuning job was modified.
1897 */
1898 LastModifiedTime?: Timestamp;
1899 /**
1900 * The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
1901 */
1902 TrainingJobStatusCounters: TrainingJobStatusCounters;
1903 /**
1904 * The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
1905 */
1906 ObjectiveStatusCounters: ObjectiveStatusCounters;
1907 /**
1908 * A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
1909 */
1910 BestTrainingJob?: HyperParameterTrainingJobSummary;
1911 /**
1912 * If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
1913 */
1914 OverallBestTrainingJob?: HyperParameterTrainingJobSummary;
1915 /**
1916 * The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
1917 */
1918 WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
1919 /**
1920 * If the tuning job failed, the reason it failed.
1921 */
1922 FailureReason?: FailureReason;
1923 }
1924 export interface DescribeLabelingJobRequest {
1925 /**
1926 * The name of the labeling job to return information for.
1927 */
1928 LabelingJobName: LabelingJobName;
1929 }
1930 export interface DescribeLabelingJobResponse {
1931 /**
1932 * The processing status of the labeling job.
1933 */
1934 LabelingJobStatus: LabelingJobStatus;
1935 /**
1936 * Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.
1937 */
1938 LabelCounters: LabelCounters;
1939 /**
1940 * If the job failed, the reason that it failed.
1941 */
1942 FailureReason?: FailureReason;
1943 /**
1944 * The date and time that the labeling job was created.
1945 */
1946 CreationTime: Timestamp;
1947 /**
1948 * The date and time that the labeling job was last updated.
1949 */
1950 LastModifiedTime: Timestamp;
1951 /**
1952 * A unique identifier for work done as part of a labeling job.
1953 */
1954 JobReferenceCode: JobReferenceCode;
1955 /**
1956 * The name assigned to the labeling job when it was created.
1957 */
1958 LabelingJobName: LabelingJobName;
1959 /**
1960 * The Amazon Resource Name (ARN) of the labeling job.
1961 */
1962 LabelingJobArn: LabelingJobArn;
1963 /**
1964 * The attribute used as the label in the output manifest file.
1965 */
1966 LabelAttributeName?: LabelAttributeName;
1967 /**
1968 * Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
1969 */
1970 InputConfig: LabelingJobInputConfig;
1971 /**
1972 * The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
1973 */
1974 OutputConfig: LabelingJobOutputConfig;
1975 /**
1976 * The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
1977 */
1978 RoleArn: RoleArn;
1979 /**
1980 * The S3 location of the JSON file that defines the categories used to label data objects. The file is a JSON structure in the following format: { "document-version": "2018-11-28" "labels": [ { "label": "label 1" }, { "label": "label 2" }, ... { "label": "label n" } ] }
1981 */
1982 LabelCategoryConfigS3Uri?: S3Uri;
1983 /**
1984 * A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
1985 */
1986 StoppingConditions?: LabelingJobStoppingConditions;
1987 /**
1988 * Configuration information for automated data labeling.
1989 */
1990 LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig;
1991 /**
1992 * Configuration information required for human workers to complete a labeling task.
1993 */
1994 HumanTaskConfig: HumanTaskConfig;
1995 /**
1996 * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
1997 */
1998 Tags?: TagList;
1999 /**
2000 * The location of the output produced by the labeling job.
2001 */
2002 LabelingJobOutput?: LabelingJobOutput;
2003 }
2004 export interface DescribeModelInput {
2005 /**
2006 * The name of the model.
2007 */
2008 ModelName: ModelName;
2009 }
2010 export interface DescribeModelOutput {
2011 /**
2012 * Name of the Amazon SageMaker model.
2013 */
2014 ModelName: ModelName;
2015 /**
2016 * The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
2017 */
2018 PrimaryContainer?: ContainerDefinition;
2019 /**
2020 * The containers in the inference pipeline.
2021 */
2022 Containers?: ContainerDefinitionList;
2023 /**
2024 * The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
2025 */
2026 ExecutionRoleArn: RoleArn;
2027 /**
2028 * A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
2029 */
2030 VpcConfig?: VpcConfig;
2031 /**
2032 * A timestamp that shows when the model was created.
2033 */
2034 CreationTime: Timestamp;
2035 /**
2036 * The Amazon Resource Name (ARN) of the model.
2037 */
2038 ModelArn: ModelArn;
2039 /**
2040 * If True, no inbound or outbound network calls can be made to or from the model container. The Semantic Segmentation built-in algorithm does not support network isolation.
2041 */
2042 EnableNetworkIsolation?: Boolean;
2043 }
2044 export interface DescribeModelPackageInput {
2045 /**
2046 * The name of the model package to describe.
2047 */
2048 ModelPackageName: ArnOrName;
2049 }
2050 export interface DescribeModelPackageOutput {
2051 /**
2052 * The name of the model package being described.
2053 */
2054 ModelPackageName: EntityName;
2055 /**
2056 * The Amazon Resource Name (ARN) of the model package.
2057 */
2058 ModelPackageArn: ModelPackageArn;
2059 /**
2060 * A brief summary of the model package.
2061 */
2062 ModelPackageDescription?: EntityDescription;
2063 /**
2064 * A timestamp specifying when the model package was created.
2065 */
2066 CreationTime: CreationTime;
2067 /**
2068 * Details about inference jobs that can be run with models based on this model package.
2069 */
2070 InferenceSpecification?: InferenceSpecification;
2071 /**
2072 * Details about the algorithm that was used to create the model package.
2073 */
2074 SourceAlgorithmSpecification?: SourceAlgorithmSpecification;
2075 /**
2076 * Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
2077 */
2078 ValidationSpecification?: ModelPackageValidationSpecification;
2079 /**
2080 * The current status of the model package.
2081 */
2082 ModelPackageStatus: ModelPackageStatus;
2083 /**
2084 * Details about the current status of the model package.
2085 */
2086 ModelPackageStatusDetails: ModelPackageStatusDetails;
2087 /**
2088 * Whether the model package is certified for listing on AWS Marketplace.
2089 */
2090 CertifyForMarketplace?: CertifyForMarketplace;
2091 }
2092 export interface DescribeNotebookInstanceInput {
2093 /**
2094 * The name of the notebook instance that you want information about.
2095 */
2096 NotebookInstanceName: NotebookInstanceName;
2097 }
2098 export interface DescribeNotebookInstanceLifecycleConfigInput {
2099 /**
2100 * The name of the lifecycle configuration to describe.
2101 */
2102 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
2103 }
2104 export interface DescribeNotebookInstanceLifecycleConfigOutput {
2105 /**
2106 * The Amazon Resource Name (ARN) of the lifecycle configuration.
2107 */
2108 NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn;
2109 /**
2110 * The name of the lifecycle configuration.
2111 */
2112 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
2113 /**
2114 * The shell script that runs only once, when you create a notebook instance.
2115 */
2116 OnCreate?: NotebookInstanceLifecycleConfigList;
2117 /**
2118 * The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
2119 */
2120 OnStart?: NotebookInstanceLifecycleConfigList;
2121 /**
2122 * A timestamp that tells when the lifecycle configuration was last modified.
2123 */
2124 LastModifiedTime?: LastModifiedTime;
2125 /**
2126 * A timestamp that tells when the lifecycle configuration was created.
2127 */
2128 CreationTime?: CreationTime;
2129 }
2130 export interface DescribeNotebookInstanceOutput {
2131 /**
2132 * The Amazon Resource Name (ARN) of the notebook instance.
2133 */
2134 NotebookInstanceArn?: NotebookInstanceArn;
2135 /**
2136 * The name of the Amazon SageMaker notebook instance.
2137 */
2138 NotebookInstanceName?: NotebookInstanceName;
2139 /**
2140 * The status of the notebook instance.
2141 */
2142 NotebookInstanceStatus?: NotebookInstanceStatus;
2143 /**
2144 * If status is Failed, the reason it failed.
2145 */
2146 FailureReason?: FailureReason;
2147 /**
2148 * The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
2149 */
2150 Url?: NotebookInstanceUrl;
2151 /**
2152 * The type of ML compute instance running on the notebook instance.
2153 */
2154 InstanceType?: InstanceType;
2155 /**
2156 * The ID of the VPC subnet.
2157 */
2158 SubnetId?: SubnetId;
2159 /**
2160 * The IDs of the VPC security groups.
2161 */
2162 SecurityGroups?: SecurityGroupIds;
2163 /**
2164 * The Amazon Resource Name (ARN) of the IAM role associated with the instance.
2165 */
2166 RoleArn?: RoleArn;
2167 /**
2168 * The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
2169 */
2170 KmsKeyId?: KmsKeyId;
2171 /**
2172 * The network interface IDs that Amazon SageMaker created at the time of creating the instance.
2173 */
2174 NetworkInterfaceId?: NetworkInterfaceId;
2175 /**
2176 * A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
2177 */
2178 LastModifiedTime?: LastModifiedTime;
2179 /**
2180 * A timestamp. Use this parameter to return the time when the notebook instance was created
2181 */
2182 CreationTime?: CreationTime;
2183 /**
2184 * Returns the name of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance
2185 */
2186 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
2187 /**
2188 * Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services. For more information, see Notebook Instances Are Internet-Enabled by Default.
2189 */
2190 DirectInternetAccess?: DirectInternetAccess;
2191 /**
2192 * The size, in GB, of the ML storage volume attached to the notebook instance.
2193 */
2194 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
2195 /**
2196 * A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
2197 */
2198 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
2199 /**
2200 * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
2201 */
2202 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
2203 /**
2204 * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
2205 */
2206 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
2207 /**
2208 * Whether root access is enabled or disabled for users of the notebook instance. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
2209 */
2210 RootAccess?: RootAccess;
2211 }
2212 export interface DescribeSubscribedWorkteamRequest {
2213 /**
2214 * The Amazon Resource Name (ARN) of the subscribed work team to describe.
2215 */
2216 WorkteamArn: WorkteamArn;
2217 }
2218 export interface DescribeSubscribedWorkteamResponse {
2219 /**
2220 * A Workteam instance that contains information about the work team.
2221 */
2222 SubscribedWorkteam: SubscribedWorkteam;
2223 }
2224 export interface DescribeTrainingJobRequest {
2225 /**
2226 * The name of the training job.
2227 */
2228 TrainingJobName: TrainingJobName;
2229 }
2230 export interface DescribeTrainingJobResponse {
2231 /**
2232 * Name of the model training job.
2233 */
2234 TrainingJobName: TrainingJobName;
2235 /**
2236 * The Amazon Resource Name (ARN) of the training job.
2237 */
2238 TrainingJobArn: TrainingJobArn;
2239 /**
2240 * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
2241 */
2242 TuningJobArn?: HyperParameterTuningJobArn;
2243 /**
2244 * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
2245 */
2246 LabelingJobArn?: LabelingJobArn;
2247 /**
2248 * Information about the Amazon S3 location that is configured for storing model artifacts.
2249 */
2250 ModelArtifacts: ModelArtifacts;
2251 /**
2252 * The status of the training job. Amazon SageMaker provides the following training job statuses: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus.
2253 */
2254 TrainingJobStatus: TrainingJobStatus;
2255 /**
2256 * Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Interrupted - The job stopped because the managed spot training instances were interrupted. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. MaxWaitTmeExceeded - The job stopped because it exceeded the maximum allowed wait time. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage
2257 */
2258 SecondaryStatus: SecondaryStatus;
2259 /**
2260 * If the training job failed, the reason it failed.
2261 */
2262 FailureReason?: FailureReason;
2263 /**
2264 * Algorithm-specific parameters.
2265 */
2266 HyperParameters?: HyperParameters;
2267 /**
2268 * Information about the algorithm used for training, and algorithm metadata.
2269 */
2270 AlgorithmSpecification: AlgorithmSpecification;
2271 /**
2272 * The AWS Identity and Access Management (IAM) role configured for the training job.
2273 */
2274 RoleArn?: RoleArn;
2275 /**
2276 * An array of Channel objects that describes each data input channel.
2277 */
2278 InputDataConfig?: InputDataConfig;
2279 /**
2280 * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
2281 */
2282 OutputDataConfig?: OutputDataConfig;
2283 /**
2284 * Resources, including ML compute instances and ML storage volumes, that are configured for model training.
2285 */
2286 ResourceConfig: ResourceConfig;
2287 /**
2288 * A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
2289 */
2290 VpcConfig?: VpcConfig;
2291 /**
2292 * Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
2293 */
2294 StoppingCondition: StoppingCondition;
2295 /**
2296 * A timestamp that indicates when the training job was created.
2297 */
2298 CreationTime: Timestamp;
2299 /**
2300 * Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
2301 */
2302 TrainingStartTime?: Timestamp;
2303 /**
2304 * Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
2305 */
2306 TrainingEndTime?: Timestamp;
2307 /**
2308 * A timestamp that indicates when the status of the training job was last modified.
2309 */
2310 LastModifiedTime?: Timestamp;
2311 /**
2312 * A history of all of the secondary statuses that the training job has transitioned through.
2313 */
2314 SecondaryStatusTransitions?: SecondaryStatusTransitions;
2315 /**
2316 * A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
2317 */
2318 FinalMetricDataList?: FinalMetricDataList;
2319 /**
2320 * If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation.
2321 */
2322 EnableNetworkIsolation?: Boolean;
2323 /**
2324 * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.
2325 */
2326 EnableInterContainerTrafficEncryption?: Boolean;
2327 /**
2328 * A Boolean indicating whether managed spot training is enabled (True) or not (False).
2329 */
2330 EnableManagedSpotTraining?: Boolean;
2331 CheckpointConfig?: CheckpointConfig;
2332 /**
2333 * The training time in seconds.
2334 */
2335 TrainingTimeInSeconds?: TrainingTimeInSeconds;
2336 /**
2337 * The billable time in seconds. You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.
2338 */
2339 BillableTimeInSeconds?: BillableTimeInSeconds;
2340 }
2341 export interface DescribeTransformJobRequest {
2342 /**
2343 * The name of the transform job that you want to view details of.
2344 */
2345 TransformJobName: TransformJobName;
2346 }
2347 export interface DescribeTransformJobResponse {
2348 /**
2349 * The name of the transform job.
2350 */
2351 TransformJobName: TransformJobName;
2352 /**
2353 * The Amazon Resource Name (ARN) of the transform job.
2354 */
2355 TransformJobArn: TransformJobArn;
2356 /**
2357 * The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
2358 */
2359 TransformJobStatus: TransformJobStatus;
2360 /**
2361 * If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.
2362 */
2363 FailureReason?: FailureReason;
2364 /**
2365 * The name of the model used in the transform job.
2366 */
2367 ModelName: ModelName;
2368 /**
2369 * The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
2370 */
2371 MaxConcurrentTransforms?: MaxConcurrentTransforms;
2372 /**
2373 * The maximum payload size, in MB, used in the transform job.
2374 */
2375 MaxPayloadInMB?: MaxPayloadInMB;
2376 /**
2377 * Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.
2378 */
2379 BatchStrategy?: BatchStrategy;
2380 /**
2381 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
2382 */
2383 Environment?: TransformEnvironmentMap;
2384 /**
2385 * Describes the dataset to be transformed and the Amazon S3 location where it is stored.
2386 */
2387 TransformInput: TransformInput;
2388 /**
2389 * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
2390 */
2391 TransformOutput?: TransformOutput;
2392 /**
2393 * Describes the resources, including ML instance types and ML instance count, to use for the transform job.
2394 */
2395 TransformResources: TransformResources;
2396 /**
2397 * A timestamp that shows when the transform Job was created.
2398 */
2399 CreationTime: Timestamp;
2400 /**
2401 * Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
2402 */
2403 TransformStartTime?: Timestamp;
2404 /**
2405 * Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.
2406 */
2407 TransformEndTime?: Timestamp;
2408 /**
2409 * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
2410 */
2411 LabelingJobArn?: LabelingJobArn;
2412 DataProcessing?: DataProcessing;
2413 }
2414 export interface DescribeWorkteamRequest {
2415 /**
2416 * The name of the work team to return a description of.
2417 */
2418 WorkteamName: WorkteamName;
2419 }
2420 export interface DescribeWorkteamResponse {
2421 /**
2422 * A Workteam instance that contains information about the work team.
2423 */
2424 Workteam: Workteam;
2425 }
2426 export interface DesiredWeightAndCapacity {
2427 /**
2428 * The name of the variant to update.
2429 */
2430 VariantName: VariantName;
2431 /**
2432 * The variant's weight.
2433 */
2434 DesiredWeight?: VariantWeight;
2435 /**
2436 * The variant's capacity.
2437 */
2438 DesiredInstanceCount?: TaskCount;
2439 }
2440 export type DesiredWeightAndCapacityList = DesiredWeightAndCapacity[];
2441 export type DetailedAlgorithmStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string;
2442 export type DetailedModelPackageStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string;
2443 export type DirectInternetAccess = "Enabled"|"Disabled"|string;
2444 export type DirectoryPath = string;
2445 export type DisassociateAdditionalCodeRepositories = boolean;
2446 export type DisassociateDefaultCodeRepository = boolean;
2447 export type DisassociateNotebookInstanceAcceleratorTypes = boolean;
2448 export type DisassociateNotebookInstanceLifecycleConfig = boolean;
2449 export type Dollars = number;
2450 export type EndpointArn = string;
2451 export type EndpointConfigArn = string;
2452 export type EndpointConfigName = string;
2453 export type EndpointConfigNameContains = string;
2454 export type EndpointConfigSortKey = "Name"|"CreationTime"|string;
2455 export interface EndpointConfigSummary {
2456 /**
2457 * The name of the endpoint configuration.
2458 */
2459 EndpointConfigName: EndpointConfigName;
2460 /**
2461 * The Amazon Resource Name (ARN) of the endpoint configuration.
2462 */
2463 EndpointConfigArn: EndpointConfigArn;
2464 /**
2465 * A timestamp that shows when the endpoint configuration was created.
2466 */
2467 CreationTime: Timestamp;
2468 }
2469 export type EndpointConfigSummaryList = EndpointConfigSummary[];
2470 export type EndpointName = string;
2471 export type EndpointNameContains = string;
2472 export type EndpointSortKey = "Name"|"CreationTime"|"Status"|string;
2473 export type EndpointStatus = "OutOfService"|"Creating"|"Updating"|"SystemUpdating"|"RollingBack"|"InService"|"Deleting"|"Failed"|string;
2474 export interface EndpointSummary {
2475 /**
2476 * The name of the endpoint.
2477 */
2478 EndpointName: EndpointName;
2479 /**
2480 * The Amazon Resource Name (ARN) of the endpoint.
2481 */
2482 EndpointArn: EndpointArn;
2483 /**
2484 * A timestamp that shows when the endpoint was created.
2485 */
2486 CreationTime: Timestamp;
2487 /**
2488 * A timestamp that shows when the endpoint was last modified.
2489 */
2490 LastModifiedTime: Timestamp;
2491 /**
2492 * The status of the endpoint. OutOfService: Endpoint is not available to take incoming requests. Creating: CreateEndpoint is executing. Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. InService: Endpoint is available to process incoming requests. Deleting: DeleteEndpoint is executing. Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.
2493 */
2494 EndpointStatus: EndpointStatus;
2495 }
2496 export type EndpointSummaryList = EndpointSummary[];
2497 export type EntityDescription = string;
2498 export type EntityName = string;
2499 export type EnvironmentKey = string;
2500 export type EnvironmentMap = {[key: string]: EnvironmentValue};
2501 export type EnvironmentValue = string;
2502 export type FailureReason = string;
2503 export type FileSystemAccessMode = "rw"|"ro"|string;
2504 export interface FileSystemDataSource {
2505 /**
2506 * The file system id.
2507 */
2508 FileSystemId: FileSystemId;
2509 /**
2510 * The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
2511 */
2512 FileSystemAccessMode: FileSystemAccessMode;
2513 /**
2514 * The file system type.
2515 */
2516 FileSystemType: FileSystemType;
2517 /**
2518 * The full path to the directory to associate with the channel.
2519 */
2520 DirectoryPath: DirectoryPath;
2521 }
2522 export type FileSystemId = string;
2523 export type FileSystemType = "EFS"|"FSxLustre"|string;
2524 export interface Filter {
2525 /**
2526 * A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
2527 */
2528 Name: ResourcePropertyName;
2529 /**
2530 * A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values: Equals The specified resource in Name equals the specified Value. NotEquals The specified resource in Name does not equal the specified Value. GreaterThan The specified resource in Name is greater than the specified Value. Not supported for text-based properties. GreaterThanOrEqualTo The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties. LessThan The specified resource in Name is less than the specified Value. Not supported for text-based properties. LessThanOrEqualTo The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties. Contains Only supported for text-based properties. The word-list of the property contains the specified Value. If you have specified a filter Value, the default is Equals.
2531 */
2532 Operator?: Operator;
2533 /**
2534 * A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
2535 */
2536 Value?: FilterValue;
2537 }
2538 export type FilterList = Filter[];
2539 export type FilterValue = string;
2540 export interface FinalHyperParameterTuningJobObjectiveMetric {
2541 /**
2542 * Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.
2543 */
2544 Type?: HyperParameterTuningJobObjectiveType;
2545 /**
2546 * The name of the objective metric.
2547 */
2548 MetricName: MetricName;
2549 /**
2550 * The value of the objective metric.
2551 */
2552 Value: MetricValue;
2553 }
2554 export type FinalMetricDataList = MetricData[];
2555 export type Float = number;
2556 export type Framework = "TENSORFLOW"|"MXNET"|"ONNX"|"PYTORCH"|"XGBOOST"|string;
2557 export interface GetSearchSuggestionsRequest {
2558 /**
2559 * The name of the Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob.
2560 */
2561 Resource: ResourceType;
2562 /**
2563 * Limits the property names that are included in the response.
2564 */
2565 SuggestionQuery?: SuggestionQuery;
2566 }
2567 export interface GetSearchSuggestionsResponse {
2568 /**
2569 * A list of property names for a Resource that match a SuggestionQuery.
2570 */
2571 PropertyNameSuggestions?: PropertyNameSuggestionList;
2572 }
2573 export interface GitConfig {
2574 /**
2575 * The URL where the Git repository is located.
2576 */
2577 RepositoryUrl: GitConfigUrl;
2578 /**
2579 * The default branch for the Git repository.
2580 */
2581 Branch?: Branch;
2582 /**
2583 * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password}
2584 */
2585 SecretArn?: SecretArn;
2586 }
2587 export interface GitConfigForUpdate {
2588 /**
2589 * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password}
2590 */
2591 SecretArn?: SecretArn;
2592 }
2593 export type GitConfigUrl = string;
2594 export interface HumanTaskConfig {
2595 /**
2596 * The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
2597 */
2598 WorkteamArn: WorkteamArn;
2599 /**
2600 * Information about the user interface that workers use to complete the labeling task.
2601 */
2602 UiConfig: UiConfig;
2603 /**
2604 * The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job. For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions: US East (Northern Virginia) (us-east-1): arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition US East (Ohio) (us-east-2): arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition US West (Oregon) (us-west-2): arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition Canada (Central) (ca-central-1): arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition EU (Ireland) (eu-west-1): arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition EU (London) (eu-west-2): arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition EU Frankfurt (eu-central-1): arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition Asia Pacific (Tokyo) (ap-northeast-1): arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition Asia Pacific (Seoul) (ap-northeast-2): arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition Asia Pacific (Mumbai) (ap-south-1): arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition Asia Pacific (Singapore) (ap-southeast-1): arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition Asia Pacific (Sydney) (ap-southeast-2): arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
2605 */
2606 PreHumanTaskLambdaArn: LambdaFunctionArn;
2607 /**
2608 * Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
2609 */
2610 TaskKeywords?: TaskKeywords;
2611 /**
2612 * A title for the task for your human workers.
2613 */
2614 TaskTitle: TaskTitle;
2615 /**
2616 * A description of the task for your human workers.
2617 */
2618 TaskDescription: TaskDescription;
2619 /**
2620 * The number of human workers that will label an object.
2621 */
2622 NumberOfHumanWorkersPerDataObject: NumberOfHumanWorkersPerDataObject;
2623 /**
2624 * The amount of time that a worker has to complete a task.
2625 */
2626 TaskTimeLimitInSeconds: TaskTimeLimitInSeconds;
2627 /**
2628 * The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.
2629 */
2630 TaskAvailabilityLifetimeInSeconds?: TaskAvailabilityLifetimeInSeconds;
2631 /**
2632 * Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.
2633 */
2634 MaxConcurrentTaskCount?: MaxConcurrentTaskCount;
2635 /**
2636 * Configures how labels are consolidated across human workers.
2637 */
2638 AnnotationConsolidationConfig: AnnotationConsolidationConfig;
2639 /**
2640 * The price that you pay for each task performed by an Amazon Mechanical Turk worker.
2641 */
2642 PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice;
2643 }
2644 export interface HyperParameterAlgorithmSpecification {
2645 /**
2646 * The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
2647 */
2648 TrainingImage?: AlgorithmImage;
2649 /**
2650 * The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container. If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information. For more information about input modes, see Algorithms.
2651 */
2652 TrainingInputMode: TrainingInputMode;
2653 /**
2654 * The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.
2655 */
2656 AlgorithmName?: ArnOrName;
2657 /**
2658 * An array of MetricDefinition objects that specify the metrics that the algorithm emits.
2659 */
2660 MetricDefinitions?: MetricDefinitionList;
2661 }
2662 export type HyperParameterScalingType = "Auto"|"Linear"|"Logarithmic"|"ReverseLogarithmic"|string;
2663 export interface HyperParameterSpecification {
2664 /**
2665 * The name of this hyperparameter. The name must be unique.
2666 */
2667 Name: ParameterName;
2668 /**
2669 * A brief description of the hyperparameter.
2670 */
2671 Description?: EntityDescription;
2672 /**
2673 * The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
2674 */
2675 Type: ParameterType;
2676 /**
2677 * The allowed range for this hyperparameter.
2678 */
2679 Range?: ParameterRange;
2680 /**
2681 * Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
2682 */
2683 IsTunable?: Boolean;
2684 /**
2685 * Indicates whether this hyperparameter is required.
2686 */
2687 IsRequired?: Boolean;
2688 /**
2689 * The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
2690 */
2691 DefaultValue?: ParameterValue;
2692 }
2693 export type HyperParameterSpecifications = HyperParameterSpecification[];
2694 export interface HyperParameterTrainingJobDefinition {
2695 /**
2696 * Specifies the values of hyperparameters that do not change for the tuning job.
2697 */
2698 StaticHyperParameters?: HyperParameters;
2699 /**
2700 * The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
2701 */
2702 AlgorithmSpecification: HyperParameterAlgorithmSpecification;
2703 /**
2704 * The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
2705 */
2706 RoleArn: RoleArn;
2707 /**
2708 * An array of Channel objects that specify the input for the training jobs that the tuning job launches.
2709 */
2710 InputDataConfig?: InputDataConfig;
2711 /**
2712 * The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
2713 */
2714 VpcConfig?: VpcConfig;
2715 /**
2716 * Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
2717 */
2718 OutputDataConfig: OutputDataConfig;
2719 /**
2720 * The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches. Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
2721 */
2722 ResourceConfig: ResourceConfig;
2723 /**
2724 * Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
2725 */
2726 StoppingCondition: StoppingCondition;
2727 /**
2728 * Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access. The Semantic Segmentation built-in algorithm does not support network isolation.
2729 */
2730 EnableNetworkIsolation?: Boolean;
2731 /**
2732 * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
2733 */
2734 EnableInterContainerTrafficEncryption?: Boolean;
2735 /**
2736 * A Boolean indicating whether managed spot training is enabled (True) or not (False).
2737 */
2738 EnableManagedSpotTraining?: Boolean;
2739 CheckpointConfig?: CheckpointConfig;
2740 }
2741 export type HyperParameterTrainingJobSummaries = HyperParameterTrainingJobSummary[];
2742 export interface HyperParameterTrainingJobSummary {
2743 /**
2744 * The name of the training job.
2745 */
2746 TrainingJobName: TrainingJobName;
2747 /**
2748 * The Amazon Resource Name (ARN) of the training job.
2749 */
2750 TrainingJobArn: TrainingJobArn;
2751 /**
2752 * The HyperParameter tuning job that launched the training job.
2753 */
2754 TuningJobName?: HyperParameterTuningJobName;
2755 /**
2756 * The date and time that the training job was created.
2757 */
2758 CreationTime: Timestamp;
2759 /**
2760 * The date and time that the training job started.
2761 */
2762 TrainingStartTime?: Timestamp;
2763 /**
2764 * Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
2765 */
2766 TrainingEndTime?: Timestamp;
2767 /**
2768 * The status of the training job.
2769 */
2770 TrainingJobStatus: TrainingJobStatus;
2771 /**
2772 * A list of the hyperparameters for which you specified ranges to search.
2773 */
2774 TunedHyperParameters: HyperParameters;
2775 /**
2776 * The reason that the training job failed.
2777 */
2778 FailureReason?: FailureReason;
2779 /**
2780 * The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
2781 */
2782 FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric;
2783 /**
2784 * The status of the objective metric for the training job: Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process. Pending: The training job is in progress and evaluation of its final objective metric is pending. Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
2785 */
2786 ObjectiveStatus?: ObjectiveStatus;
2787 }
2788 export type HyperParameterTuningJobArn = string;
2789 export interface HyperParameterTuningJobConfig {
2790 /**
2791 * Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.
2792 */
2793 Strategy: HyperParameterTuningJobStrategyType;
2794 /**
2795 * The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
2796 */
2797 HyperParameterTuningJobObjective?: HyperParameterTuningJobObjective;
2798 /**
2799 * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
2800 */
2801 ResourceLimits: ResourceLimits;
2802 /**
2803 * The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
2804 */
2805 ParameterRanges?: ParameterRanges;
2806 /**
2807 * Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF): OFF Training jobs launched by the hyperparameter tuning job do not use early stopping. AUTO Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
2808 */
2809 TrainingJobEarlyStoppingType?: TrainingJobEarlyStoppingType;
2810 }
2811 export type HyperParameterTuningJobName = string;
2812 export interface HyperParameterTuningJobObjective {
2813 /**
2814 * Whether to minimize or maximize the objective metric.
2815 */
2816 Type: HyperParameterTuningJobObjectiveType;
2817 /**
2818 * The name of the metric to use for the objective metric.
2819 */
2820 MetricName: MetricName;
2821 }
2822 export type HyperParameterTuningJobObjectiveType = "Maximize"|"Minimize"|string;
2823 export type HyperParameterTuningJobObjectives = HyperParameterTuningJobObjective[];
2824 export type HyperParameterTuningJobSortByOptions = "Name"|"Status"|"CreationTime"|string;
2825 export type HyperParameterTuningJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string;
2826 export type HyperParameterTuningJobStrategyType = "Bayesian"|"Random"|string;
2827 export type HyperParameterTuningJobSummaries = HyperParameterTuningJobSummary[];
2828 export interface HyperParameterTuningJobSummary {
2829 /**
2830 * The name of the tuning job.
2831 */
2832 HyperParameterTuningJobName: HyperParameterTuningJobName;
2833 /**
2834 * The Amazon Resource Name (ARN) of the tuning job.
2835 */
2836 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
2837 /**
2838 * The status of the tuning job.
2839 */
2840 HyperParameterTuningJobStatus: HyperParameterTuningJobStatus;
2841 /**
2842 * Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
2843 */
2844 Strategy: HyperParameterTuningJobStrategyType;
2845 /**
2846 * The date and time that the tuning job was created.
2847 */
2848 CreationTime: Timestamp;
2849 /**
2850 * The date and time that the tuning job ended.
2851 */
2852 HyperParameterTuningEndTime?: Timestamp;
2853 /**
2854 * The date and time that the tuning job was modified.
2855 */
2856 LastModifiedTime?: Timestamp;
2857 /**
2858 * The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
2859 */
2860 TrainingJobStatusCounters: TrainingJobStatusCounters;
2861 /**
2862 * The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
2863 */
2864 ObjectiveStatusCounters: ObjectiveStatusCounters;
2865 /**
2866 * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
2867 */
2868 ResourceLimits?: ResourceLimits;
2869 }
2870 export interface HyperParameterTuningJobWarmStartConfig {
2871 /**
2872 * An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point. Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.
2873 */
2874 ParentHyperParameterTuningJobs: ParentHyperParameterTuningJobs;
2875 /**
2876 * Specifies one of the following: IDENTICAL_DATA_AND_ALGORITHM The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs. TRANSFER_LEARNING The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
2877 */
2878 WarmStartType: HyperParameterTuningJobWarmStartType;
2879 }
2880 export type HyperParameterTuningJobWarmStartType = "IdenticalDataAndAlgorithm"|"TransferLearning"|string;
2881 export type HyperParameters = {[key: string]: ParameterValue};
2882 export type Image = string;
2883 export type ImageDigest = string;
2884 export interface InferenceSpecification {
2885 /**
2886 * The Amazon ECR registry path of the Docker image that contains the inference code.
2887 */
2888 Containers: ModelPackageContainerDefinitionList;
2889 /**
2890 * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
2891 */
2892 SupportedTransformInstanceTypes: TransformInstanceTypes;
2893 /**
2894 * A list of the instance types that are used to generate inferences in real-time.
2895 */
2896 SupportedRealtimeInferenceInstanceTypes: RealtimeInferenceInstanceTypes;
2897 /**
2898 * The supported MIME types for the input data.
2899 */
2900 SupportedContentTypes: ContentTypes;
2901 /**
2902 * The supported MIME types for the output data.
2903 */
2904 SupportedResponseMIMETypes: ResponseMIMETypes;
2905 }
2906 export interface InputConfig {
2907 /**
2908 * The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
2909 */
2910 S3Uri: S3Uri;
2911 /**
2912 * Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific. TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input":[1,1024,1024,3]} If using the CLI, {\"input\":[1,1024,1024,3]} Examples for two inputs: If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]} If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]} MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"data":[1,3,1024,1024]} If using the CLI, {\"data\":[1,3,1024,1024]} Examples for two inputs: If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]} If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same. Examples for one input in dictionary format: If using the console, {"input0":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224]} Example for one input in list format: [[1,3,224,224]] Examples for two inputs in dictionary format: If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]} If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]] XGBOOST: input data name and shape are not needed.
2913 */
2914 DataInputConfig: DataInputConfig;
2915 /**
2916 * Identifies the framework in which the model was trained. For example: TENSORFLOW.
2917 */
2918 Framework: Framework;
2919 }
2920 export type InputDataConfig = Channel[];
2921 export type InputModes = TrainingInputMode[];
2922 export type InstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5d.xlarge"|"ml.c5d.2xlarge"|"ml.c5d.4xlarge"|"ml.c5d.9xlarge"|"ml.c5d.18xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|string;
2923 export interface IntegerParameterRange {
2924 /**
2925 * The name of the hyperparameter to search.
2926 */
2927 Name: ParameterKey;
2928 /**
2929 * The minimum value of the hyperparameter to search.
2930 */
2931 MinValue: ParameterValue;
2932 /**
2933 * The maximum value of the hyperparameter to search.
2934 */
2935 MaxValue: ParameterValue;
2936 /**
2937 * The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0.
2938 */
2939 ScalingType?: HyperParameterScalingType;
2940 }
2941 export interface IntegerParameterRangeSpecification {
2942 /**
2943 * The minimum integer value allowed.
2944 */
2945 MinValue: ParameterValue;
2946 /**
2947 * The maximum integer value allowed.
2948 */
2949 MaxValue: ParameterValue;
2950 }
2951 export type IntegerParameterRanges = IntegerParameterRange[];
2952 export type JobReferenceCode = string;
2953 export type JobReferenceCodeContains = string;
2954 export type JoinSource = "Input"|"None"|string;
2955 export type JsonPath = string;
2956 export type KmsKeyId = string;
2957 export type LabelAttributeName = string;
2958 export type LabelCounter = number;
2959 export interface LabelCounters {
2960 /**
2961 * The total number of objects labeled.
2962 */
2963 TotalLabeled?: LabelCounter;
2964 /**
2965 * The total number of objects labeled by a human worker.
2966 */
2967 HumanLabeled?: LabelCounter;
2968 /**
2969 * The total number of objects labeled by automated data labeling.
2970 */
2971 MachineLabeled?: LabelCounter;
2972 /**
2973 * The total number of objects that could not be labeled due to an error.
2974 */
2975 FailedNonRetryableError?: LabelCounter;
2976 /**
2977 * The total number of objects not yet labeled.
2978 */
2979 Unlabeled?: LabelCounter;
2980 }
2981 export interface LabelCountersForWorkteam {
2982 /**
2983 * The total number of data objects labeled by a human worker.
2984 */
2985 HumanLabeled?: LabelCounter;
2986 /**
2987 * The total number of data objects that need to be labeled by a human worker.
2988 */
2989 PendingHuman?: LabelCounter;
2990 /**
2991 * The total number of tasks in the labeling job.
2992 */
2993 Total?: LabelCounter;
2994 }
2995 export type LabelingJobAlgorithmSpecificationArn = string;
2996 export interface LabelingJobAlgorithmsConfig {
2997 /**
2998 * Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs: Image classification arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification Text classification arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification Object detection arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection Semantic Segmentation arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation
2999 */
3000 LabelingJobAlgorithmSpecificationArn: LabelingJobAlgorithmSpecificationArn;
3001 /**
3002 * At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.
3003 */
3004 InitialActiveLearningModelArn?: ModelArn;
3005 /**
3006 * Provides configuration information for a labeling job.
3007 */
3008 LabelingJobResourceConfig?: LabelingJobResourceConfig;
3009 }
3010 export type LabelingJobArn = string;
3011 export interface LabelingJobDataAttributes {
3012 /**
3013 * Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
3014 */
3015 ContentClassifiers?: ContentClassifiers;
3016 }
3017 export interface LabelingJobDataSource {
3018 /**
3019 * The Amazon S3 location of the input data objects.
3020 */
3021 S3DataSource: LabelingJobS3DataSource;
3022 }
3023 export interface LabelingJobForWorkteamSummary {
3024 /**
3025 * The name of the labeling job that the work team is assigned to.
3026 */
3027 LabelingJobName?: LabelingJobName;
3028 /**
3029 * A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
3030 */
3031 JobReferenceCode: JobReferenceCode;
3032 /**
3033 *
3034 */
3035 WorkRequesterAccountId: AccountId;
3036 /**
3037 * The date and time that the labeling job was created.
3038 */
3039 CreationTime: Timestamp;
3040 /**
3041 * Provides information about the progress of a labeling job.
3042 */
3043 LabelCounters?: LabelCountersForWorkteam;
3044 /**
3045 * The configured number of workers per data object.
3046 */
3047 NumberOfHumanWorkersPerDataObject?: NumberOfHumanWorkersPerDataObject;
3048 }
3049 export type LabelingJobForWorkteamSummaryList = LabelingJobForWorkteamSummary[];
3050 export interface LabelingJobInputConfig {
3051 /**
3052 * The location of the input data.
3053 */
3054 DataSource: LabelingJobDataSource;
3055 /**
3056 * Attributes of the data specified by the customer.
3057 */
3058 DataAttributes?: LabelingJobDataAttributes;
3059 }
3060 export type LabelingJobName = string;
3061 export interface LabelingJobOutput {
3062 /**
3063 * The Amazon S3 bucket location of the manifest file for labeled data.
3064 */
3065 OutputDatasetS3Uri: S3Uri;
3066 /**
3067 * The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.
3068 */
3069 FinalActiveLearningModelArn?: ModelArn;
3070 }
3071 export interface LabelingJobOutputConfig {
3072 /**
3073 * The Amazon S3 location to write output data.
3074 */
3075 S3OutputPath: S3Uri;
3076 /**
3077 * The AWS Key Management Service ID of the key used to encrypt the output data, if any. If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
3078 */
3079 KmsKeyId?: KmsKeyId;
3080 }
3081 export interface LabelingJobResourceConfig {
3082 /**
3083 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
3084 */
3085 VolumeKmsKeyId?: KmsKeyId;
3086 }
3087 export interface LabelingJobS3DataSource {
3088 /**
3089 * The Amazon S3 location of the manifest file that describes the input data objects.
3090 */
3091 ManifestS3Uri: S3Uri;
3092 }
3093 export type LabelingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
3094 export interface LabelingJobStoppingConditions {
3095 /**
3096 * The maximum number of objects that can be labeled by human workers.
3097 */
3098 MaxHumanLabeledObjectCount?: MaxHumanLabeledObjectCount;
3099 /**
3100 * The maximum number of input data objects that should be labeled.
3101 */
3102 MaxPercentageOfInputDatasetLabeled?: MaxPercentageOfInputDatasetLabeled;
3103 }
3104 export interface LabelingJobSummary {
3105 /**
3106 * The name of the labeling job.
3107 */
3108 LabelingJobName: LabelingJobName;
3109 /**
3110 * The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
3111 */
3112 LabelingJobArn: LabelingJobArn;
3113 /**
3114 * The date and time that the job was created (timestamp).
3115 */
3116 CreationTime: Timestamp;
3117 /**
3118 * The date and time that the job was last modified (timestamp).
3119 */
3120 LastModifiedTime: Timestamp;
3121 /**
3122 * The current status of the labeling job.
3123 */
3124 LabelingJobStatus: LabelingJobStatus;
3125 /**
3126 * Counts showing the progress of the labeling job.
3127 */
3128 LabelCounters: LabelCounters;
3129 /**
3130 * The Amazon Resource Name (ARN) of the work team assigned to the job.
3131 */
3132 WorkteamArn: WorkteamArn;
3133 /**
3134 * The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
3135 */
3136 PreHumanTaskLambdaArn: LambdaFunctionArn;
3137 /**
3138 * The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.
3139 */
3140 AnnotationConsolidationLambdaArn?: LambdaFunctionArn;
3141 /**
3142 * If the LabelingJobStatus field is Failed, this field contains a description of the error.
3143 */
3144 FailureReason?: FailureReason;
3145 /**
3146 * The location of the output produced by the labeling job.
3147 */
3148 LabelingJobOutput?: LabelingJobOutput;
3149 /**
3150 * Input configuration for the labeling job.
3151 */
3152 InputConfig?: LabelingJobInputConfig;
3153 }
3154 export type LabelingJobSummaryList = LabelingJobSummary[];
3155 export type LambdaFunctionArn = string;
3156 export type LastModifiedTime = Date;
3157 export interface ListAlgorithmsInput {
3158 /**
3159 * A filter that returns only algorithms created after the specified time (timestamp).
3160 */
3161 CreationTimeAfter?: CreationTime;
3162 /**
3163 * A filter that returns only algorithms created before the specified time (timestamp).
3164 */
3165 CreationTimeBefore?: CreationTime;
3166 /**
3167 * The maximum number of algorithms to return in the response.
3168 */
3169 MaxResults?: MaxResults;
3170 /**
3171 * A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
3172 */
3173 NameContains?: NameContains;
3174 /**
3175 * If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.
3176 */
3177 NextToken?: NextToken;
3178 /**
3179 * The parameter by which to sort the results. The default is CreationTime.
3180 */
3181 SortBy?: AlgorithmSortBy;
3182 /**
3183 * The sort order for the results. The default is Ascending.
3184 */
3185 SortOrder?: SortOrder;
3186 }
3187 export interface ListAlgorithmsOutput {
3188 /**
3189 * &gt;An array of AlgorithmSummary objects, each of which lists an algorithm.
3190 */
3191 AlgorithmSummaryList: AlgorithmSummaryList;
3192 /**
3193 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
3194 */
3195 NextToken?: NextToken;
3196 }
3197 export interface ListCodeRepositoriesInput {
3198 /**
3199 * A filter that returns only Git repositories that were created after the specified time.
3200 */
3201 CreationTimeAfter?: CreationTime;
3202 /**
3203 * A filter that returns only Git repositories that were created before the specified time.
3204 */
3205 CreationTimeBefore?: CreationTime;
3206 /**
3207 * A filter that returns only Git repositories that were last modified after the specified time.
3208 */
3209 LastModifiedTimeAfter?: Timestamp;
3210 /**
3211 * A filter that returns only Git repositories that were last modified before the specified time.
3212 */
3213 LastModifiedTimeBefore?: Timestamp;
3214 /**
3215 * The maximum number of Git repositories to return in the response.
3216 */
3217 MaxResults?: MaxResults;
3218 /**
3219 * A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
3220 */
3221 NameContains?: CodeRepositoryNameContains;
3222 /**
3223 * If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.
3224 */
3225 NextToken?: NextToken;
3226 /**
3227 * The field to sort results by. The default is Name.
3228 */
3229 SortBy?: CodeRepositorySortBy;
3230 /**
3231 * The sort order for results. The default is Ascending.
3232 */
3233 SortOrder?: CodeRepositorySortOrder;
3234 }
3235 export interface ListCodeRepositoriesOutput {
3236 /**
3237 * Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository: Name Amazon Resource Name (ARN) Creation time Last modified time Configuration information, including the URL location of the repository and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.
3238 */
3239 CodeRepositorySummaryList: CodeRepositorySummaryList;
3240 /**
3241 * If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.
3242 */
3243 NextToken?: NextToken;
3244 }
3245 export interface ListCompilationJobsRequest {
3246 /**
3247 * If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.
3248 */
3249 NextToken?: NextToken;
3250 /**
3251 * The maximum number of model compilation jobs to return in the response.
3252 */
3253 MaxResults?: MaxResults;
3254 /**
3255 * A filter that returns the model compilation jobs that were created after a specified time.
3256 */
3257 CreationTimeAfter?: CreationTime;
3258 /**
3259 * A filter that returns the model compilation jobs that were created before a specified time.
3260 */
3261 CreationTimeBefore?: CreationTime;
3262 /**
3263 * A filter that returns the model compilation jobs that were modified after a specified time.
3264 */
3265 LastModifiedTimeAfter?: LastModifiedTime;
3266 /**
3267 * A filter that returns the model compilation jobs that were modified before a specified time.
3268 */
3269 LastModifiedTimeBefore?: LastModifiedTime;
3270 /**
3271 * A filter that returns the model compilation jobs whose name contains a specified string.
3272 */
3273 NameContains?: NameContains;
3274 /**
3275 * A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.
3276 */
3277 StatusEquals?: CompilationJobStatus;
3278 /**
3279 * The field by which to sort results. The default is CreationTime.
3280 */
3281 SortBy?: ListCompilationJobsSortBy;
3282 /**
3283 * The sort order for results. The default is Ascending.
3284 */
3285 SortOrder?: SortOrder;
3286 }
3287 export interface ListCompilationJobsResponse {
3288 /**
3289 * An array of CompilationJobSummary objects, each describing a model compilation job.
3290 */
3291 CompilationJobSummaries: CompilationJobSummaries;
3292 /**
3293 * If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
3294 */
3295 NextToken?: NextToken;
3296 }
3297 export type ListCompilationJobsSortBy = "Name"|"CreationTime"|"Status"|string;
3298 export interface ListEndpointConfigsInput {
3299 /**
3300 * The field to sort results by. The default is CreationTime.
3301 */
3302 SortBy?: EndpointConfigSortKey;
3303 /**
3304 * The sort order for results. The default is Descending.
3305 */
3306 SortOrder?: OrderKey;
3307 /**
3308 * If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.
3309 */
3310 NextToken?: PaginationToken;
3311 /**
3312 * The maximum number of training jobs to return in the response.
3313 */
3314 MaxResults?: MaxResults;
3315 /**
3316 * A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
3317 */
3318 NameContains?: EndpointConfigNameContains;
3319 /**
3320 * A filter that returns only endpoint configurations created before the specified time (timestamp).
3321 */
3322 CreationTimeBefore?: Timestamp;
3323 /**
3324 * A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
3325 */
3326 CreationTimeAfter?: Timestamp;
3327 }
3328 export interface ListEndpointConfigsOutput {
3329 /**
3330 * An array of endpoint configurations.
3331 */
3332 EndpointConfigs: EndpointConfigSummaryList;
3333 /**
3334 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
3335 */
3336 NextToken?: PaginationToken;
3337 }
3338 export interface ListEndpointsInput {
3339 /**
3340 * Sorts the list of results. The default is CreationTime.
3341 */
3342 SortBy?: EndpointSortKey;
3343 /**
3344 * The sort order for results. The default is Descending.
3345 */
3346 SortOrder?: OrderKey;
3347 /**
3348 * If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.
3349 */
3350 NextToken?: PaginationToken;
3351 /**
3352 * The maximum number of endpoints to return in the response.
3353 */
3354 MaxResults?: MaxResults;
3355 /**
3356 * A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
3357 */
3358 NameContains?: EndpointNameContains;
3359 /**
3360 * A filter that returns only endpoints that were created before the specified time (timestamp).
3361 */
3362 CreationTimeBefore?: Timestamp;
3363 /**
3364 * A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
3365 */
3366 CreationTimeAfter?: Timestamp;
3367 /**
3368 * A filter that returns only endpoints that were modified before the specified timestamp.
3369 */
3370 LastModifiedTimeBefore?: Timestamp;
3371 /**
3372 * A filter that returns only endpoints that were modified after the specified timestamp.
3373 */
3374 LastModifiedTimeAfter?: Timestamp;
3375 /**
3376 * A filter that returns only endpoints with the specified status.
3377 */
3378 StatusEquals?: EndpointStatus;
3379 }
3380 export interface ListEndpointsOutput {
3381 /**
3382 * An array or endpoint objects.
3383 */
3384 Endpoints: EndpointSummaryList;
3385 /**
3386 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
3387 */
3388 NextToken?: PaginationToken;
3389 }
3390 export interface ListHyperParameterTuningJobsRequest {
3391 /**
3392 * If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
3393 */
3394 NextToken?: NextToken;
3395 /**
3396 * The maximum number of tuning jobs to return. The default value is 10.
3397 */
3398 MaxResults?: MaxResults;
3399 /**
3400 * The field to sort results by. The default is Name.
3401 */
3402 SortBy?: HyperParameterTuningJobSortByOptions;
3403 /**
3404 * The sort order for results. The default is Ascending.
3405 */
3406 SortOrder?: SortOrder;
3407 /**
3408 * A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
3409 */
3410 NameContains?: NameContains;
3411 /**
3412 * A filter that returns only tuning jobs that were created after the specified time.
3413 */
3414 CreationTimeAfter?: Timestamp;
3415 /**
3416 * A filter that returns only tuning jobs that were created before the specified time.
3417 */
3418 CreationTimeBefore?: Timestamp;
3419 /**
3420 * A filter that returns only tuning jobs that were modified after the specified time.
3421 */
3422 LastModifiedTimeAfter?: Timestamp;
3423 /**
3424 * A filter that returns only tuning jobs that were modified before the specified time.
3425 */
3426 LastModifiedTimeBefore?: Timestamp;
3427 /**
3428 * A filter that returns only tuning jobs with the specified status.
3429 */
3430 StatusEquals?: HyperParameterTuningJobStatus;
3431 }
3432 export interface ListHyperParameterTuningJobsResponse {
3433 /**
3434 * A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
3435 */
3436 HyperParameterTuningJobSummaries: HyperParameterTuningJobSummaries;
3437 /**
3438 * If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
3439 */
3440 NextToken?: NextToken;
3441 }
3442 export interface ListLabelingJobsForWorkteamRequest {
3443 /**
3444 * The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
3445 */
3446 WorkteamArn: WorkteamArn;
3447 /**
3448 * The maximum number of labeling jobs to return in each page of the response.
3449 */
3450 MaxResults?: MaxResults;
3451 /**
3452 * If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
3453 */
3454 NextToken?: NextToken;
3455 /**
3456 * A filter that returns only labeling jobs created after the specified time (timestamp).
3457 */
3458 CreationTimeAfter?: Timestamp;
3459 /**
3460 * A filter that returns only labeling jobs created before the specified time (timestamp).
3461 */
3462 CreationTimeBefore?: Timestamp;
3463 /**
3464 * A filter the limits jobs to only the ones whose job reference code contains the specified string.
3465 */
3466 JobReferenceCodeContains?: JobReferenceCodeContains;
3467 /**
3468 * The field to sort results by. The default is CreationTime.
3469 */
3470 SortBy?: ListLabelingJobsForWorkteamSortByOptions;
3471 /**
3472 * The sort order for results. The default is Ascending.
3473 */
3474 SortOrder?: SortOrder;
3475 }
3476 export interface ListLabelingJobsForWorkteamResponse {
3477 /**
3478 * An array of LabelingJobSummary objects, each describing a labeling job.
3479 */
3480 LabelingJobSummaryList: LabelingJobForWorkteamSummaryList;
3481 /**
3482 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
3483 */
3484 NextToken?: NextToken;
3485 }
3486 export type ListLabelingJobsForWorkteamSortByOptions = "CreationTime"|string;
3487 export interface ListLabelingJobsRequest {
3488 /**
3489 * A filter that returns only labeling jobs created after the specified time (timestamp).
3490 */
3491 CreationTimeAfter?: Timestamp;
3492 /**
3493 * A filter that returns only labeling jobs created before the specified time (timestamp).
3494 */
3495 CreationTimeBefore?: Timestamp;
3496 /**
3497 * A filter that returns only labeling jobs modified after the specified time (timestamp).
3498 */
3499 LastModifiedTimeAfter?: Timestamp;
3500 /**
3501 * A filter that returns only labeling jobs modified before the specified time (timestamp).
3502 */
3503 LastModifiedTimeBefore?: Timestamp;
3504 /**
3505 * The maximum number of labeling jobs to return in each page of the response.
3506 */
3507 MaxResults?: MaxResults;
3508 /**
3509 * If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
3510 */
3511 NextToken?: NextToken;
3512 /**
3513 * A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
3514 */
3515 NameContains?: NameContains;
3516 /**
3517 * The field to sort results by. The default is CreationTime.
3518 */
3519 SortBy?: SortBy;
3520 /**
3521 * The sort order for results. The default is Ascending.
3522 */
3523 SortOrder?: SortOrder;
3524 /**
3525 * A filter that retrieves only labeling jobs with a specific status.
3526 */
3527 StatusEquals?: LabelingJobStatus;
3528 }
3529 export interface ListLabelingJobsResponse {
3530 /**
3531 * An array of LabelingJobSummary objects, each describing a labeling job.
3532 */
3533 LabelingJobSummaryList?: LabelingJobSummaryList;
3534 /**
3535 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
3536 */
3537 NextToken?: NextToken;
3538 }
3539 export interface ListModelPackagesInput {
3540 /**
3541 * A filter that returns only model packages created after the specified time (timestamp).
3542 */
3543 CreationTimeAfter?: CreationTime;
3544 /**
3545 * A filter that returns only model packages created before the specified time (timestamp).
3546 */
3547 CreationTimeBefore?: CreationTime;
3548 /**
3549 * The maximum number of model packages to return in the response.
3550 */
3551 MaxResults?: MaxResults;
3552 /**
3553 * A string in the model package name. This filter returns only model packages whose name contains the specified string.
3554 */
3555 NameContains?: NameContains;
3556 /**
3557 * If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.
3558 */
3559 NextToken?: NextToken;
3560 /**
3561 * The parameter by which to sort the results. The default is CreationTime.
3562 */
3563 SortBy?: ModelPackageSortBy;
3564 /**
3565 * The sort order for the results. The default is Ascending.
3566 */
3567 SortOrder?: SortOrder;
3568 }
3569 export interface ListModelPackagesOutput {
3570 /**
3571 * An array of ModelPackageSummary objects, each of which lists a model package.
3572 */
3573 ModelPackageSummaryList: ModelPackageSummaryList;
3574 /**
3575 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
3576 */
3577 NextToken?: NextToken;
3578 }
3579 export interface ListModelsInput {
3580 /**
3581 * Sorts the list of results. The default is CreationTime.
3582 */
3583 SortBy?: ModelSortKey;
3584 /**
3585 * The sort order for results. The default is Descending.
3586 */
3587 SortOrder?: OrderKey;
3588 /**
3589 * If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
3590 */
3591 NextToken?: PaginationToken;
3592 /**
3593 * The maximum number of models to return in the response.
3594 */
3595 MaxResults?: MaxResults;
3596 /**
3597 * A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
3598 */
3599 NameContains?: ModelNameContains;
3600 /**
3601 * A filter that returns only models created before the specified time (timestamp).
3602 */
3603 CreationTimeBefore?: Timestamp;
3604 /**
3605 * A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
3606 */
3607 CreationTimeAfter?: Timestamp;
3608 }
3609 export interface ListModelsOutput {
3610 /**
3611 * An array of ModelSummary objects, each of which lists a model.
3612 */
3613 Models: ModelSummaryList;
3614 /**
3615 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
3616 */
3617 NextToken?: PaginationToken;
3618 }
3619 export interface ListNotebookInstanceLifecycleConfigsInput {
3620 /**
3621 * If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.
3622 */
3623 NextToken?: NextToken;
3624 /**
3625 * The maximum number of lifecycle configurations to return in the response.
3626 */
3627 MaxResults?: MaxResults;
3628 /**
3629 * Sorts the list of results. The default is CreationTime.
3630 */
3631 SortBy?: NotebookInstanceLifecycleConfigSortKey;
3632 /**
3633 * The sort order for results.
3634 */
3635 SortOrder?: NotebookInstanceLifecycleConfigSortOrder;
3636 /**
3637 * A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
3638 */
3639 NameContains?: NotebookInstanceLifecycleConfigNameContains;
3640 /**
3641 * A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
3642 */
3643 CreationTimeBefore?: CreationTime;
3644 /**
3645 * A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
3646 */
3647 CreationTimeAfter?: CreationTime;
3648 /**
3649 * A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
3650 */
3651 LastModifiedTimeBefore?: LastModifiedTime;
3652 /**
3653 * A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
3654 */
3655 LastModifiedTimeAfter?: LastModifiedTime;
3656 }
3657 export interface ListNotebookInstanceLifecycleConfigsOutput {
3658 /**
3659 * If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
3660 */
3661 NextToken?: NextToken;
3662 /**
3663 * An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
3664 */
3665 NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummaryList;
3666 }
3667 export interface ListNotebookInstancesInput {
3668 /**
3669 * If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances. You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
3670 */
3671 NextToken?: NextToken;
3672 /**
3673 * The maximum number of notebook instances to return.
3674 */
3675 MaxResults?: MaxResults;
3676 /**
3677 * The field to sort results by. The default is Name.
3678 */
3679 SortBy?: NotebookInstanceSortKey;
3680 /**
3681 * The sort order for results.
3682 */
3683 SortOrder?: NotebookInstanceSortOrder;
3684 /**
3685 * A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
3686 */
3687 NameContains?: NotebookInstanceNameContains;
3688 /**
3689 * A filter that returns only notebook instances that were created before the specified time (timestamp).
3690 */
3691 CreationTimeBefore?: CreationTime;
3692 /**
3693 * A filter that returns only notebook instances that were created after the specified time (timestamp).
3694 */
3695 CreationTimeAfter?: CreationTime;
3696 /**
3697 * A filter that returns only notebook instances that were modified before the specified time (timestamp).
3698 */
3699 LastModifiedTimeBefore?: LastModifiedTime;
3700 /**
3701 * A filter that returns only notebook instances that were modified after the specified time (timestamp).
3702 */
3703 LastModifiedTimeAfter?: LastModifiedTime;
3704 /**
3705 * A filter that returns only notebook instances with the specified status.
3706 */
3707 StatusEquals?: NotebookInstanceStatus;
3708 /**
3709 * A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
3710 */
3711 NotebookInstanceLifecycleConfigNameContains?: NotebookInstanceLifecycleConfigName;
3712 /**
3713 * A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.
3714 */
3715 DefaultCodeRepositoryContains?: CodeRepositoryContains;
3716 /**
3717 * A filter that returns only notebook instances with associated with the specified git repository.
3718 */
3719 AdditionalCodeRepositoryEquals?: CodeRepositoryNameOrUrl;
3720 }
3721 export interface ListNotebookInstancesOutput {
3722 /**
3723 * If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.
3724 */
3725 NextToken?: NextToken;
3726 /**
3727 * An array of NotebookInstanceSummary objects, one for each notebook instance.
3728 */
3729 NotebookInstances?: NotebookInstanceSummaryList;
3730 }
3731 export interface ListSubscribedWorkteamsRequest {
3732 /**
3733 * A string in the work team name. This filter returns only work teams whose name contains the specified string.
3734 */
3735 NameContains?: WorkteamName;
3736 /**
3737 * If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
3738 */
3739 NextToken?: NextToken;
3740 /**
3741 * The maximum number of work teams to return in each page of the response.
3742 */
3743 MaxResults?: MaxResults;
3744 }
3745 export interface ListSubscribedWorkteamsResponse {
3746 /**
3747 * An array of Workteam objects, each describing a work team.
3748 */
3749 SubscribedWorkteams: SubscribedWorkteams;
3750 /**
3751 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
3752 */
3753 NextToken?: NextToken;
3754 }
3755 export interface ListTagsInput {
3756 /**
3757 * The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
3758 */
3759 ResourceArn: ResourceArn;
3760 /**
3761 * If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.
3762 */
3763 NextToken?: NextToken;
3764 /**
3765 * Maximum number of tags to return.
3766 */
3767 MaxResults?: ListTagsMaxResults;
3768 }
3769 export type ListTagsMaxResults = number;
3770 export interface ListTagsOutput {
3771 /**
3772 * An array of Tag objects, each with a tag key and a value.
3773 */
3774 Tags?: TagList;
3775 /**
3776 * If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.
3777 */
3778 NextToken?: NextToken;
3779 }
3780 export interface ListTrainingJobsForHyperParameterTuningJobRequest {
3781 /**
3782 * The name of the tuning job whose training jobs you want to list.
3783 */
3784 HyperParameterTuningJobName: HyperParameterTuningJobName;
3785 /**
3786 * If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
3787 */
3788 NextToken?: NextToken;
3789 /**
3790 * The maximum number of training jobs to return. The default value is 10.
3791 */
3792 MaxResults?: MaxResults;
3793 /**
3794 * A filter that returns only training jobs with the specified status.
3795 */
3796 StatusEquals?: TrainingJobStatus;
3797 /**
3798 * The field to sort results by. The default is Name. If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
3799 */
3800 SortBy?: TrainingJobSortByOptions;
3801 /**
3802 * The sort order for results. The default is Ascending.
3803 */
3804 SortOrder?: SortOrder;
3805 }
3806 export interface ListTrainingJobsForHyperParameterTuningJobResponse {
3807 /**
3808 * A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
3809 */
3810 TrainingJobSummaries: HyperParameterTrainingJobSummaries;
3811 /**
3812 * If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
3813 */
3814 NextToken?: NextToken;
3815 }
3816 export interface ListTrainingJobsRequest {
3817 /**
3818 * If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
3819 */
3820 NextToken?: NextToken;
3821 /**
3822 * The maximum number of training jobs to return in the response.
3823 */
3824 MaxResults?: MaxResults;
3825 /**
3826 * A filter that returns only training jobs created after the specified time (timestamp).
3827 */
3828 CreationTimeAfter?: Timestamp;
3829 /**
3830 * A filter that returns only training jobs created before the specified time (timestamp).
3831 */
3832 CreationTimeBefore?: Timestamp;
3833 /**
3834 * A filter that returns only training jobs modified after the specified time (timestamp).
3835 */
3836 LastModifiedTimeAfter?: Timestamp;
3837 /**
3838 * A filter that returns only training jobs modified before the specified time (timestamp).
3839 */
3840 LastModifiedTimeBefore?: Timestamp;
3841 /**
3842 * A string in the training job name. This filter returns only training jobs whose name contains the specified string.
3843 */
3844 NameContains?: NameContains;
3845 /**
3846 * A filter that retrieves only training jobs with a specific status.
3847 */
3848 StatusEquals?: TrainingJobStatus;
3849 /**
3850 * The field to sort results by. The default is CreationTime.
3851 */
3852 SortBy?: SortBy;
3853 /**
3854 * The sort order for results. The default is Ascending.
3855 */
3856 SortOrder?: SortOrder;
3857 }
3858 export interface ListTrainingJobsResponse {
3859 /**
3860 * An array of TrainingJobSummary objects, each listing a training job.
3861 */
3862 TrainingJobSummaries: TrainingJobSummaries;
3863 /**
3864 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
3865 */
3866 NextToken?: NextToken;
3867 }
3868 export interface ListTransformJobsRequest {
3869 /**
3870 * A filter that returns only transform jobs created after the specified time.
3871 */
3872 CreationTimeAfter?: Timestamp;
3873 /**
3874 * A filter that returns only transform jobs created before the specified time.
3875 */
3876 CreationTimeBefore?: Timestamp;
3877 /**
3878 * A filter that returns only transform jobs modified after the specified time.
3879 */
3880 LastModifiedTimeAfter?: Timestamp;
3881 /**
3882 * A filter that returns only transform jobs modified before the specified time.
3883 */
3884 LastModifiedTimeBefore?: Timestamp;
3885 /**
3886 * A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
3887 */
3888 NameContains?: NameContains;
3889 /**
3890 * A filter that retrieves only transform jobs with a specific status.
3891 */
3892 StatusEquals?: TransformJobStatus;
3893 /**
3894 * The field to sort results by. The default is CreationTime.
3895 */
3896 SortBy?: SortBy;
3897 /**
3898 * The sort order for results. The default is Descending.
3899 */
3900 SortOrder?: SortOrder;
3901 /**
3902 * If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.
3903 */
3904 NextToken?: NextToken;
3905 /**
3906 * The maximum number of transform jobs to return in the response. The default value is 10.
3907 */
3908 MaxResults?: MaxResults;
3909 }
3910 export interface ListTransformJobsResponse {
3911 /**
3912 * An array of TransformJobSummary objects.
3913 */
3914 TransformJobSummaries: TransformJobSummaries;
3915 /**
3916 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
3917 */
3918 NextToken?: NextToken;
3919 }
3920 export interface ListWorkteamsRequest {
3921 /**
3922 * The field to sort results by. The default is CreationTime.
3923 */
3924 SortBy?: ListWorkteamsSortByOptions;
3925 /**
3926 * The sort order for results. The default is Ascending.
3927 */
3928 SortOrder?: SortOrder;
3929 /**
3930 * A string in the work team's name. This filter returns only work teams whose name contains the specified string.
3931 */
3932 NameContains?: WorkteamName;
3933 /**
3934 * If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
3935 */
3936 NextToken?: NextToken;
3937 /**
3938 * The maximum number of work teams to return in each page of the response.
3939 */
3940 MaxResults?: MaxResults;
3941 }
3942 export interface ListWorkteamsResponse {
3943 /**
3944 * An array of Workteam objects, each describing a work team.
3945 */
3946 Workteams: Workteams;
3947 /**
3948 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
3949 */
3950 NextToken?: NextToken;
3951 }
3952 export type ListWorkteamsSortByOptions = "Name"|"CreateDate"|string;
3953 export type MaxConcurrentTaskCount = number;
3954 export type MaxConcurrentTransforms = number;
3955 export type MaxHumanLabeledObjectCount = number;
3956 export type MaxNumberOfTrainingJobs = number;
3957 export type MaxParallelTrainingJobs = number;
3958 export type MaxPayloadInMB = number;
3959 export type MaxPercentageOfInputDatasetLabeled = number;
3960 export type MaxResults = number;
3961 export type MaxRuntimeInSeconds = number;
3962 export type MaxWaitTimeInSeconds = number;
3963 export interface MemberDefinition {
3964 /**
3965 * The Amazon Cognito user group that is part of the work team.
3966 */
3967 CognitoMemberDefinition?: CognitoMemberDefinition;
3968 }
3969 export type MemberDefinitions = MemberDefinition[];
3970 export interface MetricData {
3971 /**
3972 * The name of the metric.
3973 */
3974 MetricName?: MetricName;
3975 /**
3976 * The value of the metric.
3977 */
3978 Value?: Float;
3979 /**
3980 * The date and time that the algorithm emitted the metric.
3981 */
3982 Timestamp?: Timestamp;
3983 }
3984 export interface MetricDefinition {
3985 /**
3986 * The name of the metric.
3987 */
3988 Name: MetricName;
3989 /**
3990 * A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.
3991 */
3992 Regex: MetricRegex;
3993 }
3994 export type MetricDefinitionList = MetricDefinition[];
3995 export type MetricName = string;
3996 export type MetricRegex = string;
3997 export type MetricValue = number;
3998 export type ModelArn = string;
3999 export interface ModelArtifacts {
4000 /**
4001 * The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
4002 */
4003 S3ModelArtifacts: S3Uri;
4004 }
4005 export type ModelName = string;
4006 export type ModelNameContains = string;
4007 export type ModelPackageArn = string;
4008 export interface ModelPackageContainerDefinition {
4009 /**
4010 * The DNS host name for the Docker container.
4011 */
4012 ContainerHostname?: ContainerHostname;
4013 /**
4014 * The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
4015 */
4016 Image: Image;
4017 /**
4018 * An MD5 hash of the training algorithm that identifies the Docker image used for training.
4019 */
4020 ImageDigest?: ImageDigest;
4021 /**
4022 * The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
4023 */
4024 ModelDataUrl?: Url;
4025 /**
4026 * The AWS Marketplace product ID of the model package.
4027 */
4028 ProductId?: ProductId;
4029 }
4030 export type ModelPackageContainerDefinitionList = ModelPackageContainerDefinition[];
4031 export type ModelPackageSortBy = "Name"|"CreationTime"|string;
4032 export type ModelPackageStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string;
4033 export interface ModelPackageStatusDetails {
4034 /**
4035 * The validation status of the model package.
4036 */
4037 ValidationStatuses: ModelPackageStatusItemList;
4038 /**
4039 * The status of the scan of the Docker image container for the model package.
4040 */
4041 ImageScanStatuses?: ModelPackageStatusItemList;
4042 }
4043 export interface ModelPackageStatusItem {
4044 /**
4045 * The name of the model package for which the overall status is being reported.
4046 */
4047 Name: EntityName;
4048 /**
4049 * The current status.
4050 */
4051 Status: DetailedModelPackageStatus;
4052 /**
4053 * if the overall status is Failed, the reason for the failure.
4054 */
4055 FailureReason?: String;
4056 }
4057 export type ModelPackageStatusItemList = ModelPackageStatusItem[];
4058 export interface ModelPackageSummary {
4059 /**
4060 * The name of the model package.
4061 */
4062 ModelPackageName: EntityName;
4063 /**
4064 * The Amazon Resource Name (ARN) of the model package.
4065 */
4066 ModelPackageArn: ModelPackageArn;
4067 /**
4068 * A brief description of the model package.
4069 */
4070 ModelPackageDescription?: EntityDescription;
4071 /**
4072 * A timestamp that shows when the model package was created.
4073 */
4074 CreationTime: CreationTime;
4075 /**
4076 * The overall status of the model package.
4077 */
4078 ModelPackageStatus: ModelPackageStatus;
4079 }
4080 export type ModelPackageSummaryList = ModelPackageSummary[];
4081 export interface ModelPackageValidationProfile {
4082 /**
4083 * The name of the profile for the model package.
4084 */
4085 ProfileName: EntityName;
4086 /**
4087 * The TransformJobDefinition object that describes the transform job used for the validation of the model package.
4088 */
4089 TransformJobDefinition: TransformJobDefinition;
4090 }
4091 export type ModelPackageValidationProfiles = ModelPackageValidationProfile[];
4092 export interface ModelPackageValidationSpecification {
4093 /**
4094 * The IAM roles to be used for the validation of the model package.
4095 */
4096 ValidationRole: RoleArn;
4097 /**
4098 * An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.
4099 */
4100 ValidationProfiles: ModelPackageValidationProfiles;
4101 }
4102 export type ModelSortKey = "Name"|"CreationTime"|string;
4103 export interface ModelSummary {
4104 /**
4105 * The name of the model that you want a summary for.
4106 */
4107 ModelName: ModelName;
4108 /**
4109 * The Amazon Resource Name (ARN) of the model.
4110 */
4111 ModelArn: ModelArn;
4112 /**
4113 * A timestamp that indicates when the model was created.
4114 */
4115 CreationTime: Timestamp;
4116 }
4117 export type ModelSummaryList = ModelSummary[];
4118 export type NameContains = string;
4119 export interface NestedFilters {
4120 /**
4121 * The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .
4122 */
4123 NestedPropertyName: ResourcePropertyName;
4124 /**
4125 * A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.
4126 */
4127 Filters: FilterList;
4128 }
4129 export type NestedFiltersList = NestedFilters[];
4130 export type NetworkInterfaceId = string;
4131 export type NextToken = string;
4132 export type NotebookInstanceAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|"ml.eia2.medium"|"ml.eia2.large"|"ml.eia2.xlarge"|string;
4133 export type NotebookInstanceAcceleratorTypes = NotebookInstanceAcceleratorType[];
4134 export type NotebookInstanceArn = string;
4135 export type NotebookInstanceLifecycleConfigArn = string;
4136 export type NotebookInstanceLifecycleConfigContent = string;
4137 export type NotebookInstanceLifecycleConfigList = NotebookInstanceLifecycleHook[];
4138 export type NotebookInstanceLifecycleConfigName = string;
4139 export type NotebookInstanceLifecycleConfigNameContains = string;
4140 export type NotebookInstanceLifecycleConfigSortKey = "Name"|"CreationTime"|"LastModifiedTime"|string;
4141 export type NotebookInstanceLifecycleConfigSortOrder = "Ascending"|"Descending"|string;
4142 export interface NotebookInstanceLifecycleConfigSummary {
4143 /**
4144 * The name of the lifecycle configuration.
4145 */
4146 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
4147 /**
4148 * The Amazon Resource Name (ARN) of the lifecycle configuration.
4149 */
4150 NotebookInstanceLifecycleConfigArn: NotebookInstanceLifecycleConfigArn;
4151 /**
4152 * A timestamp that tells when the lifecycle configuration was created.
4153 */
4154 CreationTime?: CreationTime;
4155 /**
4156 * A timestamp that tells when the lifecycle configuration was last modified.
4157 */
4158 LastModifiedTime?: LastModifiedTime;
4159 }
4160 export type NotebookInstanceLifecycleConfigSummaryList = NotebookInstanceLifecycleConfigSummary[];
4161 export interface NotebookInstanceLifecycleHook {
4162 /**
4163 * A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
4164 */
4165 Content?: NotebookInstanceLifecycleConfigContent;
4166 }
4167 export type NotebookInstanceName = string;
4168 export type NotebookInstanceNameContains = string;
4169 export type NotebookInstanceSortKey = "Name"|"CreationTime"|"Status"|string;
4170 export type NotebookInstanceSortOrder = "Ascending"|"Descending"|string;
4171 export type NotebookInstanceStatus = "Pending"|"InService"|"Stopping"|"Stopped"|"Failed"|"Deleting"|"Updating"|string;
4172 export interface NotebookInstanceSummary {
4173 /**
4174 * The name of the notebook instance that you want a summary for.
4175 */
4176 NotebookInstanceName: NotebookInstanceName;
4177 /**
4178 * The Amazon Resource Name (ARN) of the notebook instance.
4179 */
4180 NotebookInstanceArn: NotebookInstanceArn;
4181 /**
4182 * The status of the notebook instance.
4183 */
4184 NotebookInstanceStatus?: NotebookInstanceStatus;
4185 /**
4186 * The URL that you use to connect to the Jupyter instance running in your notebook instance.
4187 */
4188 Url?: NotebookInstanceUrl;
4189 /**
4190 * The type of ML compute instance that the notebook instance is running on.
4191 */
4192 InstanceType?: InstanceType;
4193 /**
4194 * A timestamp that shows when the notebook instance was created.
4195 */
4196 CreationTime?: CreationTime;
4197 /**
4198 * A timestamp that shows when the notebook instance was last modified.
4199 */
4200 LastModifiedTime?: LastModifiedTime;
4201 /**
4202 * The name of a notebook instance lifecycle configuration associated with this notebook instance. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
4203 */
4204 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
4205 /**
4206 * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
4207 */
4208 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
4209 /**
4210 * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
4211 */
4212 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
4213 }
4214 export type NotebookInstanceSummaryList = NotebookInstanceSummary[];
4215 export type NotebookInstanceUrl = string;
4216 export type NotebookInstanceVolumeSizeInGB = number;
4217 export interface NotificationConfiguration {
4218 /**
4219 * The ARN for the SNS topic to which notifications should be published.
4220 */
4221 NotificationTopicArn?: NotificationTopicArn;
4222 }
4223 export type NotificationTopicArn = string;
4224 export type NumberOfHumanWorkersPerDataObject = number;
4225 export type ObjectiveStatus = "Succeeded"|"Pending"|"Failed"|string;
4226 export type ObjectiveStatusCounter = number;
4227 export interface ObjectiveStatusCounters {
4228 /**
4229 * The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
4230 */
4231 Succeeded?: ObjectiveStatusCounter;
4232 /**
4233 * The number of training jobs that are in progress and pending evaluation of their final objective metric.
4234 */
4235 Pending?: ObjectiveStatusCounter;
4236 /**
4237 * The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
4238 */
4239 Failed?: ObjectiveStatusCounter;
4240 }
4241 export type Operator = "Equals"|"NotEquals"|"GreaterThan"|"GreaterThanOrEqualTo"|"LessThan"|"LessThanOrEqualTo"|"Contains"|string;
4242 export type OrderKey = "Ascending"|"Descending"|string;
4243 export interface OutputConfig {
4244 /**
4245 * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
4246 */
4247 S3OutputLocation: S3Uri;
4248 /**
4249 * Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.
4250 */
4251 TargetDevice: TargetDevice;
4252 }
4253 export interface OutputDataConfig {
4254 /**
4255 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
4256 */
4257 KmsKeyId?: KmsKeyId;
4258 /**
4259 * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
4260 */
4261 S3OutputPath: S3Uri;
4262 }
4263 export type PaginationToken = string;
4264 export type ParameterKey = string;
4265 export type ParameterName = string;
4266 export interface ParameterRange {
4267 /**
4268 * A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
4269 */
4270 IntegerParameterRangeSpecification?: IntegerParameterRangeSpecification;
4271 /**
4272 * A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
4273 */
4274 ContinuousParameterRangeSpecification?: ContinuousParameterRangeSpecification;
4275 /**
4276 * A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
4277 */
4278 CategoricalParameterRangeSpecification?: CategoricalParameterRangeSpecification;
4279 }
4280 export interface ParameterRanges {
4281 /**
4282 * The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
4283 */
4284 IntegerParameterRanges?: IntegerParameterRanges;
4285 /**
4286 * The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
4287 */
4288 ContinuousParameterRanges?: ContinuousParameterRanges;
4289 /**
4290 * The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
4291 */
4292 CategoricalParameterRanges?: CategoricalParameterRanges;
4293 }
4294 export type ParameterType = "Integer"|"Continuous"|"Categorical"|"FreeText"|string;
4295 export type ParameterValue = string;
4296 export type ParameterValues = ParameterValue[];
4297 export interface ParentHyperParameterTuningJob {
4298 /**
4299 * The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
4300 */
4301 HyperParameterTuningJobName?: HyperParameterTuningJobName;
4302 }
4303 export type ParentHyperParameterTuningJobs = ParentHyperParameterTuningJob[];
4304 export type ProductId = string;
4305 export type ProductListings = String[];
4306 export interface ProductionVariant {
4307 /**
4308 * The name of the production variant.
4309 */
4310 VariantName: VariantName;
4311 /**
4312 * The name of the model that you want to host. This is the name that you specified when creating the model.
4313 */
4314 ModelName: ModelName;
4315 /**
4316 * Number of instances to launch initially.
4317 */
4318 InitialInstanceCount: TaskCount;
4319 /**
4320 * The ML compute instance type.
4321 */
4322 InstanceType: ProductionVariantInstanceType;
4323 /**
4324 * Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.
4325 */
4326 InitialVariantWeight?: VariantWeight;
4327 /**
4328 * The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
4329 */
4330 AcceleratorType?: ProductionVariantAcceleratorType;
4331 }
4332 export type ProductionVariantAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|"ml.eia2.medium"|"ml.eia2.large"|"ml.eia2.xlarge"|string;
4333 export type ProductionVariantInstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.m5d.large"|"ml.m5d.xlarge"|"ml.m5d.2xlarge"|"ml.m5d.4xlarge"|"ml.m5d.12xlarge"|"ml.m5d.24xlarge"|"ml.c4.large"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5d.large"|"ml.c5d.xlarge"|"ml.c5d.2xlarge"|"ml.c5d.4xlarge"|"ml.c5d.9xlarge"|"ml.c5d.18xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.12xlarge"|"ml.r5.24xlarge"|"ml.r5d.large"|"ml.r5d.xlarge"|"ml.r5d.2xlarge"|"ml.r5d.4xlarge"|"ml.r5d.12xlarge"|"ml.r5d.24xlarge"|string;
4334 export type ProductionVariantList = ProductionVariant[];
4335 export interface ProductionVariantSummary {
4336 /**
4337 * The name of the variant.
4338 */
4339 VariantName: VariantName;
4340 /**
4341 * An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
4342 */
4343 DeployedImages?: DeployedImages;
4344 /**
4345 * The weight associated with the variant.
4346 */
4347 CurrentWeight?: VariantWeight;
4348 /**
4349 * The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
4350 */
4351 DesiredWeight?: VariantWeight;
4352 /**
4353 * The number of instances associated with the variant.
4354 */
4355 CurrentInstanceCount?: TaskCount;
4356 /**
4357 * The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
4358 */
4359 DesiredInstanceCount?: TaskCount;
4360 }
4361 export type ProductionVariantSummaryList = ProductionVariantSummary[];
4362 export type PropertyNameHint = string;
4363 export interface PropertyNameQuery {
4364 /**
4365 * Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint.
4366 */
4367 PropertyNameHint: PropertyNameHint;
4368 }
4369 export interface PropertyNameSuggestion {
4370 /**
4371 * A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.
4372 */
4373 PropertyName?: ResourcePropertyName;
4374 }
4375 export type PropertyNameSuggestionList = PropertyNameSuggestion[];
4376 export interface PublicWorkforceTaskPrice {
4377 /**
4378 * Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
4379 */
4380 AmountInUsd?: USD;
4381 }
4382 export type RealtimeInferenceInstanceTypes = ProductionVariantInstanceType[];
4383 export type RecordWrapper = "None"|"RecordIO"|string;
4384 export interface RenderUiTemplateRequest {
4385 /**
4386 * A Template object containing the worker UI template to render.
4387 */
4388 UiTemplate: UiTemplate;
4389 /**
4390 * A RenderableTask object containing a representative task to render.
4391 */
4392 Task: RenderableTask;
4393 /**
4394 * The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
4395 */
4396 RoleArn: RoleArn;
4397 }
4398 export interface RenderUiTemplateResponse {
4399 /**
4400 * A Liquid template that renders the HTML for the worker UI.
4401 */
4402 RenderedContent: String;
4403 /**
4404 * A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.
4405 */
4406 Errors: RenderingErrorList;
4407 }
4408 export interface RenderableTask {
4409 /**
4410 * A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".
4411 */
4412 Input: TaskInput;
4413 }
4414 export interface RenderingError {
4415 /**
4416 * A unique identifier for a specific class of errors.
4417 */
4418 Code: String;
4419 /**
4420 * A human-readable message describing the error.
4421 */
4422 Message: String;
4423 }
4424 export type RenderingErrorList = RenderingError[];
4425 export type ResourceArn = string;
4426 export interface ResourceConfig {
4427 /**
4428 * The ML compute instance type.
4429 */
4430 InstanceType: TrainingInstanceType;
4431 /**
4432 * The number of ML compute instances to use. For distributed training, provide a value greater than 1.
4433 */
4434 InstanceCount: TrainingInstanceCount;
4435 /**
4436 * The size of the ML storage volume that you want to provision. ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification. You must specify sufficient ML storage for your scenario. Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
4437 */
4438 VolumeSizeInGB: VolumeSizeInGB;
4439 /**
4440 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
4441 */
4442 VolumeKmsKeyId?: KmsKeyId;
4443 }
4444 export interface ResourceLimits {
4445 /**
4446 * The maximum number of training jobs that a hyperparameter tuning job can launch.
4447 */
4448 MaxNumberOfTrainingJobs: MaxNumberOfTrainingJobs;
4449 /**
4450 * The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
4451 */
4452 MaxParallelTrainingJobs: MaxParallelTrainingJobs;
4453 }
4454 export type ResourcePropertyName = string;
4455 export type ResourceType = "TrainingJob"|string;
4456 export type ResponseMIMEType = string;
4457 export type ResponseMIMETypes = ResponseMIMEType[];
4458 export type RoleArn = string;
4459 export type RootAccess = "Enabled"|"Disabled"|string;
4460 export type S3DataDistribution = "FullyReplicated"|"ShardedByS3Key"|string;
4461 export interface S3DataSource {
4462 /**
4463 * If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training. If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.
4464 */
4465 S3DataType: S3DataType;
4466 /**
4467 * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix. A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... ] The preceding JSON matches the following s3Uris: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
4468 */
4469 S3Uri: S3Uri;
4470 /**
4471 * If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated. If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data. Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms. In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.
4472 */
4473 S3DataDistributionType?: S3DataDistribution;
4474 /**
4475 * A list of one or more attribute names to use that are found in a specified augmented manifest file.
4476 */
4477 AttributeNames?: AttributeNames;
4478 }
4479 export type S3DataType = "ManifestFile"|"S3Prefix"|"AugmentedManifestFile"|string;
4480 export type S3Uri = string;
4481 export interface SearchExpression {
4482 /**
4483 * A list of filter objects.
4484 */
4485 Filters?: FilterList;
4486 /**
4487 * A list of nested filter objects.
4488 */
4489 NestedFilters?: NestedFiltersList;
4490 /**
4491 * A list of search expression objects.
4492 */
4493 SubExpressions?: SearchExpressionList;
4494 /**
4495 * A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
4496 */
4497 Operator?: BooleanOperator;
4498 }
4499 export type SearchExpressionList = SearchExpression[];
4500 export interface SearchRecord {
4501 /**
4502 * A TrainingJob object that is returned as part of a Search request.
4503 */
4504 TrainingJob?: TrainingJob;
4505 }
4506 export interface SearchRequest {
4507 /**
4508 * The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.
4509 */
4510 Resource: ResourceType;
4511 /**
4512 * A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
4513 */
4514 SearchExpression?: SearchExpression;
4515 /**
4516 * The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
4517 */
4518 SortBy?: ResourcePropertyName;
4519 /**
4520 * How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
4521 */
4522 SortOrder?: SearchSortOrder;
4523 /**
4524 * If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.
4525 */
4526 NextToken?: NextToken;
4527 /**
4528 * The maximum number of results to return in a SearchResponse.
4529 */
4530 MaxResults?: MaxResults;
4531 }
4532 export interface SearchResponse {
4533 /**
4534 * A list of SearchResult objects.
4535 */
4536 Results?: SearchResultsList;
4537 /**
4538 * If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.
4539 */
4540 NextToken?: NextToken;
4541 }
4542 export type SearchResultsList = SearchRecord[];
4543 export type SearchSortOrder = "Ascending"|"Descending"|string;
4544 export type SecondaryStatus = "Starting"|"LaunchingMLInstances"|"PreparingTrainingStack"|"Downloading"|"DownloadingTrainingImage"|"Training"|"Uploading"|"Stopping"|"Stopped"|"MaxRuntimeExceeded"|"Completed"|"Failed"|"Interrupted"|"MaxWaitTimeExceeded"|string;
4545 export interface SecondaryStatusTransition {
4546 /**
4547 * Contains a secondary status information from a training job. Status might be one of the following secondary statuses: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage
4548 */
4549 Status: SecondaryStatus;
4550 /**
4551 * A timestamp that shows when the training job transitioned to the current secondary status state.
4552 */
4553 StartTime: Timestamp;
4554 /**
4555 * A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
4556 */
4557 EndTime?: Timestamp;
4558 /**
4559 * A detailed description of the progress within a secondary status. Amazon SageMaker provides secondary statuses and status messages that apply to each of them: Starting Starting the training job. Launching requested ML instances. Insufficient capacity error from EC2 while launching instances, retrying! Launched instance was unhealthy, replacing it! Preparing the instances for training. Training Downloading the training image. Training image download completed. Training in progress. Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements. To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following: TrainingJobStatus - InProgress SecondaryStatus - Training StatusMessage - Downloading the training image
4560 */
4561 StatusMessage?: StatusMessage;
4562 }
4563 export type SecondaryStatusTransitions = SecondaryStatusTransition[];
4564 export type SecretArn = string;
4565 export type SecurityGroupId = string;
4566 export type SecurityGroupIds = SecurityGroupId[];
4567 export type Seed = number;
4568 export type SessionExpirationDurationInSeconds = number;
4569 export interface ShuffleConfig {
4570 /**
4571 * Determines the shuffling order in ShuffleConfig value.
4572 */
4573 Seed: Seed;
4574 }
4575 export type SortBy = "Name"|"CreationTime"|"Status"|string;
4576 export type SortOrder = "Ascending"|"Descending"|string;
4577 export interface SourceAlgorithm {
4578 /**
4579 * The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
4580 */
4581 ModelDataUrl?: Url;
4582 /**
4583 * The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.
4584 */
4585 AlgorithmName: ArnOrName;
4586 }
4587 export type SourceAlgorithmList = SourceAlgorithm[];
4588 export interface SourceAlgorithmSpecification {
4589 /**
4590 * A list of the algorithms that were used to create a model package.
4591 */
4592 SourceAlgorithms: SourceAlgorithmList;
4593 }
4594 export type SplitType = "None"|"Line"|"RecordIO"|"TFRecord"|string;
4595 export interface StartNotebookInstanceInput {
4596 /**
4597 * The name of the notebook instance to start.
4598 */
4599 NotebookInstanceName: NotebookInstanceName;
4600 }
4601 export type StatusMessage = string;
4602 export interface StopCompilationJobRequest {
4603 /**
4604 * The name of the model compilation job to stop.
4605 */
4606 CompilationJobName: EntityName;
4607 }
4608 export interface StopHyperParameterTuningJobRequest {
4609 /**
4610 * The name of the tuning job to stop.
4611 */
4612 HyperParameterTuningJobName: HyperParameterTuningJobName;
4613 }
4614 export interface StopLabelingJobRequest {
4615 /**
4616 * The name of the labeling job to stop.
4617 */
4618 LabelingJobName: LabelingJobName;
4619 }
4620 export interface StopNotebookInstanceInput {
4621 /**
4622 * The name of the notebook instance to terminate.
4623 */
4624 NotebookInstanceName: NotebookInstanceName;
4625 }
4626 export interface StopTrainingJobRequest {
4627 /**
4628 * The name of the training job to stop.
4629 */
4630 TrainingJobName: TrainingJobName;
4631 }
4632 export interface StopTransformJobRequest {
4633 /**
4634 * The name of the transform job to stop.
4635 */
4636 TransformJobName: TransformJobName;
4637 }
4638 export interface StoppingCondition {
4639 /**
4640 * The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
4641 */
4642 MaxRuntimeInSeconds?: MaxRuntimeInSeconds;
4643 /**
4644 * The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.
4645 */
4646 MaxWaitTimeInSeconds?: MaxWaitTimeInSeconds;
4647 }
4648 export type String = string;
4649 export type String200 = string;
4650 export type SubnetId = string;
4651 export type Subnets = SubnetId[];
4652 export interface SubscribedWorkteam {
4653 /**
4654 * The Amazon Resource Name (ARN) of the vendor that you have subscribed.
4655 */
4656 WorkteamArn: WorkteamArn;
4657 /**
4658 * The title of the service provided by the vendor in the Amazon Marketplace.
4659 */
4660 MarketplaceTitle?: String200;
4661 /**
4662 * The name of the vendor in the Amazon Marketplace.
4663 */
4664 SellerName?: String;
4665 /**
4666 * The description of the vendor from the Amazon Marketplace.
4667 */
4668 MarketplaceDescription?: String200;
4669 /**
4670 *
4671 */
4672 ListingId?: String;
4673 }
4674 export type SubscribedWorkteams = SubscribedWorkteam[];
4675 export type Success = boolean;
4676 export interface SuggestionQuery {
4677 /**
4678 * A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response.
4679 */
4680 PropertyNameQuery?: PropertyNameQuery;
4681 }
4682 export interface Tag {
4683 /**
4684 * The tag key.
4685 */
4686 Key: TagKey;
4687 /**
4688 * The tag value.
4689 */
4690 Value: TagValue;
4691 }
4692 export type TagKey = string;
4693 export type TagKeyList = TagKey[];
4694 export type TagList = Tag[];
4695 export type TagValue = string;
4696 export type TargetDevice = "lambda"|"ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"jetson_tx1"|"jetson_tx2"|"jetson_nano"|"rasp3b"|"deeplens"|"rk3399"|"rk3288"|"aisage"|"sbe_c"|"qcs605"|"qcs603"|string;
4697 export type TaskAvailabilityLifetimeInSeconds = number;
4698 export type TaskCount = number;
4699 export type TaskDescription = string;
4700 export type TaskInput = string;
4701 export type TaskKeyword = string;
4702 export type TaskKeywords = TaskKeyword[];
4703 export type TaskTimeLimitInSeconds = number;
4704 export type TaskTitle = string;
4705 export type TemplateContent = string;
4706 export type TenthFractionsOfACent = number;
4707 export type Timestamp = Date;
4708 export type TrainingInputMode = "Pipe"|"File"|string;
4709 export type TrainingInstanceCount = number;
4710 export type TrainingInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|string;
4711 export type TrainingInstanceTypes = TrainingInstanceType[];
4712 export interface TrainingJob {
4713 /**
4714 * The name of the training job.
4715 */
4716 TrainingJobName?: TrainingJobName;
4717 /**
4718 * The Amazon Resource Name (ARN) of the training job.
4719 */
4720 TrainingJobArn?: TrainingJobArn;
4721 /**
4722 * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
4723 */
4724 TuningJobArn?: HyperParameterTuningJobArn;
4725 /**
4726 * The Amazon Resource Name (ARN) of the labeling job.
4727 */
4728 LabelingJobArn?: LabelingJobArn;
4729 /**
4730 * Information about the Amazon S3 location that is configured for storing model artifacts.
4731 */
4732 ModelArtifacts?: ModelArtifacts;
4733 /**
4734 * The status of the training job. Training job statuses are: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus.
4735 */
4736 TrainingJobStatus?: TrainingJobStatus;
4737 /**
4738 * Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage
4739 */
4740 SecondaryStatus?: SecondaryStatus;
4741 /**
4742 * If the training job failed, the reason it failed.
4743 */
4744 FailureReason?: FailureReason;
4745 /**
4746 * Algorithm-specific parameters.
4747 */
4748 HyperParameters?: HyperParameters;
4749 /**
4750 * Information about the algorithm used for training, and algorithm metadata.
4751 */
4752 AlgorithmSpecification?: AlgorithmSpecification;
4753 /**
4754 * The AWS Identity and Access Management (IAM) role configured for the training job.
4755 */
4756 RoleArn?: RoleArn;
4757 /**
4758 * An array of Channel objects that describes each data input channel.
4759 */
4760 InputDataConfig?: InputDataConfig;
4761 /**
4762 * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
4763 */
4764 OutputDataConfig?: OutputDataConfig;
4765 /**
4766 * Resources, including ML compute instances and ML storage volumes, that are configured for model training.
4767 */
4768 ResourceConfig?: ResourceConfig;
4769 /**
4770 * A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
4771 */
4772 VpcConfig?: VpcConfig;
4773 /**
4774 * Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
4775 */
4776 StoppingCondition?: StoppingCondition;
4777 /**
4778 * A timestamp that indicates when the training job was created.
4779 */
4780 CreationTime?: Timestamp;
4781 /**
4782 * Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
4783 */
4784 TrainingStartTime?: Timestamp;
4785 /**
4786 * Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
4787 */
4788 TrainingEndTime?: Timestamp;
4789 /**
4790 * A timestamp that indicates when the status of the training job was last modified.
4791 */
4792 LastModifiedTime?: Timestamp;
4793 /**
4794 * A history of all of the secondary statuses that the training job has transitioned through.
4795 */
4796 SecondaryStatusTransitions?: SecondaryStatusTransitions;
4797 /**
4798 * A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.
4799 */
4800 FinalMetricDataList?: FinalMetricDataList;
4801 /**
4802 * If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
4803 */
4804 EnableNetworkIsolation?: Boolean;
4805 /**
4806 * To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
4807 */
4808 EnableInterContainerTrafficEncryption?: Boolean;
4809 /**
4810 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
4811 */
4812 Tags?: TagList;
4813 }
4814 export type TrainingJobArn = string;
4815 export interface TrainingJobDefinition {
4816 /**
4817 * The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.
4818 */
4819 TrainingInputMode: TrainingInputMode;
4820 /**
4821 * The hyperparameters used for the training job.
4822 */
4823 HyperParameters?: HyperParameters;
4824 /**
4825 * An array of Channel objects, each of which specifies an input source.
4826 */
4827 InputDataConfig: InputDataConfig;
4828 /**
4829 * the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
4830 */
4831 OutputDataConfig: OutputDataConfig;
4832 /**
4833 * The resources, including the ML compute instances and ML storage volumes, to use for model training.
4834 */
4835 ResourceConfig: ResourceConfig;
4836 /**
4837 * Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
4838 */
4839 StoppingCondition: StoppingCondition;
4840 }
4841 export type TrainingJobEarlyStoppingType = "Off"|"Auto"|string;
4842 export type TrainingJobName = string;
4843 export type TrainingJobSortByOptions = "Name"|"CreationTime"|"Status"|"FinalObjectiveMetricValue"|string;
4844 export type TrainingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
4845 export type TrainingJobStatusCounter = number;
4846 export interface TrainingJobStatusCounters {
4847 /**
4848 * The number of completed training jobs launched by the hyperparameter tuning job.
4849 */
4850 Completed?: TrainingJobStatusCounter;
4851 /**
4852 * The number of in-progress training jobs launched by a hyperparameter tuning job.
4853 */
4854 InProgress?: TrainingJobStatusCounter;
4855 /**
4856 * The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
4857 */
4858 RetryableError?: TrainingJobStatusCounter;
4859 /**
4860 * The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
4861 */
4862 NonRetryableError?: TrainingJobStatusCounter;
4863 /**
4864 * The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
4865 */
4866 Stopped?: TrainingJobStatusCounter;
4867 }
4868 export type TrainingJobSummaries = TrainingJobSummary[];
4869 export interface TrainingJobSummary {
4870 /**
4871 * The name of the training job that you want a summary for.
4872 */
4873 TrainingJobName: TrainingJobName;
4874 /**
4875 * The Amazon Resource Name (ARN) of the training job.
4876 */
4877 TrainingJobArn: TrainingJobArn;
4878 /**
4879 * A timestamp that shows when the training job was created.
4880 */
4881 CreationTime: Timestamp;
4882 /**
4883 * A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).
4884 */
4885 TrainingEndTime?: Timestamp;
4886 /**
4887 * Timestamp when the training job was last modified.
4888 */
4889 LastModifiedTime?: Timestamp;
4890 /**
4891 * The status of the training job.
4892 */
4893 TrainingJobStatus: TrainingJobStatus;
4894 }
4895 export interface TrainingSpecification {
4896 /**
4897 * The Amazon ECR registry path of the Docker image that contains the training algorithm.
4898 */
4899 TrainingImage: Image;
4900 /**
4901 * An MD5 hash of the training algorithm that identifies the Docker image used for training.
4902 */
4903 TrainingImageDigest?: ImageDigest;
4904 /**
4905 * A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.&gt;
4906 */
4907 SupportedHyperParameters?: HyperParameterSpecifications;
4908 /**
4909 * A list of the instance types that this algorithm can use for training.
4910 */
4911 SupportedTrainingInstanceTypes: TrainingInstanceTypes;
4912 /**
4913 * Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.
4914 */
4915 SupportsDistributedTraining?: Boolean;
4916 /**
4917 * A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
4918 */
4919 MetricDefinitions?: MetricDefinitionList;
4920 /**
4921 * A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
4922 */
4923 TrainingChannels: ChannelSpecifications;
4924 /**
4925 * A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
4926 */
4927 SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjectives;
4928 }
4929 export type TrainingTimeInSeconds = number;
4930 export interface TransformDataSource {
4931 /**
4932 * The S3 location of the data source that is associated with a channel.
4933 */
4934 S3DataSource: TransformS3DataSource;
4935 }
4936 export type TransformEnvironmentKey = string;
4937 export type TransformEnvironmentMap = {[key: string]: TransformEnvironmentValue};
4938 export type TransformEnvironmentValue = string;
4939 export interface TransformInput {
4940 /**
4941 * Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
4942 */
4943 DataSource: TransformDataSource;
4944 /**
4945 * The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.
4946 */
4947 ContentType?: ContentType;
4948 /**
4949 * If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.
4950 */
4951 CompressionType?: CompressionType;
4952 /**
4953 * The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request. Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord. For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
4954 */
4955 SplitType?: SplitType;
4956 }
4957 export type TransformInstanceCount = number;
4958 export type TransformInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|string;
4959 export type TransformInstanceTypes = TransformInstanceType[];
4960 export type TransformJobArn = string;
4961 export interface TransformJobDefinition {
4962 /**
4963 * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
4964 */
4965 MaxConcurrentTransforms?: MaxConcurrentTransforms;
4966 /**
4967 * The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
4968 */
4969 MaxPayloadInMB?: MaxPayloadInMB;
4970 /**
4971 * A string that determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.
4972 */
4973 BatchStrategy?: BatchStrategy;
4974 /**
4975 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
4976 */
4977 Environment?: TransformEnvironmentMap;
4978 /**
4979 * A description of the input source and the way the transform job consumes it.
4980 */
4981 TransformInput: TransformInput;
4982 /**
4983 * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
4984 */
4985 TransformOutput: TransformOutput;
4986 /**
4987 * Identifies the ML compute instances for the transform job.
4988 */
4989 TransformResources: TransformResources;
4990 }
4991 export type TransformJobName = string;
4992 export type TransformJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
4993 export type TransformJobSummaries = TransformJobSummary[];
4994 export interface TransformJobSummary {
4995 /**
4996 * The name of the transform job.
4997 */
4998 TransformJobName: TransformJobName;
4999 /**
5000 * The Amazon Resource Name (ARN) of the transform job.
5001 */
5002 TransformJobArn: TransformJobArn;
5003 /**
5004 * A timestamp that shows when the transform Job was created.
5005 */
5006 CreationTime: Timestamp;
5007 /**
5008 * Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.
5009 */
5010 TransformEndTime?: Timestamp;
5011 /**
5012 * Indicates when the transform job was last modified.
5013 */
5014 LastModifiedTime?: Timestamp;
5015 /**
5016 * The status of the transform job.
5017 */
5018 TransformJobStatus: TransformJobStatus;
5019 /**
5020 * If the transform job failed, the reason it failed.
5021 */
5022 FailureReason?: FailureReason;
5023 }
5024 export interface TransformOutput {
5025 /**
5026 * The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix. For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
5027 */
5028 S3OutputPath: S3Uri;
5029 /**
5030 * The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.
5031 */
5032 Accept?: Accept;
5033 /**
5034 * Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.
5035 */
5036 AssembleWith?: AssemblyType;
5037 /**
5038 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
5039 */
5040 KmsKeyId?: KmsKeyId;
5041 }
5042 export interface TransformResources {
5043 /**
5044 * The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.
5045 */
5046 InstanceType: TransformInstanceType;
5047 /**
5048 * The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.
5049 */
5050 InstanceCount: TransformInstanceCount;
5051 /**
5052 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
5053 */
5054 VolumeKmsKeyId?: KmsKeyId;
5055 }
5056 export interface TransformS3DataSource {
5057 /**
5058 * If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform. The following values are compatible: ManifestFile, S3Prefix The following value is not compatible: AugmentedManifestFile
5059 */
5060 S3DataType: S3DataType;
5061 /**
5062 * Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix. A manifest might look like this: s3://bucketname/example.manifest The manifest is an S3 object which is a JSON file with the following format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... ] The preceding JSON matches the following S3Uris: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-1 ... The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
5063 */
5064 S3Uri: S3Uri;
5065 }
5066 export interface USD {
5067 /**
5068 * The whole number of dollars in the amount.
5069 */
5070 Dollars?: Dollars;
5071 /**
5072 * The fractional portion, in cents, of the amount.
5073 */
5074 Cents?: Cents;
5075 /**
5076 * Fractions of a cent, in tenths.
5077 */
5078 TenthFractionsOfACent?: TenthFractionsOfACent;
5079 }
5080 export interface UiConfig {
5081 /**
5082 * The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
5083 */
5084 UiTemplateS3Uri: S3Uri;
5085 }
5086 export interface UiTemplate {
5087 /**
5088 * The content of the Liquid template for the worker user interface.
5089 */
5090 Content: TemplateContent;
5091 }
5092 export interface UpdateCodeRepositoryInput {
5093 /**
5094 * The name of the Git repository to update.
5095 */
5096 CodeRepositoryName: EntityName;
5097 /**
5098 * The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format: {"username": UserName, "password": Password}
5099 */
5100 GitConfig?: GitConfigForUpdate;
5101 }
5102 export interface UpdateCodeRepositoryOutput {
5103 /**
5104 * The ARN of the Git repository.
5105 */
5106 CodeRepositoryArn: CodeRepositoryArn;
5107 }
5108 export interface UpdateEndpointInput {
5109 /**
5110 * The name of the endpoint whose configuration you want to update.
5111 */
5112 EndpointName: EndpointName;
5113 /**
5114 * The name of the new endpoint configuration.
5115 */
5116 EndpointConfigName: EndpointConfigName;
5117 }
5118 export interface UpdateEndpointOutput {
5119 /**
5120 * The Amazon Resource Name (ARN) of the endpoint.
5121 */
5122 EndpointArn: EndpointArn;
5123 }
5124 export interface UpdateEndpointWeightsAndCapacitiesInput {
5125 /**
5126 * The name of an existing Amazon SageMaker endpoint.
5127 */
5128 EndpointName: EndpointName;
5129 /**
5130 * An object that provides new capacity and weight values for a variant.
5131 */
5132 DesiredWeightsAndCapacities: DesiredWeightAndCapacityList;
5133 }
5134 export interface UpdateEndpointWeightsAndCapacitiesOutput {
5135 /**
5136 * The Amazon Resource Name (ARN) of the updated endpoint.
5137 */
5138 EndpointArn: EndpointArn;
5139 }
5140 export interface UpdateNotebookInstanceInput {
5141 /**
5142 * The name of the notebook instance to update.
5143 */
5144 NotebookInstanceName: NotebookInstanceName;
5145 /**
5146 * The Amazon ML compute instance type.
5147 */
5148 InstanceType?: InstanceType;
5149 /**
5150 * The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles. To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
5151 */
5152 RoleArn?: RoleArn;
5153 /**
5154 * The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
5155 */
5156 LifecycleConfigName?: NotebookInstanceLifecycleConfigName;
5157 /**
5158 * Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
5159 */
5160 DisassociateLifecycleConfig?: DisassociateNotebookInstanceLifecycleConfig;
5161 /**
5162 * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.
5163 */
5164 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
5165 /**
5166 * The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
5167 */
5168 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
5169 /**
5170 * An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
5171 */
5172 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
5173 /**
5174 * A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
5175 */
5176 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
5177 /**
5178 * A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.
5179 */
5180 DisassociateAcceleratorTypes?: DisassociateNotebookInstanceAcceleratorTypes;
5181 /**
5182 * The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
5183 */
5184 DisassociateDefaultCodeRepository?: DisassociateDefaultCodeRepository;
5185 /**
5186 * A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
5187 */
5188 DisassociateAdditionalCodeRepositories?: DisassociateAdditionalCodeRepositories;
5189 /**
5190 * Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.
5191 */
5192 RootAccess?: RootAccess;
5193 }
5194 export interface UpdateNotebookInstanceLifecycleConfigInput {
5195 /**
5196 * The name of the lifecycle configuration.
5197 */
5198 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
5199 /**
5200 * The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
5201 */
5202 OnCreate?: NotebookInstanceLifecycleConfigList;
5203 /**
5204 * The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
5205 */
5206 OnStart?: NotebookInstanceLifecycleConfigList;
5207 }
5208 export interface UpdateNotebookInstanceLifecycleConfigOutput {
5209 }
5210 export interface UpdateNotebookInstanceOutput {
5211 }
5212 export interface UpdateWorkteamRequest {
5213 /**
5214 * The name of the work team to update.
5215 */
5216 WorkteamName: WorkteamName;
5217 /**
5218 * A list of MemberDefinition objects that contain the updated work team members.
5219 */
5220 MemberDefinitions?: MemberDefinitions;
5221 /**
5222 * An updated description for the work team.
5223 */
5224 Description?: String200;
5225 /**
5226 * Configures SNS topic notifications for available or expiring work items
5227 */
5228 NotificationConfiguration?: NotificationConfiguration;
5229 }
5230 export interface UpdateWorkteamResponse {
5231 /**
5232 * A Workteam object that describes the updated work team.
5233 */
5234 Workteam: Workteam;
5235 }
5236 export type Url = string;
5237 export type VariantName = string;
5238 export type VariantWeight = number;
5239 export type VolumeSizeInGB = number;
5240 export interface VpcConfig {
5241 /**
5242 * The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
5243 */
5244 SecurityGroupIds: VpcSecurityGroupIds;
5245 /**
5246 * The ID of the subnets in the VPC to which you want to connect your training job or model. Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.
5247 */
5248 Subnets: Subnets;
5249 }
5250 export type VpcSecurityGroupIds = SecurityGroupId[];
5251 export interface Workteam {
5252 /**
5253 * The name of the work team.
5254 */
5255 WorkteamName: WorkteamName;
5256 /**
5257 * The Amazon Cognito user groups that make up the work team.
5258 */
5259 MemberDefinitions: MemberDefinitions;
5260 /**
5261 * The Amazon Resource Name (ARN) that identifies the work team.
5262 */
5263 WorkteamArn: WorkteamArn;
5264 /**
5265 * The Amazon Marketplace identifier for a vendor's work team.
5266 */
5267 ProductListingIds?: ProductListings;
5268 /**
5269 * A description of the work team.
5270 */
5271 Description: String200;
5272 /**
5273 * The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
5274 */
5275 SubDomain?: String;
5276 /**
5277 * The date and time that the work team was created (timestamp).
5278 */
5279 CreateDate?: Timestamp;
5280 /**
5281 * The date and time that the work team was last updated (timestamp).
5282 */
5283 LastUpdatedDate?: Timestamp;
5284 /**
5285 * Configures SNS notifications of available or expiring work items for work teams.
5286 */
5287 NotificationConfiguration?: NotificationConfiguration;
5288 }
5289 export type WorkteamArn = string;
5290 export type WorkteamName = string;
5291 export type Workteams = Workteam[];
5292 /**
5293 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
5294 */
5295 export type apiVersion = "2017-07-24"|"latest"|string;
5296 export interface ClientApiVersions {
5297 /**
5298 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
5299 */
5300 apiVersion?: apiVersion;
5301 }
5302 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
5303 /**
5304 * Contains interfaces for use with the SageMaker client.
5305 */
5306 export import Types = SageMaker;
5307}
5308export = SageMaker;