UNPKG

514 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 * Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
25 */
26 associateTrialComponent(params: SageMaker.Types.AssociateTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.AssociateTrialComponentResponse) => void): Request<SageMaker.Types.AssociateTrialComponentResponse, AWSError>;
27 /**
28 * Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
29 */
30 associateTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.AssociateTrialComponentResponse) => void): Request<SageMaker.Types.AssociateTrialComponentResponse, AWSError>;
31 /**
32 * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
33 */
34 createAlgorithm(params: SageMaker.Types.CreateAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
35 /**
36 * Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
37 */
38 createAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
39 /**
40 * Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Amazon SageMaker Studio (Studio) upon access to the associated Studio Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. Apps will automatically terminate and be deleted when stopped from within Studio, or when the DeleteApp API is manually called. UserProfiles are limited to 5 concurrently running Apps at a time.
41 */
42 createApp(params: SageMaker.Types.CreateAppRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateAppResponse) => void): Request<SageMaker.Types.CreateAppResponse, AWSError>;
43 /**
44 * Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Amazon SageMaker Studio (Studio) upon access to the associated Studio Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. Apps will automatically terminate and be deleted when stopped from within Studio, or when the DeleteApp API is manually called. UserProfiles are limited to 5 concurrently running Apps at a time.
45 */
46 createApp(callback?: (err: AWSError, data: SageMaker.Types.CreateAppResponse) => void): Request<SageMaker.Types.CreateAppResponse, AWSError>;
47 /**
48 * Creates an AutoPilot job. After you run an AutoPilot job, you can find the best performing model by calling , and then deploy that model by following the steps described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services. For information about how to use AutoPilot, see Use AutoPilot to Automate Model Development.
49 */
50 createAutoMLJob(params: SageMaker.Types.CreateAutoMLJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateAutoMLJobResponse) => void): Request<SageMaker.Types.CreateAutoMLJobResponse, AWSError>;
51 /**
52 * Creates an AutoPilot job. After you run an AutoPilot job, you can find the best performing model by calling , and then deploy that model by following the steps described in Step 6.1: Deploy the Model to Amazon SageMaker Hosting Services. For information about how to use AutoPilot, see Use AutoPilot to Automate Model Development.
53 */
54 createAutoMLJob(callback?: (err: AWSError, data: SageMaker.Types.CreateAutoMLJobResponse) => void): Request<SageMaker.Types.CreateAutoMLJobResponse, AWSError>;
55 /**
56 * 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.
57 */
58 createCodeRepository(params: SageMaker.Types.CreateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
59 /**
60 * 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.
61 */
62 createCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
63 /**
64 * 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.
65 */
66 createCompilationJob(params: SageMaker.Types.CreateCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request<SageMaker.Types.CreateCompilationJobResponse, AWSError>;
67 /**
68 * 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.
69 */
70 createCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.CreateCompilationJobResponse) => void): Request<SageMaker.Types.CreateCompilationJobResponse, AWSError>;
71 /**
72 * Creates a Domain for Amazon SageMaker Amazon SageMaker Studio (Studio), which can be accessed by end-users in a web browser. A Domain has an associated directory, list of authorized users, and a variety of security, application, policies, and Amazon Virtual Private Cloud configurations. An AWS account is limited to one Domain, per region. Users within a domain can share notebook files and other artifacts with each other. When a Domain is created, an Amazon Elastic File System (EFS) is also created for use by all of the users within the Domain. Each user receives a private home directory within the EFS for notebooks, Git repositories, and data files.
73 */
74 createDomain(params: SageMaker.Types.CreateDomainRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateDomainResponse) => void): Request<SageMaker.Types.CreateDomainResponse, AWSError>;
75 /**
76 * Creates a Domain for Amazon SageMaker Amazon SageMaker Studio (Studio), which can be accessed by end-users in a web browser. A Domain has an associated directory, list of authorized users, and a variety of security, application, policies, and Amazon Virtual Private Cloud configurations. An AWS account is limited to one Domain, per region. Users within a domain can share notebook files and other artifacts with each other. When a Domain is created, an Amazon Elastic File System (EFS) is also created for use by all of the users within the Domain. Each user receives a private home directory within the EFS for notebooks, Git repositories, and data files.
77 */
78 createDomain(callback?: (err: AWSError, data: SageMaker.Types.CreateDomainResponse) => void): Request<SageMaker.Types.CreateDomainResponse, AWSError>;
79 /**
80 * 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 to deploy models using Amazon SageMaker hosting services. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)). You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an 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. 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 in an AWS Region in the AWS Identity and Access Management User Guide.
81 */
82 createEndpoint(params: SageMaker.Types.CreateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
83 /**
84 * 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 to deploy models using Amazon SageMaker hosting services. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)). You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an 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. 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 in an AWS Region in the AWS Identity and Access Management User Guide.
85 */
86 createEndpoint(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
87 /**
88 * 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 if you want to use Amazon SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want 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. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
89 */
90 createEndpointConfig(params: SageMaker.Types.CreateEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
91 /**
92 * 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 if you want to use Amazon SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want 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. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
93 */
94 createEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
95 /**
96 * Creates an Amazon SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to experiments, trials, trial components and then use the Search API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
97 */
98 createExperiment(params: SageMaker.Types.CreateExperimentRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateExperimentResponse) => void): Request<SageMaker.Types.CreateExperimentResponse, AWSError>;
99 /**
100 * Creates an Amazon SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to experiments, trials, trial components and then use the Search API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API. To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
101 */
102 createExperiment(callback?: (err: AWSError, data: SageMaker.Types.CreateExperimentResponse) => void): Request<SageMaker.Types.CreateExperimentResponse, AWSError>;
103 /**
104 * Creates a flow definition.
105 */
106 createFlowDefinition(params: SageMaker.Types.CreateFlowDefinitionRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateFlowDefinitionResponse) => void): Request<SageMaker.Types.CreateFlowDefinitionResponse, AWSError>;
107 /**
108 * Creates a flow definition.
109 */
110 createFlowDefinition(callback?: (err: AWSError, data: SageMaker.Types.CreateFlowDefinitionResponse) => void): Request<SageMaker.Types.CreateFlowDefinitionResponse, AWSError>;
111 /**
112 * Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
113 */
114 createHumanTaskUi(params: SageMaker.Types.CreateHumanTaskUiRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateHumanTaskUiResponse) => void): Request<SageMaker.Types.CreateHumanTaskUiResponse, AWSError>;
115 /**
116 * Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
117 */
118 createHumanTaskUi(callback?: (err: AWSError, data: SageMaker.Types.CreateHumanTaskUiResponse) => void): Request<SageMaker.Types.CreateHumanTaskUiResponse, AWSError>;
119 /**
120 * 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.
121 */
122 createHyperParameterTuningJob(params: SageMaker.Types.CreateHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.CreateHyperParameterTuningJobResponse, AWSError>;
123 /**
124 * 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.
125 */
126 createHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.CreateHyperParameterTuningJobResponse, AWSError>;
127 /**
128 * 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.
129 */
130 createLabelingJob(params: SageMaker.Types.CreateLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request<SageMaker.Types.CreateLabelingJobResponse, AWSError>;
131 /**
132 * 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.
133 */
134 createLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request<SageMaker.Types.CreateLabelingJobResponse, AWSError>;
135 /**
136 * 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 that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use 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. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)). 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.
137 */
138 createModel(params: SageMaker.Types.CreateModelInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
139 /**
140 * 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 that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use 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. For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)). 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.
141 */
142 createModel(callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
143 /**
144 * 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.
145 */
146 createModelPackage(params: SageMaker.Types.CreateModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
147 /**
148 * 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.
149 */
150 createModelPackage(callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
151 /**
152 * Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.
153 */
154 createMonitoringSchedule(params: SageMaker.Types.CreateMonitoringScheduleRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateMonitoringScheduleResponse) => void): Request<SageMaker.Types.CreateMonitoringScheduleResponse, AWSError>;
155 /**
156 * Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.
157 */
158 createMonitoringSchedule(callback?: (err: AWSError, data: SageMaker.Types.CreateMonitoringScheduleResponse) => void): Request<SageMaker.Types.CreateMonitoringScheduleResponse, AWSError>;
159 /**
160 * 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.
161 */
162 createNotebookInstance(params: SageMaker.Types.CreateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
163 /**
164 * 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.
165 */
166 createNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
167 /**
168 * 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.
169 */
170 createNotebookInstanceLifecycleConfig(params: SageMaker.Types.CreateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput, AWSError>;
171 /**
172 * 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.
173 */
174 createNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceLifecycleConfigOutput, AWSError>;
175 /**
176 * Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Amazon SageMaker Studio (Studio), and granted access to all of the Apps and files associated with that Amazon Elastic File System (EFS). This operation can only be called when AuthMode equals IAM.
177 */
178 createPresignedDomainUrl(params: SageMaker.Types.CreatePresignedDomainUrlRequest, callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedDomainUrlResponse) => void): Request<SageMaker.Types.CreatePresignedDomainUrlResponse, AWSError>;
179 /**
180 * Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Amazon SageMaker Studio (Studio), and granted access to all of the Apps and files associated with that Amazon Elastic File System (EFS). This operation can only be called when AuthMode equals IAM.
181 */
182 createPresignedDomainUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedDomainUrlResponse) => void): Request<SageMaker.Types.CreatePresignedDomainUrlResponse, AWSError>;
183 /**
184 * 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 CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
185 */
186 createPresignedNotebookInstanceUrl(params: SageMaker.Types.CreatePresignedNotebookInstanceUrlInput, callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
187 /**
188 * 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 CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
189 */
190 createPresignedNotebookInstanceUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
191 /**
192 * Creates a processing job.
193 */
194 createProcessingJob(params: SageMaker.Types.CreateProcessingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateProcessingJobResponse) => void): Request<SageMaker.Types.CreateProcessingJobResponse, AWSError>;
195 /**
196 * Creates a processing job.
197 */
198 createProcessingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateProcessingJobResponse) => void): Request<SageMaker.Types.CreateProcessingJobResponse, AWSError>;
199 /**
200 * 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 wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
201 */
202 createTrainingJob(params: SageMaker.Types.CreateTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
203 /**
204 * 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 wait for a managed spot training job to complete. For more information about Amazon SageMaker, see How It Works.
205 */
206 createTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
207 /**
208 * 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, see Batch Transform.
209 */
210 createTransformJob(params: SageMaker.Types.CreateTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request<SageMaker.Types.CreateTransformJobResponse, AWSError>;
211 /**
212 * 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, see Batch Transform.
213 */
214 createTransformJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTransformJobResponse) => void): Request<SageMaker.Types.CreateTransformJobResponse, AWSError>;
215 /**
216 * Creates an Amazon SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single Amazon SageMaker experiment. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial and then use the Search API to search for the tags. To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
217 */
218 createTrial(params: SageMaker.Types.CreateTrialRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrialResponse) => void): Request<SageMaker.Types.CreateTrialResponse, AWSError>;
219 /**
220 * Creates an Amazon SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single Amazon SageMaker experiment. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial and then use the Search API to search for the tags. To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
221 */
222 createTrial(callback?: (err: AWSError, data: SageMaker.Types.CreateTrialResponse) => void): Request<SageMaker.Types.CreateTrialResponse, AWSError>;
223 /**
224 * Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and then use the Search API to search for the tags. CreateTrialComponent can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error.
225 */
226 createTrialComponent(params: SageMaker.Types.CreateTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrialComponentResponse) => void): Request<SageMaker.Types.CreateTrialComponentResponse, AWSError>;
227 /**
228 * Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and then use the Search API to search for the tags. CreateTrialComponent can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error.
229 */
230 createTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.CreateTrialComponentResponse) => void): Request<SageMaker.Types.CreateTrialComponentResponse, AWSError>;
231 /**
232 * Creates a new user profile. A user profile represents a single user within a Domain, and is the main way to reference a "person" for the purposes of sharing, reporting and other user-oriented features. This entity is created during on-boarding. If an administrator invites a person by email or imports them from SSO, a new UserProfile is automatically created. This entity is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
233 */
234 createUserProfile(params: SageMaker.Types.CreateUserProfileRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateUserProfileResponse) => void): Request<SageMaker.Types.CreateUserProfileResponse, AWSError>;
235 /**
236 * Creates a new user profile. A user profile represents a single user within a Domain, and is the main way to reference a "person" for the purposes of sharing, reporting and other user-oriented features. This entity is created during on-boarding. If an administrator invites a person by email or imports them from SSO, a new UserProfile is automatically created. This entity is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
237 */
238 createUserProfile(callback?: (err: AWSError, data: SageMaker.Types.CreateUserProfileResponse) => void): Request<SageMaker.Types.CreateUserProfileResponse, AWSError>;
239 /**
240 * 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.
241 */
242 createWorkteam(params: SageMaker.Types.CreateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request<SageMaker.Types.CreateWorkteamResponse, AWSError>;
243 /**
244 * 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.
245 */
246 createWorkteam(callback?: (err: AWSError, data: SageMaker.Types.CreateWorkteamResponse) => void): Request<SageMaker.Types.CreateWorkteamResponse, AWSError>;
247 /**
248 * Removes the specified algorithm from your account.
249 */
250 deleteAlgorithm(params: SageMaker.Types.DeleteAlgorithmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
251 /**
252 * Removes the specified algorithm from your account.
253 */
254 deleteAlgorithm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
255 /**
256 * Used to stop and delete an app.
257 */
258 deleteApp(params: SageMaker.Types.DeleteAppRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
259 /**
260 * Used to stop and delete an app.
261 */
262 deleteApp(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
263 /**
264 * Deletes the specified Git repository from your account.
265 */
266 deleteCodeRepository(params: SageMaker.Types.DeleteCodeRepositoryInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
267 /**
268 * Deletes the specified Git repository from your account.
269 */
270 deleteCodeRepository(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
271 /**
272 * Used to delete a domain. If you on-boarded with IAM mode, you will need to delete your domain to on-board again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
273 */
274 deleteDomain(params: SageMaker.Types.DeleteDomainRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
275 /**
276 * Used to delete a domain. If you on-boarded with IAM mode, you will need to delete your domain to on-board again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
277 */
278 deleteDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
279 /**
280 * 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.
281 */
282 deleteEndpoint(params: SageMaker.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
283 /**
284 * 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.
285 */
286 deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
287 /**
288 * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
289 */
290 deleteEndpointConfig(params: SageMaker.Types.DeleteEndpointConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
291 /**
292 * Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
293 */
294 deleteEndpointConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
295 /**
296 * Deletes an Amazon SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
297 */
298 deleteExperiment(params: SageMaker.Types.DeleteExperimentRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteExperimentResponse) => void): Request<SageMaker.Types.DeleteExperimentResponse, AWSError>;
299 /**
300 * Deletes an Amazon SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
301 */
302 deleteExperiment(callback?: (err: AWSError, data: SageMaker.Types.DeleteExperimentResponse) => void): Request<SageMaker.Types.DeleteExperimentResponse, AWSError>;
303 /**
304 * Deletes the specified flow definition.
305 */
306 deleteFlowDefinition(params: SageMaker.Types.DeleteFlowDefinitionRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteFlowDefinitionResponse) => void): Request<SageMaker.Types.DeleteFlowDefinitionResponse, AWSError>;
307 /**
308 * Deletes the specified flow definition.
309 */
310 deleteFlowDefinition(callback?: (err: AWSError, data: SageMaker.Types.DeleteFlowDefinitionResponse) => void): Request<SageMaker.Types.DeleteFlowDefinitionResponse, AWSError>;
311 /**
312 * 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.
313 */
314 deleteModel(params: SageMaker.Types.DeleteModelInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
315 /**
316 * 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.
317 */
318 deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
319 /**
320 * 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.
321 */
322 deleteModelPackage(params: SageMaker.Types.DeleteModelPackageInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
323 /**
324 * 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.
325 */
326 deleteModelPackage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
327 /**
328 * Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
329 */
330 deleteMonitoringSchedule(params: SageMaker.Types.DeleteMonitoringScheduleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
331 /**
332 * Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
333 */
334 deleteMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
335 /**
336 * 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.
337 */
338 deleteNotebookInstance(params: SageMaker.Types.DeleteNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
339 /**
340 * 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.
341 */
342 deleteNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
343 /**
344 * Deletes a notebook instance lifecycle configuration.
345 */
346 deleteNotebookInstanceLifecycleConfig(params: SageMaker.Types.DeleteNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
347 /**
348 * Deletes a notebook instance lifecycle configuration.
349 */
350 deleteNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
351 /**
352 * 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.
353 */
354 deleteTags(params: SageMaker.Types.DeleteTagsInput, callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
355 /**
356 * 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.
357 */
358 deleteTags(callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
359 /**
360 * Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
361 */
362 deleteTrial(params: SageMaker.Types.DeleteTrialRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteTrialResponse) => void): Request<SageMaker.Types.DeleteTrialResponse, AWSError>;
363 /**
364 * Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
365 */
366 deleteTrial(callback?: (err: AWSError, data: SageMaker.Types.DeleteTrialResponse) => void): Request<SageMaker.Types.DeleteTrialResponse, AWSError>;
367 /**
368 * Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
369 */
370 deleteTrialComponent(params: SageMaker.Types.DeleteTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteTrialComponentResponse) => void): Request<SageMaker.Types.DeleteTrialComponentResponse, AWSError>;
371 /**
372 * Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
373 */
374 deleteTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.DeleteTrialComponentResponse) => void): Request<SageMaker.Types.DeleteTrialComponentResponse, AWSError>;
375 /**
376 * Deletes a user profile.
377 */
378 deleteUserProfile(params: SageMaker.Types.DeleteUserProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
379 /**
380 * Deletes a user profile.
381 */
382 deleteUserProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
383 /**
384 * Deletes an existing work team. This operation can't be undone.
385 */
386 deleteWorkteam(params: SageMaker.Types.DeleteWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request<SageMaker.Types.DeleteWorkteamResponse, AWSError>;
387 /**
388 * Deletes an existing work team. This operation can't be undone.
389 */
390 deleteWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DeleteWorkteamResponse) => void): Request<SageMaker.Types.DeleteWorkteamResponse, AWSError>;
391 /**
392 * Returns a description of the specified algorithm that is in your account.
393 */
394 describeAlgorithm(params: SageMaker.Types.DescribeAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request<SageMaker.Types.DescribeAlgorithmOutput, AWSError>;
395 /**
396 * Returns a description of the specified algorithm that is in your account.
397 */
398 describeAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.DescribeAlgorithmOutput) => void): Request<SageMaker.Types.DescribeAlgorithmOutput, AWSError>;
399 /**
400 * Describes the app.
401 */
402 describeApp(params: SageMaker.Types.DescribeAppRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeAppResponse) => void): Request<SageMaker.Types.DescribeAppResponse, AWSError>;
403 /**
404 * Describes the app.
405 */
406 describeApp(callback?: (err: AWSError, data: SageMaker.Types.DescribeAppResponse) => void): Request<SageMaker.Types.DescribeAppResponse, AWSError>;
407 /**
408 * Returns information about an Amazon SageMaker job.
409 */
410 describeAutoMLJob(params: SageMaker.Types.DescribeAutoMLJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeAutoMLJobResponse) => void): Request<SageMaker.Types.DescribeAutoMLJobResponse, AWSError>;
411 /**
412 * Returns information about an Amazon SageMaker job.
413 */
414 describeAutoMLJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeAutoMLJobResponse) => void): Request<SageMaker.Types.DescribeAutoMLJobResponse, AWSError>;
415 /**
416 * Gets details about the specified Git repository.
417 */
418 describeCodeRepository(params: SageMaker.Types.DescribeCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request<SageMaker.Types.DescribeCodeRepositoryOutput, AWSError>;
419 /**
420 * Gets details about the specified Git repository.
421 */
422 describeCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.DescribeCodeRepositoryOutput) => void): Request<SageMaker.Types.DescribeCodeRepositoryOutput, AWSError>;
423 /**
424 * 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.
425 */
426 describeCompilationJob(params: SageMaker.Types.DescribeCompilationJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request<SageMaker.Types.DescribeCompilationJobResponse, AWSError>;
427 /**
428 * 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.
429 */
430 describeCompilationJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeCompilationJobResponse) => void): Request<SageMaker.Types.DescribeCompilationJobResponse, AWSError>;
431 /**
432 * The desciption of the domain.
433 */
434 describeDomain(params: SageMaker.Types.DescribeDomainRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeDomainResponse) => void): Request<SageMaker.Types.DescribeDomainResponse, AWSError>;
435 /**
436 * The desciption of the domain.
437 */
438 describeDomain(callback?: (err: AWSError, data: SageMaker.Types.DescribeDomainResponse) => void): Request<SageMaker.Types.DescribeDomainResponse, AWSError>;
439 /**
440 * Returns the description of an endpoint.
441 */
442 describeEndpoint(params: SageMaker.Types.DescribeEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
443 /**
444 * Returns the description of an endpoint.
445 */
446 describeEndpoint(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
447 /**
448 * Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
449 */
450 describeEndpointConfig(params: SageMaker.Types.DescribeEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request<SageMaker.Types.DescribeEndpointConfigOutput, AWSError>;
451 /**
452 * Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
453 */
454 describeEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointConfigOutput) => void): Request<SageMaker.Types.DescribeEndpointConfigOutput, AWSError>;
455 /**
456 * Provides a list of an experiment's properties.
457 */
458 describeExperiment(params: SageMaker.Types.DescribeExperimentRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeExperimentResponse) => void): Request<SageMaker.Types.DescribeExperimentResponse, AWSError>;
459 /**
460 * Provides a list of an experiment's properties.
461 */
462 describeExperiment(callback?: (err: AWSError, data: SageMaker.Types.DescribeExperimentResponse) => void): Request<SageMaker.Types.DescribeExperimentResponse, AWSError>;
463 /**
464 * Returns information about the specified flow definition.
465 */
466 describeFlowDefinition(params: SageMaker.Types.DescribeFlowDefinitionRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeFlowDefinitionResponse) => void): Request<SageMaker.Types.DescribeFlowDefinitionResponse, AWSError>;
467 /**
468 * Returns information about the specified flow definition.
469 */
470 describeFlowDefinition(callback?: (err: AWSError, data: SageMaker.Types.DescribeFlowDefinitionResponse) => void): Request<SageMaker.Types.DescribeFlowDefinitionResponse, AWSError>;
471 /**
472 * Returns information about the requested human task user interface.
473 */
474 describeHumanTaskUi(params: SageMaker.Types.DescribeHumanTaskUiRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeHumanTaskUiResponse) => void): Request<SageMaker.Types.DescribeHumanTaskUiResponse, AWSError>;
475 /**
476 * Returns information about the requested human task user interface.
477 */
478 describeHumanTaskUi(callback?: (err: AWSError, data: SageMaker.Types.DescribeHumanTaskUiResponse) => void): Request<SageMaker.Types.DescribeHumanTaskUiResponse, AWSError>;
479 /**
480 * Gets a description of a hyperparameter tuning job.
481 */
482 describeHyperParameterTuningJob(params: SageMaker.Types.DescribeHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.DescribeHyperParameterTuningJobResponse, AWSError>;
483 /**
484 * Gets a description of a hyperparameter tuning job.
485 */
486 describeHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.DescribeHyperParameterTuningJobResponse, AWSError>;
487 /**
488 * Gets information about a labeling job.
489 */
490 describeLabelingJob(params: SageMaker.Types.DescribeLabelingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request<SageMaker.Types.DescribeLabelingJobResponse, AWSError>;
491 /**
492 * Gets information about a labeling job.
493 */
494 describeLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeLabelingJobResponse) => void): Request<SageMaker.Types.DescribeLabelingJobResponse, AWSError>;
495 /**
496 * Describes a model that you created using the CreateModel API.
497 */
498 describeModel(params: SageMaker.Types.DescribeModelInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request<SageMaker.Types.DescribeModelOutput, AWSError>;
499 /**
500 * Describes a model that you created using the CreateModel API.
501 */
502 describeModel(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelOutput) => void): Request<SageMaker.Types.DescribeModelOutput, AWSError>;
503 /**
504 * 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.
505 */
506 describeModelPackage(params: SageMaker.Types.DescribeModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request<SageMaker.Types.DescribeModelPackageOutput, AWSError>;
507 /**
508 * 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.
509 */
510 describeModelPackage(callback?: (err: AWSError, data: SageMaker.Types.DescribeModelPackageOutput) => void): Request<SageMaker.Types.DescribeModelPackageOutput, AWSError>;
511 /**
512 * Describes the schedule for a monitoring job.
513 */
514 describeMonitoringSchedule(params: SageMaker.Types.DescribeMonitoringScheduleRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeMonitoringScheduleResponse) => void): Request<SageMaker.Types.DescribeMonitoringScheduleResponse, AWSError>;
515 /**
516 * Describes the schedule for a monitoring job.
517 */
518 describeMonitoringSchedule(callback?: (err: AWSError, data: SageMaker.Types.DescribeMonitoringScheduleResponse) => void): Request<SageMaker.Types.DescribeMonitoringScheduleResponse, AWSError>;
519 /**
520 * Returns information about a notebook instance.
521 */
522 describeNotebookInstance(params: SageMaker.Types.DescribeNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
523 /**
524 * Returns information about a notebook instance.
525 */
526 describeNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
527 /**
528 * 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.
529 */
530 describeNotebookInstanceLifecycleConfig(params: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput, AWSError>;
531 /**
532 * 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.
533 */
534 describeNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceLifecycleConfigOutput, AWSError>;
535 /**
536 * Returns a description of a processing job.
537 */
538 describeProcessingJob(params: SageMaker.Types.DescribeProcessingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeProcessingJobResponse) => void): Request<SageMaker.Types.DescribeProcessingJobResponse, AWSError>;
539 /**
540 * Returns a description of a processing job.
541 */
542 describeProcessingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeProcessingJobResponse) => void): Request<SageMaker.Types.DescribeProcessingJobResponse, AWSError>;
543 /**
544 * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
545 */
546 describeSubscribedWorkteam(params: SageMaker.Types.DescribeSubscribedWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request<SageMaker.Types.DescribeSubscribedWorkteamResponse, AWSError>;
547 /**
548 * Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
549 */
550 describeSubscribedWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeSubscribedWorkteamResponse) => void): Request<SageMaker.Types.DescribeSubscribedWorkteamResponse, AWSError>;
551 /**
552 * Returns information about a training job.
553 */
554 describeTrainingJob(params: SageMaker.Types.DescribeTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
555 /**
556 * Returns information about a training job.
557 */
558 describeTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
559 /**
560 * Returns information about a transform job.
561 */
562 describeTransformJob(params: SageMaker.Types.DescribeTransformJobRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
563 /**
564 * Returns information about a transform job.
565 */
566 describeTransformJob(callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
567 /**
568 * Provides a list of a trial's properties.
569 */
570 describeTrial(params: SageMaker.Types.DescribeTrialRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrialResponse) => void): Request<SageMaker.Types.DescribeTrialResponse, AWSError>;
571 /**
572 * Provides a list of a trial's properties.
573 */
574 describeTrial(callback?: (err: AWSError, data: SageMaker.Types.DescribeTrialResponse) => void): Request<SageMaker.Types.DescribeTrialResponse, AWSError>;
575 /**
576 * Provides a list of a trials component's properties.
577 */
578 describeTrialComponent(params: SageMaker.Types.DescribeTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrialComponentResponse) => void): Request<SageMaker.Types.DescribeTrialComponentResponse, AWSError>;
579 /**
580 * Provides a list of a trials component's properties.
581 */
582 describeTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.DescribeTrialComponentResponse) => void): Request<SageMaker.Types.DescribeTrialComponentResponse, AWSError>;
583 /**
584 * Describes the user profile.
585 */
586 describeUserProfile(params: SageMaker.Types.DescribeUserProfileRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeUserProfileResponse) => void): Request<SageMaker.Types.DescribeUserProfileResponse, AWSError>;
587 /**
588 * Describes the user profile.
589 */
590 describeUserProfile(callback?: (err: AWSError, data: SageMaker.Types.DescribeUserProfileResponse) => void): Request<SageMaker.Types.DescribeUserProfileResponse, AWSError>;
591 /**
592 * Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks. This operation applies only to private workforces.
593 */
594 describeWorkforce(params: SageMaker.Types.DescribeWorkforceRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkforceResponse) => void): Request<SageMaker.Types.DescribeWorkforceResponse, AWSError>;
595 /**
596 * Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks. This operation applies only to private workforces.
597 */
598 describeWorkforce(callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkforceResponse) => void): Request<SageMaker.Types.DescribeWorkforceResponse, AWSError>;
599 /**
600 * 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).
601 */
602 describeWorkteam(params: SageMaker.Types.DescribeWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request<SageMaker.Types.DescribeWorkteamResponse, AWSError>;
603 /**
604 * 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).
605 */
606 describeWorkteam(callback?: (err: AWSError, data: SageMaker.Types.DescribeWorkteamResponse) => void): Request<SageMaker.Types.DescribeWorkteamResponse, AWSError>;
607 /**
608 * Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
609 */
610 disassociateTrialComponent(params: SageMaker.Types.DisassociateTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.DisassociateTrialComponentResponse) => void): Request<SageMaker.Types.DisassociateTrialComponentResponse, AWSError>;
611 /**
612 * Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API. To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
613 */
614 disassociateTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.DisassociateTrialComponentResponse) => void): Request<SageMaker.Types.DisassociateTrialComponentResponse, AWSError>;
615 /**
616 * 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.
617 */
618 getSearchSuggestions(params: SageMaker.Types.GetSearchSuggestionsRequest, callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request<SageMaker.Types.GetSearchSuggestionsResponse, AWSError>;
619 /**
620 * 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.
621 */
622 getSearchSuggestions(callback?: (err: AWSError, data: SageMaker.Types.GetSearchSuggestionsResponse) => void): Request<SageMaker.Types.GetSearchSuggestionsResponse, AWSError>;
623 /**
624 * Lists the machine learning algorithms that have been created.
625 */
626 listAlgorithms(params: SageMaker.Types.ListAlgorithmsInput, callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request<SageMaker.Types.ListAlgorithmsOutput, AWSError>;
627 /**
628 * Lists the machine learning algorithms that have been created.
629 */
630 listAlgorithms(callback?: (err: AWSError, data: SageMaker.Types.ListAlgorithmsOutput) => void): Request<SageMaker.Types.ListAlgorithmsOutput, AWSError>;
631 /**
632 * Lists apps.
633 */
634 listApps(params: SageMaker.Types.ListAppsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListAppsResponse) => void): Request<SageMaker.Types.ListAppsResponse, AWSError>;
635 /**
636 * Lists apps.
637 */
638 listApps(callback?: (err: AWSError, data: SageMaker.Types.ListAppsResponse) => void): Request<SageMaker.Types.ListAppsResponse, AWSError>;
639 /**
640 * Request a list of jobs.
641 */
642 listAutoMLJobs(params: SageMaker.Types.ListAutoMLJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListAutoMLJobsResponse) => void): Request<SageMaker.Types.ListAutoMLJobsResponse, AWSError>;
643 /**
644 * Request a list of jobs.
645 */
646 listAutoMLJobs(callback?: (err: AWSError, data: SageMaker.Types.ListAutoMLJobsResponse) => void): Request<SageMaker.Types.ListAutoMLJobsResponse, AWSError>;
647 /**
648 * List the Candidates created for the job.
649 */
650 listCandidatesForAutoMLJob(params: SageMaker.Types.ListCandidatesForAutoMLJobRequest, callback?: (err: AWSError, data: SageMaker.Types.ListCandidatesForAutoMLJobResponse) => void): Request<SageMaker.Types.ListCandidatesForAutoMLJobResponse, AWSError>;
651 /**
652 * List the Candidates created for the job.
653 */
654 listCandidatesForAutoMLJob(callback?: (err: AWSError, data: SageMaker.Types.ListCandidatesForAutoMLJobResponse) => void): Request<SageMaker.Types.ListCandidatesForAutoMLJobResponse, AWSError>;
655 /**
656 * Gets a list of the Git repositories in your account.
657 */
658 listCodeRepositories(params: SageMaker.Types.ListCodeRepositoriesInput, callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request<SageMaker.Types.ListCodeRepositoriesOutput, AWSError>;
659 /**
660 * Gets a list of the Git repositories in your account.
661 */
662 listCodeRepositories(callback?: (err: AWSError, data: SageMaker.Types.ListCodeRepositoriesOutput) => void): Request<SageMaker.Types.ListCodeRepositoriesOutput, AWSError>;
663 /**
664 * 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.
665 */
666 listCompilationJobs(params: SageMaker.Types.ListCompilationJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request<SageMaker.Types.ListCompilationJobsResponse, AWSError>;
667 /**
668 * 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.
669 */
670 listCompilationJobs(callback?: (err: AWSError, data: SageMaker.Types.ListCompilationJobsResponse) => void): Request<SageMaker.Types.ListCompilationJobsResponse, AWSError>;
671 /**
672 * Lists the domains.
673 */
674 listDomains(params: SageMaker.Types.ListDomainsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListDomainsResponse) => void): Request<SageMaker.Types.ListDomainsResponse, AWSError>;
675 /**
676 * Lists the domains.
677 */
678 listDomains(callback?: (err: AWSError, data: SageMaker.Types.ListDomainsResponse) => void): Request<SageMaker.Types.ListDomainsResponse, AWSError>;
679 /**
680 * Lists endpoint configurations.
681 */
682 listEndpointConfigs(params: SageMaker.Types.ListEndpointConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request<SageMaker.Types.ListEndpointConfigsOutput, AWSError>;
683 /**
684 * Lists endpoint configurations.
685 */
686 listEndpointConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointConfigsOutput) => void): Request<SageMaker.Types.ListEndpointConfigsOutput, AWSError>;
687 /**
688 * Lists endpoints.
689 */
690 listEndpoints(params: SageMaker.Types.ListEndpointsInput, callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request<SageMaker.Types.ListEndpointsOutput, AWSError>;
691 /**
692 * Lists endpoints.
693 */
694 listEndpoints(callback?: (err: AWSError, data: SageMaker.Types.ListEndpointsOutput) => void): Request<SageMaker.Types.ListEndpointsOutput, AWSError>;
695 /**
696 * Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
697 */
698 listExperiments(params: SageMaker.Types.ListExperimentsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListExperimentsResponse) => void): Request<SageMaker.Types.ListExperimentsResponse, AWSError>;
699 /**
700 * Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
701 */
702 listExperiments(callback?: (err: AWSError, data: SageMaker.Types.ListExperimentsResponse) => void): Request<SageMaker.Types.ListExperimentsResponse, AWSError>;
703 /**
704 * Returns information about the flow definitions in your account.
705 */
706 listFlowDefinitions(params: SageMaker.Types.ListFlowDefinitionsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListFlowDefinitionsResponse) => void): Request<SageMaker.Types.ListFlowDefinitionsResponse, AWSError>;
707 /**
708 * Returns information about the flow definitions in your account.
709 */
710 listFlowDefinitions(callback?: (err: AWSError, data: SageMaker.Types.ListFlowDefinitionsResponse) => void): Request<SageMaker.Types.ListFlowDefinitionsResponse, AWSError>;
711 /**
712 * Returns information about the human task user interfaces in your account.
713 */
714 listHumanTaskUis(params: SageMaker.Types.ListHumanTaskUisRequest, callback?: (err: AWSError, data: SageMaker.Types.ListHumanTaskUisResponse) => void): Request<SageMaker.Types.ListHumanTaskUisResponse, AWSError>;
715 /**
716 * Returns information about the human task user interfaces in your account.
717 */
718 listHumanTaskUis(callback?: (err: AWSError, data: SageMaker.Types.ListHumanTaskUisResponse) => void): Request<SageMaker.Types.ListHumanTaskUisResponse, AWSError>;
719 /**
720 * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
721 */
722 listHyperParameterTuningJobs(params: SageMaker.Types.ListHyperParameterTuningJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request<SageMaker.Types.ListHyperParameterTuningJobsResponse, AWSError>;
723 /**
724 * Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
725 */
726 listHyperParameterTuningJobs(callback?: (err: AWSError, data: SageMaker.Types.ListHyperParameterTuningJobsResponse) => void): Request<SageMaker.Types.ListHyperParameterTuningJobsResponse, AWSError>;
727 /**
728 * Gets a list of labeling jobs.
729 */
730 listLabelingJobs(params: SageMaker.Types.ListLabelingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request<SageMaker.Types.ListLabelingJobsResponse, AWSError>;
731 /**
732 * Gets a list of labeling jobs.
733 */
734 listLabelingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsResponse) => void): Request<SageMaker.Types.ListLabelingJobsResponse, AWSError>;
735 /**
736 * Gets a list of labeling jobs assigned to a specified work team.
737 */
738 listLabelingJobsForWorkteam(params: SageMaker.Types.ListLabelingJobsForWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request<SageMaker.Types.ListLabelingJobsForWorkteamResponse, AWSError>;
739 /**
740 * Gets a list of labeling jobs assigned to a specified work team.
741 */
742 listLabelingJobsForWorkteam(callback?: (err: AWSError, data: SageMaker.Types.ListLabelingJobsForWorkteamResponse) => void): Request<SageMaker.Types.ListLabelingJobsForWorkteamResponse, AWSError>;
743 /**
744 * Lists the model packages that have been created.
745 */
746 listModelPackages(params: SageMaker.Types.ListModelPackagesInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request<SageMaker.Types.ListModelPackagesOutput, AWSError>;
747 /**
748 * Lists the model packages that have been created.
749 */
750 listModelPackages(callback?: (err: AWSError, data: SageMaker.Types.ListModelPackagesOutput) => void): Request<SageMaker.Types.ListModelPackagesOutput, AWSError>;
751 /**
752 * Lists models created with the CreateModel API.
753 */
754 listModels(params: SageMaker.Types.ListModelsInput, callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request<SageMaker.Types.ListModelsOutput, AWSError>;
755 /**
756 * Lists models created with the CreateModel API.
757 */
758 listModels(callback?: (err: AWSError, data: SageMaker.Types.ListModelsOutput) => void): Request<SageMaker.Types.ListModelsOutput, AWSError>;
759 /**
760 * Returns list of all monitoring job executions.
761 */
762 listMonitoringExecutions(params: SageMaker.Types.ListMonitoringExecutionsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListMonitoringExecutionsResponse) => void): Request<SageMaker.Types.ListMonitoringExecutionsResponse, AWSError>;
763 /**
764 * Returns list of all monitoring job executions.
765 */
766 listMonitoringExecutions(callback?: (err: AWSError, data: SageMaker.Types.ListMonitoringExecutionsResponse) => void): Request<SageMaker.Types.ListMonitoringExecutionsResponse, AWSError>;
767 /**
768 * Returns list of all monitoring schedules.
769 */
770 listMonitoringSchedules(params: SageMaker.Types.ListMonitoringSchedulesRequest, callback?: (err: AWSError, data: SageMaker.Types.ListMonitoringSchedulesResponse) => void): Request<SageMaker.Types.ListMonitoringSchedulesResponse, AWSError>;
771 /**
772 * Returns list of all monitoring schedules.
773 */
774 listMonitoringSchedules(callback?: (err: AWSError, data: SageMaker.Types.ListMonitoringSchedulesResponse) => void): Request<SageMaker.Types.ListMonitoringSchedulesResponse, AWSError>;
775 /**
776 * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
777 */
778 listNotebookInstanceLifecycleConfigs(params: SageMaker.Types.ListNotebookInstanceLifecycleConfigsInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request<SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput, AWSError>;
779 /**
780 * Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
781 */
782 listNotebookInstanceLifecycleConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request<SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput, AWSError>;
783 /**
784 * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
785 */
786 listNotebookInstances(params: SageMaker.Types.ListNotebookInstancesInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
787 /**
788 * Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
789 */
790 listNotebookInstances(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
791 /**
792 * Lists processing jobs that satisfy various filters.
793 */
794 listProcessingJobs(params: SageMaker.Types.ListProcessingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListProcessingJobsResponse) => void): Request<SageMaker.Types.ListProcessingJobsResponse, AWSError>;
795 /**
796 * Lists processing jobs that satisfy various filters.
797 */
798 listProcessingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListProcessingJobsResponse) => void): Request<SageMaker.Types.ListProcessingJobsResponse, AWSError>;
799 /**
800 * 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.
801 */
802 listSubscribedWorkteams(params: SageMaker.Types.ListSubscribedWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request<SageMaker.Types.ListSubscribedWorkteamsResponse, AWSError>;
803 /**
804 * 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.
805 */
806 listSubscribedWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request<SageMaker.Types.ListSubscribedWorkteamsResponse, AWSError>;
807 /**
808 * Returns the tags for the specified Amazon SageMaker resource.
809 */
810 listTags(params: SageMaker.Types.ListTagsInput, callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
811 /**
812 * Returns the tags for the specified Amazon SageMaker resource.
813 */
814 listTags(callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
815 /**
816 * Lists training jobs.
817 */
818 listTrainingJobs(params: SageMaker.Types.ListTrainingJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request<SageMaker.Types.ListTrainingJobsResponse, AWSError>;
819 /**
820 * Lists training jobs.
821 */
822 listTrainingJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsResponse) => void): Request<SageMaker.Types.ListTrainingJobsResponse, AWSError>;
823 /**
824 * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
825 */
826 listTrainingJobsForHyperParameterTuningJob(params: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse, AWSError>;
827 /**
828 * Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
829 */
830 listTrainingJobsForHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.ListTrainingJobsForHyperParameterTuningJobResponse, AWSError>;
831 /**
832 * Lists transform jobs.
833 */
834 listTransformJobs(params: SageMaker.Types.ListTransformJobsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request<SageMaker.Types.ListTransformJobsResponse, AWSError>;
835 /**
836 * Lists transform jobs.
837 */
838 listTransformJobs(callback?: (err: AWSError, data: SageMaker.Types.ListTransformJobsResponse) => void): Request<SageMaker.Types.ListTransformJobsResponse, AWSError>;
839 /**
840 * Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: ExperimentName SourceArn TrialName
841 */
842 listTrialComponents(params: SageMaker.Types.ListTrialComponentsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrialComponentsResponse) => void): Request<SageMaker.Types.ListTrialComponentsResponse, AWSError>;
843 /**
844 * Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: ExperimentName SourceArn TrialName
845 */
846 listTrialComponents(callback?: (err: AWSError, data: SageMaker.Types.ListTrialComponentsResponse) => void): Request<SageMaker.Types.ListTrialComponentsResponse, AWSError>;
847 /**
848 * Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
849 */
850 listTrials(params: SageMaker.Types.ListTrialsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListTrialsResponse) => void): Request<SageMaker.Types.ListTrialsResponse, AWSError>;
851 /**
852 * Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.
853 */
854 listTrials(callback?: (err: AWSError, data: SageMaker.Types.ListTrialsResponse) => void): Request<SageMaker.Types.ListTrialsResponse, AWSError>;
855 /**
856 * Lists user profiles.
857 */
858 listUserProfiles(params: SageMaker.Types.ListUserProfilesRequest, callback?: (err: AWSError, data: SageMaker.Types.ListUserProfilesResponse) => void): Request<SageMaker.Types.ListUserProfilesResponse, AWSError>;
859 /**
860 * Lists user profiles.
861 */
862 listUserProfiles(callback?: (err: AWSError, data: SageMaker.Types.ListUserProfilesResponse) => void): Request<SageMaker.Types.ListUserProfilesResponse, AWSError>;
863 /**
864 * 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.
865 */
866 listWorkteams(params: SageMaker.Types.ListWorkteamsRequest, callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request<SageMaker.Types.ListWorkteamsResponse, AWSError>;
867 /**
868 * 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.
869 */
870 listWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListWorkteamsResponse) => void): Request<SageMaker.Types.ListWorkteamsResponse, AWSError>;
871 /**
872 * Renders the UI template so that you can preview the worker's experience.
873 */
874 renderUiTemplate(params: SageMaker.Types.RenderUiTemplateRequest, callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request<SageMaker.Types.RenderUiTemplateResponse, AWSError>;
875 /**
876 * Renders the UI template so that you can preview the worker's experience.
877 */
878 renderUiTemplate(callback?: (err: AWSError, data: SageMaker.Types.RenderUiTemplateResponse) => void): Request<SageMaker.Types.RenderUiTemplateResponse, AWSError>;
879 /**
880 * 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: numeric, text, Boolean, and timestamp.
881 */
882 search(params: SageMaker.Types.SearchRequest, callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request<SageMaker.Types.SearchResponse, AWSError>;
883 /**
884 * 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: numeric, text, Boolean, and timestamp.
885 */
886 search(callback?: (err: AWSError, data: SageMaker.Types.SearchResponse) => void): Request<SageMaker.Types.SearchResponse, AWSError>;
887 /**
888 * Starts a previously stopped monitoring schedule. New monitoring schedules are immediately started after creation.
889 */
890 startMonitoringSchedule(params: SageMaker.Types.StartMonitoringScheduleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
891 /**
892 * Starts a previously stopped monitoring schedule. New monitoring schedules are immediately started after creation.
893 */
894 startMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
895 /**
896 * 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.
897 */
898 startNotebookInstance(params: SageMaker.Types.StartNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
899 /**
900 * 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.
901 */
902 startNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
903 /**
904 * A method for forcing the termination of a running job.
905 */
906 stopAutoMLJob(params: SageMaker.Types.StopAutoMLJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
907 /**
908 * A method for forcing the termination of a running job.
909 */
910 stopAutoMLJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
911 /**
912 * 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.
913 */
914 stopCompilationJob(params: SageMaker.Types.StopCompilationJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
915 /**
916 * 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.
917 */
918 stopCompilationJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
919 /**
920 * 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.
921 */
922 stopHyperParameterTuningJob(params: SageMaker.Types.StopHyperParameterTuningJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
923 /**
924 * 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.
925 */
926 stopHyperParameterTuningJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
927 /**
928 * 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.
929 */
930 stopLabelingJob(params: SageMaker.Types.StopLabelingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
931 /**
932 * 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.
933 */
934 stopLabelingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
935 /**
936 * Stops a previously started monitoring schedule.
937 */
938 stopMonitoringSchedule(params: SageMaker.Types.StopMonitoringScheduleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
939 /**
940 * Stops a previously started monitoring schedule.
941 */
942 stopMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
943 /**
944 * 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.
945 */
946 stopNotebookInstance(params: SageMaker.Types.StopNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
947 /**
948 * 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.
949 */
950 stopNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
951 /**
952 * Stops a processing job.
953 */
954 stopProcessingJob(params: SageMaker.Types.StopProcessingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
955 /**
956 * Stops a processing job.
957 */
958 stopProcessingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
959 /**
960 * 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.
961 */
962 stopTrainingJob(params: SageMaker.Types.StopTrainingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
963 /**
964 * 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.
965 */
966 stopTrainingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
967 /**
968 * 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.
969 */
970 stopTransformJob(params: SageMaker.Types.StopTransformJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
971 /**
972 * 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.
973 */
974 stopTransformJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
975 /**
976 * Updates the specified Git repository with the specified values.
977 */
978 updateCodeRepository(params: SageMaker.Types.UpdateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request<SageMaker.Types.UpdateCodeRepositoryOutput, AWSError>;
979 /**
980 * Updates the specified Git repository with the specified values.
981 */
982 updateCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.UpdateCodeRepositoryOutput) => void): Request<SageMaker.Types.UpdateCodeRepositoryOutput, AWSError>;
983 /**
984 * Updates a domain. Changes will impact all of the people in the domain.
985 */
986 updateDomain(params: SageMaker.Types.UpdateDomainRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateDomainResponse) => void): Request<SageMaker.Types.UpdateDomainResponse, AWSError>;
987 /**
988 * Updates a domain. Changes will impact all of the people in the domain.
989 */
990 updateDomain(callback?: (err: AWSError, data: SageMaker.Types.UpdateDomainResponse) => void): Request<SageMaker.Types.UpdateDomainResponse, AWSError>;
991 /**
992 * 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.
993 */
994 updateEndpoint(params: SageMaker.Types.UpdateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
995 /**
996 * 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.
997 */
998 updateEndpoint(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
999 /**
1000 * 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.
1001 */
1002 updateEndpointWeightsAndCapacities(params: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
1003 /**
1004 * 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.
1005 */
1006 updateEndpointWeightsAndCapacities(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
1007 /**
1008 * Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
1009 */
1010 updateExperiment(params: SageMaker.Types.UpdateExperimentRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateExperimentResponse) => void): Request<SageMaker.Types.UpdateExperimentResponse, AWSError>;
1011 /**
1012 * Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
1013 */
1014 updateExperiment(callback?: (err: AWSError, data: SageMaker.Types.UpdateExperimentResponse) => void): Request<SageMaker.Types.UpdateExperimentResponse, AWSError>;
1015 /**
1016 * Updates a previously created schedule.
1017 */
1018 updateMonitoringSchedule(params: SageMaker.Types.UpdateMonitoringScheduleRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateMonitoringScheduleResponse) => void): Request<SageMaker.Types.UpdateMonitoringScheduleResponse, AWSError>;
1019 /**
1020 * Updates a previously created schedule.
1021 */
1022 updateMonitoringSchedule(callback?: (err: AWSError, data: SageMaker.Types.UpdateMonitoringScheduleResponse) => void): Request<SageMaker.Types.UpdateMonitoringScheduleResponse, AWSError>;
1023 /**
1024 * 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.
1025 */
1026 updateNotebookInstance(params: SageMaker.Types.UpdateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceOutput, AWSError>;
1027 /**
1028 * 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.
1029 */
1030 updateNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceOutput, AWSError>;
1031 /**
1032 * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
1033 */
1034 updateNotebookInstanceLifecycleConfig(params: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput, AWSError>;
1035 /**
1036 * Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
1037 */
1038 updateNotebookInstanceLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput) => void): Request<SageMaker.Types.UpdateNotebookInstanceLifecycleConfigOutput, AWSError>;
1039 /**
1040 * Updates the display name of a trial.
1041 */
1042 updateTrial(params: SageMaker.Types.UpdateTrialRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateTrialResponse) => void): Request<SageMaker.Types.UpdateTrialResponse, AWSError>;
1043 /**
1044 * Updates the display name of a trial.
1045 */
1046 updateTrial(callback?: (err: AWSError, data: SageMaker.Types.UpdateTrialResponse) => void): Request<SageMaker.Types.UpdateTrialResponse, AWSError>;
1047 /**
1048 * Updates one or more properties of a trial component.
1049 */
1050 updateTrialComponent(params: SageMaker.Types.UpdateTrialComponentRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateTrialComponentResponse) => void): Request<SageMaker.Types.UpdateTrialComponentResponse, AWSError>;
1051 /**
1052 * Updates one or more properties of a trial component.
1053 */
1054 updateTrialComponent(callback?: (err: AWSError, data: SageMaker.Types.UpdateTrialComponentResponse) => void): Request<SageMaker.Types.UpdateTrialComponentResponse, AWSError>;
1055 /**
1056 * Updates a user profile.
1057 */
1058 updateUserProfile(params: SageMaker.Types.UpdateUserProfileRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateUserProfileResponse) => void): Request<SageMaker.Types.UpdateUserProfileResponse, AWSError>;
1059 /**
1060 * Updates a user profile.
1061 */
1062 updateUserProfile(callback?: (err: AWSError, data: SageMaker.Types.UpdateUserProfileResponse) => void): Request<SageMaker.Types.UpdateUserProfileResponse, AWSError>;
1063 /**
1064 * Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to four CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied access and get a Not Found error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the operation. This operation applies only to private workforces.
1065 */
1066 updateWorkforce(params: SageMaker.Types.UpdateWorkforceRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkforceResponse) => void): Request<SageMaker.Types.UpdateWorkforceResponse, AWSError>;
1067 /**
1068 * Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to four CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied access and get a Not Found error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the operation. This operation applies only to private workforces.
1069 */
1070 updateWorkforce(callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkforceResponse) => void): Request<SageMaker.Types.UpdateWorkforceResponse, AWSError>;
1071 /**
1072 * Updates an existing work team with new member definitions or description.
1073 */
1074 updateWorkteam(params: SageMaker.Types.UpdateWorkteamRequest, callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request<SageMaker.Types.UpdateWorkteamResponse, AWSError>;
1075 /**
1076 * Updates an existing work team with new member definitions or description.
1077 */
1078 updateWorkteam(callback?: (err: AWSError, data: SageMaker.Types.UpdateWorkteamResponse) => void): Request<SageMaker.Types.UpdateWorkteamResponse, AWSError>;
1079 /**
1080 * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1081 */
1082 waitFor(state: "notebookInstanceInService", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1083 /**
1084 * Waits for the notebookInstanceInService state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1085 */
1086 waitFor(state: "notebookInstanceInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1087 /**
1088 * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1089 */
1090 waitFor(state: "notebookInstanceStopped", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1091 /**
1092 * Waits for the notebookInstanceStopped state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1093 */
1094 waitFor(state: "notebookInstanceStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1095 /**
1096 * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1097 */
1098 waitFor(state: "notebookInstanceDeleted", params: SageMaker.Types.DescribeNotebookInstanceInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1099 /**
1100 * Waits for the notebookInstanceDeleted state by periodically calling the underlying SageMaker.describeNotebookInstanceoperation every 30 seconds (at most 60 times).
1101 */
1102 waitFor(state: "notebookInstanceDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeNotebookInstanceOutput) => void): Request<SageMaker.Types.DescribeNotebookInstanceOutput, AWSError>;
1103 /**
1104 * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times).
1105 */
1106 waitFor(state: "trainingJobCompletedOrStopped", params: SageMaker.Types.DescribeTrainingJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
1107 /**
1108 * Waits for the trainingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTrainingJoboperation every 120 seconds (at most 180 times).
1109 */
1110 waitFor(state: "trainingJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTrainingJobResponse) => void): Request<SageMaker.Types.DescribeTrainingJobResponse, AWSError>;
1111 /**
1112 * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times).
1113 */
1114 waitFor(state: "endpointInService", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
1115 /**
1116 * Waits for the endpointInService state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 120 times).
1117 */
1118 waitFor(state: "endpointInService", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
1119 /**
1120 * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times).
1121 */
1122 waitFor(state: "endpointDeleted", params: SageMaker.Types.DescribeEndpointInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
1123 /**
1124 * Waits for the endpointDeleted state by periodically calling the underlying SageMaker.describeEndpointoperation every 30 seconds (at most 60 times).
1125 */
1126 waitFor(state: "endpointDeleted", callback?: (err: AWSError, data: SageMaker.Types.DescribeEndpointOutput) => void): Request<SageMaker.Types.DescribeEndpointOutput, AWSError>;
1127 /**
1128 * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times).
1129 */
1130 waitFor(state: "transformJobCompletedOrStopped", params: SageMaker.Types.DescribeTransformJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
1131 /**
1132 * Waits for the transformJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeTransformJoboperation every 60 seconds (at most 60 times).
1133 */
1134 waitFor(state: "transformJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeTransformJobResponse) => void): Request<SageMaker.Types.DescribeTransformJobResponse, AWSError>;
1135 /**
1136 * Waits for the processingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeProcessingJoboperation every 60 seconds (at most 60 times).
1137 */
1138 waitFor(state: "processingJobCompletedOrStopped", params: SageMaker.Types.DescribeProcessingJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SageMaker.Types.DescribeProcessingJobResponse) => void): Request<SageMaker.Types.DescribeProcessingJobResponse, AWSError>;
1139 /**
1140 * Waits for the processingJobCompletedOrStopped state by periodically calling the underlying SageMaker.describeProcessingJoboperation every 60 seconds (at most 60 times).
1141 */
1142 waitFor(state: "processingJobCompletedOrStopped", callback?: (err: AWSError, data: SageMaker.Types.DescribeProcessingJobResponse) => void): Request<SageMaker.Types.DescribeProcessingJobResponse, AWSError>;
1143}
1144declare namespace SageMaker {
1145 export type Accept = string;
1146 export type AccountId = string;
1147 export interface AddTagsInput {
1148 /**
1149 * The Amazon Resource Name (ARN) of the resource that you want to tag.
1150 */
1151 ResourceArn: ResourceArn;
1152 /**
1153 * 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.
1154 */
1155 Tags: TagList;
1156 }
1157 export interface AddTagsOutput {
1158 /**
1159 * A list of tags associated with the Amazon SageMaker resource.
1160 */
1161 Tags?: TagList;
1162 }
1163 export type AdditionalCodeRepositoryNamesOrUrls = CodeRepositoryNameOrUrl[];
1164 export type AlgorithmArn = string;
1165 export type AlgorithmImage = string;
1166 export type AlgorithmSortBy = "Name"|"CreationTime"|string;
1167 export interface AlgorithmSpecification {
1168 /**
1169 * 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.
1170 */
1171 TrainingImage?: AlgorithmImage;
1172 /**
1173 * 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.
1174 */
1175 AlgorithmName?: ArnOrName;
1176 /**
1177 * 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.
1178 */
1179 TrainingInputMode: TrainingInputMode;
1180 /**
1181 * 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.
1182 */
1183 MetricDefinitions?: MetricDefinitionList;
1184 /**
1185 * To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases: You use one of the Amazon SageMaker built-in algorithms You use one of the following Prebuilt Amazon SageMaker Docker Images: Tensorflow (version &gt;= 1.15) MXNet (version &gt;= 1.6) PyTorch (version &gt;= 1.3) You specify at least one MetricDefinition
1186 */
1187 EnableSageMakerMetricsTimeSeries?: Boolean;
1188 }
1189 export type AlgorithmStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string;
1190 export interface AlgorithmStatusDetails {
1191 /**
1192 * The status of algorithm validation.
1193 */
1194 ValidationStatuses?: AlgorithmStatusItemList;
1195 /**
1196 * The status of the scan of the algorithm's Docker image container.
1197 */
1198 ImageScanStatuses?: AlgorithmStatusItemList;
1199 }
1200 export interface AlgorithmStatusItem {
1201 /**
1202 * The name of the algorithm for which the overall status is being reported.
1203 */
1204 Name: EntityName;
1205 /**
1206 * The current status.
1207 */
1208 Status: DetailedAlgorithmStatus;
1209 /**
1210 * if the overall status is Failed, the reason for the failure.
1211 */
1212 FailureReason?: String;
1213 }
1214 export type AlgorithmStatusItemList = AlgorithmStatusItem[];
1215 export interface AlgorithmSummary {
1216 /**
1217 * The name of the algorithm that is described by the summary.
1218 */
1219 AlgorithmName: EntityName;
1220 /**
1221 * The Amazon Resource Name (ARN) of the algorithm.
1222 */
1223 AlgorithmArn: AlgorithmArn;
1224 /**
1225 * A brief description of the algorithm.
1226 */
1227 AlgorithmDescription?: EntityDescription;
1228 /**
1229 * A timestamp that shows when the algorithm was created.
1230 */
1231 CreationTime: CreationTime;
1232 /**
1233 * The overall status of the algorithm.
1234 */
1235 AlgorithmStatus: AlgorithmStatus;
1236 }
1237 export type AlgorithmSummaryList = AlgorithmSummary[];
1238 export interface AlgorithmValidationProfile {
1239 /**
1240 * 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).
1241 */
1242 ProfileName: EntityName;
1243 /**
1244 * The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.
1245 */
1246 TrainingJobDefinition: TrainingJobDefinition;
1247 /**
1248 * The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.
1249 */
1250 TransformJobDefinition?: TransformJobDefinition;
1251 }
1252 export type AlgorithmValidationProfiles = AlgorithmValidationProfile[];
1253 export interface AlgorithmValidationSpecification {
1254 /**
1255 * The IAM roles that Amazon SageMaker uses to run the training jobs.
1256 */
1257 ValidationRole: RoleArn;
1258 /**
1259 * An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.
1260 */
1261 ValidationProfiles: AlgorithmValidationProfiles;
1262 }
1263 export interface AnnotationConsolidationConfig {
1264 /**
1265 * 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 Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel 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 Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel Named entity recognition - 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 Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers. arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations. arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label. arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation For more information, see Annotation Consolidation.
1266 */
1267 AnnotationConsolidationLambdaArn: LambdaFunctionArn;
1268 }
1269 export type AppArn = string;
1270 export interface AppDetails {
1271 /**
1272 * The domain ID.
1273 */
1274 DomainId?: DomainId;
1275 /**
1276 * The user profile name.
1277 */
1278 UserProfileName?: UserProfileName;
1279 /**
1280 * The type of app.
1281 */
1282 AppType?: AppType;
1283 /**
1284 * The name of the app.
1285 */
1286 AppName?: AppName;
1287 /**
1288 * The status.
1289 */
1290 Status?: AppStatus;
1291 /**
1292 * The creation time.
1293 */
1294 CreationTime?: CreationTime;
1295 }
1296 export type AppInstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|string;
1297 export type AppList = AppDetails[];
1298 export type AppName = string;
1299 export type AppSortKey = "CreationTime"|string;
1300 export interface AppSpecification {
1301 /**
1302 * The container image to be run by the processing job.
1303 */
1304 ImageUri: ImageUri;
1305 /**
1306 * The entrypoint for a container used to run a processing job.
1307 */
1308 ContainerEntrypoint?: ContainerEntrypoint;
1309 /**
1310 * The arguments for a container used to run a processing job.
1311 */
1312 ContainerArguments?: ContainerArguments;
1313 }
1314 export type AppStatus = "Deleted"|"Deleting"|"Failed"|"InService"|"Pending"|string;
1315 export type AppType = "JupyterServer"|"KernelGateway"|"TensorBoard"|string;
1316 export type ArnOrName = string;
1317 export type AssemblyType = "None"|"Line"|string;
1318 export interface AssociateTrialComponentRequest {
1319 /**
1320 * The name of the component to associated with the trial.
1321 */
1322 TrialComponentName: ExperimentEntityName;
1323 /**
1324 * The name of the trial to associate with.
1325 */
1326 TrialName: ExperimentEntityName;
1327 }
1328 export interface AssociateTrialComponentResponse {
1329 /**
1330 * The ARN of the trial component.
1331 */
1332 TrialComponentArn?: TrialComponentArn;
1333 /**
1334 * The Amazon Resource Name (ARN) of the trial.
1335 */
1336 TrialArn?: TrialArn;
1337 }
1338 export type AttributeName = string;
1339 export type AttributeNames = AttributeName[];
1340 export type AuthMode = "SSO"|"IAM"|string;
1341 export interface AutoMLCandidate {
1342 /**
1343 * The candidate name.
1344 */
1345 CandidateName: CandidateName;
1346 FinalAutoMLJobObjectiveMetric?: FinalAutoMLJobObjectiveMetric;
1347 /**
1348 * The objective status.
1349 */
1350 ObjectiveStatus: ObjectiveStatus;
1351 /**
1352 * The candidate's steps.
1353 */
1354 CandidateSteps: CandidateSteps;
1355 /**
1356 * The candidate's status.
1357 */
1358 CandidateStatus: CandidateStatus;
1359 /**
1360 * The inference containers.
1361 */
1362 InferenceContainers?: AutoMLContainerDefinitions;
1363 /**
1364 * The creation time.
1365 */
1366 CreationTime: Timestamp;
1367 /**
1368 * The end time.
1369 */
1370 EndTime?: Timestamp;
1371 /**
1372 * The last modified time.
1373 */
1374 LastModifiedTime: Timestamp;
1375 /**
1376 * The failure reason.
1377 */
1378 FailureReason?: AutoMLFailureReason;
1379 }
1380 export interface AutoMLCandidateStep {
1381 /**
1382 * Whether the Candidate is at the transform, training, or processing step.
1383 */
1384 CandidateStepType: CandidateStepType;
1385 /**
1386 * The ARN for the Candidate's step.
1387 */
1388 CandidateStepArn: CandidateStepArn;
1389 /**
1390 * The name for the Candidate's step.
1391 */
1392 CandidateStepName: CandidateStepName;
1393 }
1394 export type AutoMLCandidates = AutoMLCandidate[];
1395 export interface AutoMLChannel {
1396 /**
1397 * The data source.
1398 */
1399 DataSource: AutoMLDataSource;
1400 /**
1401 * You can use Gzip or None. The default value is None.
1402 */
1403 CompressionType?: CompressionType;
1404 /**
1405 * The name of the target variable in supervised learning, a.k.a. 'y'.
1406 */
1407 TargetAttributeName: TargetAttributeName;
1408 }
1409 export interface AutoMLContainerDefinition {
1410 /**
1411 * The ECR path of the container. Refer to ContainerDefinition for more details.
1412 */
1413 Image: Image;
1414 /**
1415 * The location of the model artifacts. Refer to ContainerDefinition for more details.
1416 */
1417 ModelDataUrl: Url;
1418 /**
1419 * Environment variables to set in the container. Refer to ContainerDefinition for more details.
1420 */
1421 Environment?: EnvironmentMap;
1422 }
1423 export type AutoMLContainerDefinitions = AutoMLContainerDefinition[];
1424 export interface AutoMLDataSource {
1425 /**
1426 * The Amazon S3 location of the input data. The input data must be in CSV format and contain at least 1000 rows.
1427 */
1428 S3DataSource: AutoMLS3DataSource;
1429 }
1430 export type AutoMLFailureReason = string;
1431 export type AutoMLInputDataConfig = AutoMLChannel[];
1432 export type AutoMLJobArn = string;
1433 export interface AutoMLJobArtifacts {
1434 /**
1435 * The URL to the notebook location.
1436 */
1437 CandidateDefinitionNotebookLocation?: CandidateDefinitionNotebookLocation;
1438 /**
1439 * The URL to the notebook location.
1440 */
1441 DataExplorationNotebookLocation?: DataExplorationNotebookLocation;
1442 }
1443 export interface AutoMLJobCompletionCriteria {
1444 /**
1445 * The maximum number of times a training job is allowed to run.
1446 */
1447 MaxCandidates?: MaxCandidates;
1448 /**
1449 * The maximum time, in seconds, a job is allowed to run.
1450 */
1451 MaxRuntimePerTrainingJobInSeconds?: MaxRuntimePerTrainingJobInSeconds;
1452 /**
1453 * The maximum time, in seconds, an AutoML job is allowed to wait for a trial to complete. It must be equal to or greater than MaxRuntimePerTrainingJobInSeconds.
1454 */
1455 MaxAutoMLJobRuntimeInSeconds?: MaxAutoMLJobRuntimeInSeconds;
1456 }
1457 export interface AutoMLJobConfig {
1458 /**
1459 * How long a job is allowed to run, or how many candidates a job is allowed to generate.
1460 */
1461 CompletionCriteria?: AutoMLJobCompletionCriteria;
1462 /**
1463 * Security configuration for traffic encryption or Amazon VPC settings.
1464 */
1465 SecurityConfig?: AutoMLSecurityConfig;
1466 }
1467 export type AutoMLJobName = string;
1468 export interface AutoMLJobObjective {
1469 /**
1470 * The name of the metric.
1471 */
1472 MetricName: AutoMLMetricEnum;
1473 }
1474 export type AutoMLJobObjectiveType = "Maximize"|"Minimize"|string;
1475 export type AutoMLJobSecondaryStatus = "Starting"|"AnalyzingData"|"FeatureEngineering"|"ModelTuning"|"MaxCandidatesReached"|"Failed"|"Stopped"|"MaxAutoMLJobRuntimeReached"|"Stopping"|"CandidateDefinitionsGenerated"|string;
1476 export type AutoMLJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string;
1477 export type AutoMLJobSummaries = AutoMLJobSummary[];
1478 export interface AutoMLJobSummary {
1479 /**
1480 * The name of the object you are requesting.
1481 */
1482 AutoMLJobName: AutoMLJobName;
1483 /**
1484 * The ARN of the job.
1485 */
1486 AutoMLJobArn: AutoMLJobArn;
1487 /**
1488 * The job's status.
1489 */
1490 AutoMLJobStatus: AutoMLJobStatus;
1491 /**
1492 * The job's secondary status.
1493 */
1494 AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus;
1495 /**
1496 * When the job was created.
1497 */
1498 CreationTime: Timestamp;
1499 /**
1500 * The end time.
1501 */
1502 EndTime?: Timestamp;
1503 /**
1504 * When the job was last modified.
1505 */
1506 LastModifiedTime: Timestamp;
1507 /**
1508 * The failure reason.
1509 */
1510 FailureReason?: AutoMLFailureReason;
1511 }
1512 export type AutoMLMaxResults = number;
1513 export type AutoMLMetricEnum = "Accuracy"|"MSE"|"F1"|"F1macro"|string;
1514 export type AutoMLNameContains = string;
1515 export interface AutoMLOutputDataConfig {
1516 /**
1517 * The AWS KMS encryption key ID.
1518 */
1519 KmsKeyId?: KmsKeyId;
1520 /**
1521 * The Amazon S3 output path. Must be 128 characters or less.
1522 */
1523 S3OutputPath: S3Uri;
1524 }
1525 export interface AutoMLS3DataSource {
1526 /**
1527 * The data type.
1528 */
1529 S3DataType: AutoMLS3DataType;
1530 /**
1531 * The URL to the Amazon S3 data source.
1532 */
1533 S3Uri: S3Uri;
1534 }
1535 export type AutoMLS3DataType = "ManifestFile"|"S3Prefix"|string;
1536 export interface AutoMLSecurityConfig {
1537 /**
1538 * The key used to encrypt stored data.
1539 */
1540 VolumeKmsKeyId?: KmsKeyId;
1541 /**
1542 * Whether to use traffic encryption between the container layers.
1543 */
1544 EnableInterContainerTrafficEncryption?: Boolean;
1545 /**
1546 * VPC configuration.
1547 */
1548 VpcConfig?: VpcConfig;
1549 }
1550 export type AutoMLSortBy = "Name"|"CreationTime"|"Status"|string;
1551 export type AutoMLSortOrder = "Ascending"|"Descending"|string;
1552 export type AwsManagedHumanLoopRequestSource = "AWS/Rekognition/DetectModerationLabels/Image/V3"|"AWS/Textract/AnalyzeDocument/Forms/V1"|string;
1553 export type BatchStrategy = "MultiRecord"|"SingleRecord"|string;
1554 export type BillableTimeInSeconds = number;
1555 export type Boolean = boolean;
1556 export type BooleanOperator = "And"|"Or"|string;
1557 export type Branch = string;
1558 export type CandidateDefinitionNotebookLocation = string;
1559 export type CandidateName = string;
1560 export type CandidateSortBy = "CreationTime"|"Status"|"FinalObjectiveMetricValue"|string;
1561 export type CandidateStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string;
1562 export type CandidateStepArn = string;
1563 export type CandidateStepName = string;
1564 export type CandidateStepType = "AWS::SageMaker::TrainingJob"|"AWS::SageMaker::TransformJob"|"AWS::SageMaker::ProcessingJob"|string;
1565 export type CandidateSteps = AutoMLCandidateStep[];
1566 export interface CaptureContentTypeHeader {
1567 /**
1568 *
1569 */
1570 CsvContentTypes?: CsvContentTypes;
1571 /**
1572 *
1573 */
1574 JsonContentTypes?: JsonContentTypes;
1575 }
1576 export type CaptureMode = "Input"|"Output"|string;
1577 export interface CaptureOption {
1578 /**
1579 *
1580 */
1581 CaptureMode: CaptureMode;
1582 }
1583 export type CaptureOptionList = CaptureOption[];
1584 export type CaptureStatus = "Started"|"Stopped"|string;
1585 export interface CategoricalParameterRange {
1586 /**
1587 * The name of the categorical hyperparameter to tune.
1588 */
1589 Name: ParameterKey;
1590 /**
1591 * A list of the categories for the hyperparameter.
1592 */
1593 Values: ParameterValues;
1594 }
1595 export interface CategoricalParameterRangeSpecification {
1596 /**
1597 * The allowed categories for the hyperparameter.
1598 */
1599 Values: ParameterValues;
1600 }
1601 export type CategoricalParameterRanges = CategoricalParameterRange[];
1602 export type Cents = number;
1603 export type CertifyForMarketplace = boolean;
1604 export interface Channel {
1605 /**
1606 * The name of the channel.
1607 */
1608 ChannelName: ChannelName;
1609 /**
1610 * The location of the channel data.
1611 */
1612 DataSource: DataSource;
1613 /**
1614 * The MIME type of the data.
1615 */
1616 ContentType?: ContentType;
1617 /**
1618 * 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.
1619 */
1620 CompressionType?: CompressionType;
1621 /**
1622 * 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.
1623 */
1624 RecordWrapperType?: RecordWrapper;
1625 /**
1626 * (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.
1627 */
1628 InputMode?: TrainingInputMode;
1629 /**
1630 * 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.
1631 */
1632 ShuffleConfig?: ShuffleConfig;
1633 }
1634 export type ChannelName = string;
1635 export interface ChannelSpecification {
1636 /**
1637 * The name of the channel.
1638 */
1639 Name: ChannelName;
1640 /**
1641 * A brief description of the channel.
1642 */
1643 Description?: EntityDescription;
1644 /**
1645 * Indicates whether the channel is required by the algorithm.
1646 */
1647 IsRequired?: Boolean;
1648 /**
1649 * The supported MIME types for the data.
1650 */
1651 SupportedContentTypes: ContentTypes;
1652 /**
1653 * The allowed compression types, if data compression is used.
1654 */
1655 SupportedCompressionTypes?: CompressionTypes;
1656 /**
1657 * 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.
1658 */
1659 SupportedInputModes: InputModes;
1660 }
1661 export type ChannelSpecifications = ChannelSpecification[];
1662 export interface CheckpointConfig {
1663 /**
1664 * Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
1665 */
1666 S3Uri: S3Uri;
1667 /**
1668 * (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
1669 */
1670 LocalPath?: DirectoryPath;
1671 }
1672 export type Cidr = string;
1673 export type Cidrs = Cidr[];
1674 export type CodeRepositoryArn = string;
1675 export type CodeRepositoryContains = string;
1676 export type CodeRepositoryNameContains = string;
1677 export type CodeRepositoryNameOrUrl = string;
1678 export type CodeRepositorySortBy = "Name"|"CreationTime"|"LastModifiedTime"|string;
1679 export type CodeRepositorySortOrder = "Ascending"|"Descending"|string;
1680 export interface CodeRepositorySummary {
1681 /**
1682 * The name of the Git repository.
1683 */
1684 CodeRepositoryName: EntityName;
1685 /**
1686 * The Amazon Resource Name (ARN) of the Git repository.
1687 */
1688 CodeRepositoryArn: CodeRepositoryArn;
1689 /**
1690 * The date and time that the Git repository was created.
1691 */
1692 CreationTime: CreationTime;
1693 /**
1694 * The date and time that the Git repository was last modified.
1695 */
1696 LastModifiedTime: LastModifiedTime;
1697 /**
1698 * 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.
1699 */
1700 GitConfig?: GitConfig;
1701 }
1702 export type CodeRepositorySummaryList = CodeRepositorySummary[];
1703 export type CognitoClientId = string;
1704 export interface CognitoMemberDefinition {
1705 /**
1706 * An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
1707 */
1708 UserPool: CognitoUserPool;
1709 /**
1710 * An identifier for a user group.
1711 */
1712 UserGroup: CognitoUserGroup;
1713 /**
1714 * An identifier for an application client. You must create the app client ID using Amazon Cognito.
1715 */
1716 ClientId: CognitoClientId;
1717 }
1718 export type CognitoUserGroup = string;
1719 export type CognitoUserPool = string;
1720 export interface CollectionConfiguration {
1721 /**
1722 * The name of the tensor collection. The name must be unique relative to other rule configuration names.
1723 */
1724 CollectionName?: CollectionName;
1725 /**
1726 * Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".
1727 */
1728 CollectionParameters?: CollectionParameters;
1729 }
1730 export type CollectionConfigurations = CollectionConfiguration[];
1731 export type CollectionName = string;
1732 export type CollectionParameters = {[key: string]: ConfigValue};
1733 export type CompilationJobArn = string;
1734 export type CompilationJobStatus = "INPROGRESS"|"COMPLETED"|"FAILED"|"STARTING"|"STOPPING"|"STOPPED"|string;
1735 export type CompilationJobSummaries = CompilationJobSummary[];
1736 export interface CompilationJobSummary {
1737 /**
1738 * The name of the model compilation job that you want a summary for.
1739 */
1740 CompilationJobName: EntityName;
1741 /**
1742 * The Amazon Resource Name (ARN) of the model compilation job.
1743 */
1744 CompilationJobArn: CompilationJobArn;
1745 /**
1746 * The time when the model compilation job was created.
1747 */
1748 CreationTime: CreationTime;
1749 /**
1750 * The time when the model compilation job started.
1751 */
1752 CompilationStartTime?: Timestamp;
1753 /**
1754 * The time when the model compilation job completed.
1755 */
1756 CompilationEndTime?: Timestamp;
1757 /**
1758 * The type of device that the model will run on after compilation has completed.
1759 */
1760 CompilationTargetDevice: TargetDevice;
1761 /**
1762 * The time when the model compilation job was last modified.
1763 */
1764 LastModifiedTime?: LastModifiedTime;
1765 /**
1766 * The status of the model compilation job.
1767 */
1768 CompilationJobStatus: CompilationJobStatus;
1769 }
1770 export type CompressionType = "None"|"Gzip"|string;
1771 export type CompressionTypes = CompressionType[];
1772 export type ConfigKey = string;
1773 export type ConfigValue = string;
1774 export type ContainerArgument = string;
1775 export type ContainerArguments = ContainerArgument[];
1776 export interface ContainerDefinition {
1777 /**
1778 * This parameter is ignored for models that contain only a PrimaryContainer. When a ContainerDefinition is part of an inference pipeline, the value of the 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.
1779 */
1780 ContainerHostname?: ContainerHostname;
1781 /**
1782 * 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
1783 */
1784 Image?: Image;
1785 /**
1786 * Whether the container hosts a single model or multiple models.
1787 */
1788 Mode?: ContainerMode;
1789 /**
1790 * 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.
1791 */
1792 ModelDataUrl?: Url;
1793 /**
1794 * 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.
1795 */
1796 Environment?: EnvironmentMap;
1797 /**
1798 * The name or Amazon Resource Name (ARN) of the model package to use to create the model.
1799 */
1800 ModelPackageName?: ArnOrName;
1801 }
1802 export type ContainerDefinitionList = ContainerDefinition[];
1803 export type ContainerEntrypoint = ContainerEntrypointString[];
1804 export type ContainerEntrypointString = string;
1805 export type ContainerHostname = string;
1806 export type ContainerMode = "SingleModel"|"MultiModel"|string;
1807 export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string;
1808 export type ContentClassifiers = ContentClassifier[];
1809 export type ContentType = string;
1810 export type ContentTypes = ContentType[];
1811 export interface ContinuousParameterRange {
1812 /**
1813 * The name of the continuous hyperparameter to tune.
1814 */
1815 Name: ParameterKey;
1816 /**
1817 * The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.
1818 */
1819 MinValue: ParameterValue;
1820 /**
1821 * The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
1822 */
1823 MaxValue: ParameterValue;
1824 /**
1825 * 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 Hyperparameter 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.
1826 */
1827 ScalingType?: HyperParameterScalingType;
1828 }
1829 export interface ContinuousParameterRangeSpecification {
1830 /**
1831 * The minimum floating-point value allowed.
1832 */
1833 MinValue: ParameterValue;
1834 /**
1835 * The maximum floating-point value allowed.
1836 */
1837 MaxValue: ParameterValue;
1838 }
1839 export type ContinuousParameterRanges = ContinuousParameterRange[];
1840 export interface CreateAlgorithmInput {
1841 /**
1842 * The name of the algorithm.
1843 */
1844 AlgorithmName: EntityName;
1845 /**
1846 * A description of the algorithm.
1847 */
1848 AlgorithmDescription?: EntityDescription;
1849 /**
1850 * 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.
1851 */
1852 TrainingSpecification: TrainingSpecification;
1853 /**
1854 * 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.
1855 */
1856 InferenceSpecification?: InferenceSpecification;
1857 /**
1858 * 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.
1859 */
1860 ValidationSpecification?: AlgorithmValidationSpecification;
1861 /**
1862 * Whether to certify the algorithm so that it can be listed in AWS Marketplace.
1863 */
1864 CertifyForMarketplace?: CertifyForMarketplace;
1865 }
1866 export interface CreateAlgorithmOutput {
1867 /**
1868 * The Amazon Resource Name (ARN) of the new algorithm.
1869 */
1870 AlgorithmArn: AlgorithmArn;
1871 }
1872 export interface CreateAppRequest {
1873 /**
1874 * The domain ID.
1875 */
1876 DomainId: DomainId;
1877 /**
1878 * The user profile name.
1879 */
1880 UserProfileName: UserProfileName;
1881 /**
1882 * The type of app.
1883 */
1884 AppType: AppType;
1885 /**
1886 * The name of the app.
1887 */
1888 AppName: AppName;
1889 /**
1890 * Each tag consists of a key and an optional value. Tag keys must be unique per resource.
1891 */
1892 Tags?: TagList;
1893 /**
1894 * The instance type and quantity.
1895 */
1896 ResourceSpec?: ResourceSpec;
1897 }
1898 export interface CreateAppResponse {
1899 /**
1900 * The app's Amazon Resource Name (ARN).
1901 */
1902 AppArn?: AppArn;
1903 }
1904 export interface CreateAutoMLJobRequest {
1905 /**
1906 * Identifies an AutoPilot job. Must be unique to your account and is case-insensitive.
1907 */
1908 AutoMLJobName: AutoMLJobName;
1909 /**
1910 * Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 1000 rows.
1911 */
1912 InputDataConfig: AutoMLInputDataConfig;
1913 /**
1914 * Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.
1915 */
1916 OutputDataConfig: AutoMLOutputDataConfig;
1917 /**
1918 * Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.
1919 */
1920 ProblemType?: ProblemType;
1921 /**
1922 * Defines the job's objective. You provide a MetricName and AutoML will infer minimize or maximize. If this is not provided, the most commonly used ObjectiveMetric for problem type will be selected.
1923 */
1924 AutoMLJobObjective?: AutoMLJobObjective;
1925 /**
1926 * Contains CompletionCriteria and SecurityConfig.
1927 */
1928 AutoMLJobConfig?: AutoMLJobConfig;
1929 /**
1930 * The ARN of the role that will be used to access the data.
1931 */
1932 RoleArn: RoleArn;
1933 /**
1934 * This will generate possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
1935 */
1936 GenerateCandidateDefinitionsOnly?: GenerateCandidateDefinitionsOnly;
1937 /**
1938 * Each tag consists of a key and an optional value. Tag keys must be unique per resource.
1939 */
1940 Tags?: TagList;
1941 }
1942 export interface CreateAutoMLJobResponse {
1943 /**
1944 * When a job is created, it is assigned a unique ARN.
1945 */
1946 AutoMLJobArn: AutoMLJobArn;
1947 }
1948 export interface CreateCodeRepositoryInput {
1949 /**
1950 * 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).
1951 */
1952 CodeRepositoryName: EntityName;
1953 /**
1954 * Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
1955 */
1956 GitConfig: GitConfig;
1957 }
1958 export interface CreateCodeRepositoryOutput {
1959 /**
1960 * The Amazon Resource Name (ARN) of the new repository.
1961 */
1962 CodeRepositoryArn: CodeRepositoryArn;
1963 }
1964 export interface CreateCompilationJobRequest {
1965 /**
1966 * A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.
1967 */
1968 CompilationJobName: EntityName;
1969 /**
1970 * 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.
1971 */
1972 RoleArn: RoleArn;
1973 /**
1974 * 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.
1975 */
1976 InputConfig: InputConfig;
1977 /**
1978 * Provides information about the output location for the compiled model and the target device the model runs on.
1979 */
1980 OutputConfig: OutputConfig;
1981 /**
1982 * 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.
1983 */
1984 StoppingCondition: StoppingCondition;
1985 }
1986 export interface CreateCompilationJobResponse {
1987 /**
1988 * 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.
1989 */
1990 CompilationJobArn: CompilationJobArn;
1991 }
1992 export interface CreateDomainRequest {
1993 /**
1994 * A name for the domain.
1995 */
1996 DomainName: DomainName;
1997 /**
1998 * The mode of authentication that member use to access the domain.
1999 */
2000 AuthMode: AuthMode;
2001 /**
2002 * The default user settings.
2003 */
2004 DefaultUserSettings: UserSettings;
2005 /**
2006 * Security setting to limit to a set of subnets.
2007 */
2008 SubnetIds: Subnets;
2009 /**
2010 * Security setting to limit the domain's communication to a Amazon Virtual Private Cloud.
2011 */
2012 VpcId: VpcId;
2013 /**
2014 * Each tag consists of a key and an optional value. Tag keys must be unique per resource.
2015 */
2016 Tags?: TagList;
2017 /**
2018 * The AWS Key Management Service encryption key ID.
2019 */
2020 HomeEfsFileSystemKmsKeyId?: KmsKeyId;
2021 }
2022 export interface CreateDomainResponse {
2023 /**
2024 * The Amazon Resource Name (ARN) of the created domain.
2025 */
2026 DomainArn?: DomainArn;
2027 /**
2028 * The URL to the created domain.
2029 */
2030 Url?: String1024;
2031 }
2032 export interface CreateEndpointConfigInput {
2033 /**
2034 * The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
2035 */
2036 EndpointConfigName: EndpointConfigName;
2037 /**
2038 * An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
2039 */
2040 ProductionVariants: ProductionVariantList;
2041 DataCaptureConfig?: DataCaptureConfig;
2042 /**
2043 * A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2044 */
2045 Tags?: TagList;
2046 /**
2047 * 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. The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.
2048 */
2049 KmsKeyId?: KmsKeyId;
2050 }
2051 export interface CreateEndpointConfigOutput {
2052 /**
2053 * The Amazon Resource Name (ARN) of the endpoint configuration.
2054 */
2055 EndpointConfigArn: EndpointConfigArn;
2056 }
2057 export interface CreateEndpointInput {
2058 /**
2059 * The name of the endpoint. The name must be unique within an AWS Region in your AWS account.
2060 */
2061 EndpointName: EndpointName;
2062 /**
2063 * The name of an endpoint configuration. For more information, see CreateEndpointConfig.
2064 */
2065 EndpointConfigName: EndpointConfigName;
2066 /**
2067 * An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.
2068 */
2069 Tags?: TagList;
2070 }
2071 export interface CreateEndpointOutput {
2072 /**
2073 * The Amazon Resource Name (ARN) of the endpoint.
2074 */
2075 EndpointArn: EndpointArn;
2076 }
2077 export interface CreateExperimentRequest {
2078 /**
2079 * The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.
2080 */
2081 ExperimentName: ExperimentEntityName;
2082 /**
2083 * The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.
2084 */
2085 DisplayName?: ExperimentEntityName;
2086 /**
2087 * The description of the experiment.
2088 */
2089 Description?: ExperimentDescription;
2090 /**
2091 * A list of tags to associate with the experiment. You can use Search API to search on the tags.
2092 */
2093 Tags?: TagList;
2094 }
2095 export interface CreateExperimentResponse {
2096 /**
2097 * The Amazon Resource Name (ARN) of the experiment.
2098 */
2099 ExperimentArn?: ExperimentArn;
2100 }
2101 export interface CreateFlowDefinitionRequest {
2102 /**
2103 * The name of your flow definition.
2104 */
2105 FlowDefinitionName: FlowDefinitionName;
2106 HumanLoopRequestSource?: HumanLoopRequestSource;
2107 /**
2108 * An object containing information about the events that trigger a human workflow.
2109 */
2110 HumanLoopActivationConfig?: HumanLoopActivationConfig;
2111 /**
2112 * An object containing information about the tasks the human reviewers will perform.
2113 */
2114 HumanLoopConfig: HumanLoopConfig;
2115 /**
2116 * An object containing information about where the human review results will be uploaded.
2117 */
2118 OutputConfig: FlowDefinitionOutputConfig;
2119 /**
2120 * The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
2121 */
2122 RoleArn: RoleArn;
2123 /**
2124 * An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
2125 */
2126 Tags?: TagList;
2127 }
2128 export interface CreateFlowDefinitionResponse {
2129 /**
2130 * The Amazon Resource Name (ARN) of the flow definition you create.
2131 */
2132 FlowDefinitionArn: FlowDefinitionArn;
2133 }
2134 export interface CreateHumanTaskUiRequest {
2135 /**
2136 * The name of the user interface you are creating.
2137 */
2138 HumanTaskUiName: HumanTaskUiName;
2139 UiTemplate: UiTemplate;
2140 /**
2141 * An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
2142 */
2143 Tags?: TagList;
2144 }
2145 export interface CreateHumanTaskUiResponse {
2146 /**
2147 * The Amazon Resource Name (ARN) of the human review workflow user interface you create.
2148 */
2149 HumanTaskUiArn: HumanTaskUiArn;
2150 }
2151 export interface CreateHyperParameterTuningJobRequest {
2152 /**
2153 * 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.
2154 */
2155 HyperParameterTuningJobName: HyperParameterTuningJobName;
2156 /**
2157 * 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 How Hyperparameter Tuning Works.
2158 */
2159 HyperParameterTuningJobConfig: HyperParameterTuningJobConfig;
2160 /**
2161 * 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.
2162 */
2163 TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
2164 /**
2165 *
2166 */
2167 TrainingJobDefinitions?: HyperParameterTrainingJobDefinitions;
2168 /**
2169 * 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.
2170 */
2171 WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
2172 /**
2173 * 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.
2174 */
2175 Tags?: TagList;
2176 }
2177 export interface CreateHyperParameterTuningJobResponse {
2178 /**
2179 * The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
2180 */
2181 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
2182 }
2183 export interface CreateLabelingJobRequest {
2184 /**
2185 * The name of the labeling job. This name is used to identify the job in a list of labeling jobs.
2186 */
2187 LabelingJobName: LabelingJobName;
2188 /**
2189 * 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".
2190 */
2191 LabelAttributeName: LabelAttributeName;
2192 /**
2193 * 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.
2194 */
2195 InputConfig: LabelingJobInputConfig;
2196 /**
2197 * 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.
2198 */
2199 OutputConfig: LabelingJobOutputConfig;
2200 /**
2201 * 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.
2202 */
2203 RoleArn: RoleArn;
2204 /**
2205 * 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" } ] }
2206 */
2207 LabelCategoryConfigS3Uri?: S3Uri;
2208 /**
2209 * 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.
2210 */
2211 StoppingConditions?: LabelingJobStoppingConditions;
2212 /**
2213 * Configures the information required to perform automated data labeling.
2214 */
2215 LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig;
2216 /**
2217 * Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
2218 */
2219 HumanTaskConfig: HumanTaskConfig;
2220 /**
2221 * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2222 */
2223 Tags?: TagList;
2224 }
2225 export interface CreateLabelingJobResponse {
2226 /**
2227 * The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
2228 */
2229 LabelingJobArn: LabelingJobArn;
2230 }
2231 export interface CreateModelInput {
2232 /**
2233 * The name of the new model.
2234 */
2235 ModelName: ModelName;
2236 /**
2237 * 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.
2238 */
2239 PrimaryContainer?: ContainerDefinition;
2240 /**
2241 * Specifies the containers in the inference pipeline.
2242 */
2243 Containers?: ContainerDefinitionList;
2244 /**
2245 * 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.
2246 */
2247 ExecutionRoleArn: RoleArn;
2248 /**
2249 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2250 */
2251 Tags?: TagList;
2252 /**
2253 * 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.
2254 */
2255 VpcConfig?: VpcConfig;
2256 /**
2257 * Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
2258 */
2259 EnableNetworkIsolation?: Boolean;
2260 }
2261 export interface CreateModelOutput {
2262 /**
2263 * The ARN of the model created in Amazon SageMaker.
2264 */
2265 ModelArn: ModelArn;
2266 }
2267 export interface CreateModelPackageInput {
2268 /**
2269 * 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).
2270 */
2271 ModelPackageName: EntityName;
2272 /**
2273 * A description of the model package.
2274 */
2275 ModelPackageDescription?: EntityDescription;
2276 /**
2277 * 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.
2278 */
2279 InferenceSpecification?: InferenceSpecification;
2280 /**
2281 * Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
2282 */
2283 ValidationSpecification?: ModelPackageValidationSpecification;
2284 /**
2285 * Details about the algorithm that was used to create the model package.
2286 */
2287 SourceAlgorithmSpecification?: SourceAlgorithmSpecification;
2288 /**
2289 * Whether to certify the model package for listing on AWS Marketplace.
2290 */
2291 CertifyForMarketplace?: CertifyForMarketplace;
2292 }
2293 export interface CreateModelPackageOutput {
2294 /**
2295 * The Amazon Resource Name (ARN) of the new model package.
2296 */
2297 ModelPackageArn: ModelPackageArn;
2298 }
2299 export interface CreateMonitoringScheduleRequest {
2300 /**
2301 * The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.
2302 */
2303 MonitoringScheduleName: MonitoringScheduleName;
2304 /**
2305 * The configuration object that specifies the monitoring schedule and defines the monitoring job.
2306 */
2307 MonitoringScheduleConfig: MonitoringScheduleConfig;
2308 /**
2309 * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2310 */
2311 Tags?: TagList;
2312 }
2313 export interface CreateMonitoringScheduleResponse {
2314 /**
2315 * The Amazon Resource Name (ARN) of the monitoring schedule.
2316 */
2317 MonitoringScheduleArn: MonitoringScheduleArn;
2318 }
2319 export interface CreateNotebookInstanceInput {
2320 /**
2321 * The name of the new notebook instance.
2322 */
2323 NotebookInstanceName: NotebookInstanceName;
2324 /**
2325 * The type of ML compute instance to launch for the notebook instance.
2326 */
2327 InstanceType: InstanceType;
2328 /**
2329 * The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
2330 */
2331 SubnetId?: SubnetId;
2332 /**
2333 * The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
2334 */
2335 SecurityGroupIds?: SecurityGroupIds;
2336 /**
2337 * 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) permissions 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.
2338 */
2339 RoleArn: RoleArn;
2340 /**
2341 * 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.
2342 */
2343 KmsKeyId?: KmsKeyId;
2344 /**
2345 * A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.
2346 */
2347 Tags?: TagList;
2348 /**
2349 * 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.
2350 */
2351 LifecycleConfigName?: NotebookInstanceLifecycleConfigName;
2352 /**
2353 * 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.
2354 */
2355 DirectInternetAccess?: DirectInternetAccess;
2356 /**
2357 * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
2358 */
2359 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
2360 /**
2361 * 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.
2362 */
2363 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
2364 /**
2365 * 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.
2366 */
2367 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
2368 /**
2369 * 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.
2370 */
2371 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
2372 /**
2373 * 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.
2374 */
2375 RootAccess?: RootAccess;
2376 }
2377 export interface CreateNotebookInstanceLifecycleConfigInput {
2378 /**
2379 * The name of the lifecycle configuration.
2380 */
2381 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
2382 /**
2383 * A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
2384 */
2385 OnCreate?: NotebookInstanceLifecycleConfigList;
2386 /**
2387 * 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.
2388 */
2389 OnStart?: NotebookInstanceLifecycleConfigList;
2390 }
2391 export interface CreateNotebookInstanceLifecycleConfigOutput {
2392 /**
2393 * The Amazon Resource Name (ARN) of the lifecycle configuration.
2394 */
2395 NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn;
2396 }
2397 export interface CreateNotebookInstanceOutput {
2398 /**
2399 * The Amazon Resource Name (ARN) of the notebook instance.
2400 */
2401 NotebookInstanceArn?: NotebookInstanceArn;
2402 }
2403 export interface CreatePresignedDomainUrlRequest {
2404 /**
2405 * The domain ID.
2406 */
2407 DomainId: DomainId;
2408 /**
2409 * The name of the UserProfile to sign-in as.
2410 */
2411 UserProfileName: UserProfileName;
2412 /**
2413 * The session expiration duration in seconds.
2414 */
2415 SessionExpirationDurationInSeconds?: SessionExpirationDurationInSeconds;
2416 }
2417 export interface CreatePresignedDomainUrlResponse {
2418 /**
2419 * The presigned URL.
2420 */
2421 AuthorizedUrl?: PresignedDomainUrl;
2422 }
2423 export interface CreatePresignedNotebookInstanceUrlInput {
2424 /**
2425 * The name of the notebook instance.
2426 */
2427 NotebookInstanceName: NotebookInstanceName;
2428 /**
2429 * The duration of the session, in seconds. The default is 12 hours.
2430 */
2431 SessionExpirationDurationInSeconds?: SessionExpirationDurationInSeconds;
2432 }
2433 export interface CreatePresignedNotebookInstanceUrlOutput {
2434 /**
2435 * A JSON object that contains the URL string.
2436 */
2437 AuthorizedUrl?: NotebookInstanceUrl;
2438 }
2439 export interface CreateProcessingJobRequest {
2440 /**
2441 * For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.
2442 */
2443 ProcessingInputs?: ProcessingInputs;
2444 /**
2445 * Output configuration for the processing job.
2446 */
2447 ProcessingOutputConfig?: ProcessingOutputConfig;
2448 /**
2449 * The name of the processing job. The name must be unique within an AWS Region in the AWS account.
2450 */
2451 ProcessingJobName: ProcessingJobName;
2452 /**
2453 * Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
2454 */
2455 ProcessingResources: ProcessingResources;
2456 /**
2457 * The time limit for how long the processing job is allowed to run.
2458 */
2459 StoppingCondition?: ProcessingStoppingCondition;
2460 /**
2461 * Configures the processing job to run a specified Docker container image.
2462 */
2463 AppSpecification: AppSpecification;
2464 /**
2465 * Sets the environment variables in the Docker container.
2466 */
2467 Environment?: ProcessingEnvironmentMap;
2468 /**
2469 * Networking options for a processing job.
2470 */
2471 NetworkConfig?: NetworkConfig;
2472 /**
2473 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
2474 */
2475 RoleArn: RoleArn;
2476 /**
2477 * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2478 */
2479 Tags?: TagList;
2480 ExperimentConfig?: ExperimentConfig;
2481 }
2482 export interface CreateProcessingJobResponse {
2483 /**
2484 * The Amazon Resource Name (ARN) of the processing job.
2485 */
2486 ProcessingJobArn: ProcessingJobArn;
2487 }
2488 export interface CreateTrainingJobRequest {
2489 /**
2490 * The name of the training job. The name must be unique within an AWS Region in an AWS account.
2491 */
2492 TrainingJobName: TrainingJobName;
2493 /**
2494 * 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.
2495 */
2496 HyperParameters?: HyperParameters;
2497 /**
2498 * 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.
2499 */
2500 AlgorithmSpecification: AlgorithmSpecification;
2501 /**
2502 * 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.
2503 */
2504 RoleArn: RoleArn;
2505 /**
2506 * 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.
2507 */
2508 InputDataConfig?: InputDataConfig;
2509 /**
2510 * Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
2511 */
2512 OutputDataConfig: OutputDataConfig;
2513 /**
2514 * 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.
2515 */
2516 ResourceConfig: ResourceConfig;
2517 /**
2518 * 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.
2519 */
2520 VpcConfig?: VpcConfig;
2521 /**
2522 * 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.
2523 */
2524 StoppingCondition: StoppingCondition;
2525 /**
2526 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2527 */
2528 Tags?: TagList;
2529 /**
2530 * 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.
2531 */
2532 EnableNetworkIsolation?: Boolean;
2533 /**
2534 * 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.
2535 */
2536 EnableInterContainerTrafficEncryption?: Boolean;
2537 /**
2538 * 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.
2539 */
2540 EnableManagedSpotTraining?: Boolean;
2541 /**
2542 * Contains information about the output location for managed spot training checkpoint data.
2543 */
2544 CheckpointConfig?: CheckpointConfig;
2545 DebugHookConfig?: DebugHookConfig;
2546 /**
2547 * Configuration information for debugging rules.
2548 */
2549 DebugRuleConfigurations?: DebugRuleConfigurations;
2550 TensorBoardOutputConfig?: TensorBoardOutputConfig;
2551 ExperimentConfig?: ExperimentConfig;
2552 }
2553 export interface CreateTrainingJobResponse {
2554 /**
2555 * The Amazon Resource Name (ARN) of the training job.
2556 */
2557 TrainingJobArn: TrainingJobArn;
2558 }
2559 export interface CreateTransformJobRequest {
2560 /**
2561 * The name of the transform job. The name must be unique within an AWS Region in an AWS account.
2562 */
2563 TransformJobName: TransformJobName;
2564 /**
2565 * 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.
2566 */
2567 ModelName: ModelName;
2568 /**
2569 * 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 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.
2570 */
2571 MaxConcurrentTransforms?: MaxConcurrentTransforms;
2572 /**
2573 * 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.
2574 */
2575 MaxPayloadInMB?: MaxPayloadInMB;
2576 /**
2577 * 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 the SplitType property 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.
2578 */
2579 BatchStrategy?: BatchStrategy;
2580 /**
2581 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
2582 */
2583 Environment?: TransformEnvironmentMap;
2584 /**
2585 * Describes the input source and the way the transform job consumes it.
2586 */
2587 TransformInput: TransformInput;
2588 /**
2589 * Describes the results of the transform job.
2590 */
2591 TransformOutput: TransformOutput;
2592 /**
2593 * Describes the resources, including ML instance types and ML instance count, to use for the transform job.
2594 */
2595 TransformResources: TransformResources;
2596 /**
2597 * 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.
2598 */
2599 DataProcessing?: DataProcessing;
2600 /**
2601 * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
2602 */
2603 Tags?: TagList;
2604 ExperimentConfig?: ExperimentConfig;
2605 }
2606 export interface CreateTransformJobResponse {
2607 /**
2608 * The Amazon Resource Name (ARN) of the transform job.
2609 */
2610 TransformJobArn: TransformJobArn;
2611 }
2612 export interface CreateTrialComponentRequest {
2613 /**
2614 * The name of the component. The name must be unique in your AWS account and is not case-sensitive.
2615 */
2616 TrialComponentName: ExperimentEntityName;
2617 /**
2618 * The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
2619 */
2620 DisplayName?: ExperimentEntityName;
2621 /**
2622 * The status of the component. States include: InProgress Completed Failed
2623 */
2624 Status?: TrialComponentStatus;
2625 /**
2626 * When the component started.
2627 */
2628 StartTime?: Timestamp;
2629 /**
2630 * When the component ended.
2631 */
2632 EndTime?: Timestamp;
2633 /**
2634 * The hyperparameters for the component.
2635 */
2636 Parameters?: TrialComponentParameters;
2637 /**
2638 * The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
2639 */
2640 InputArtifacts?: TrialComponentArtifacts;
2641 /**
2642 * The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
2643 */
2644 OutputArtifacts?: TrialComponentArtifacts;
2645 /**
2646 * A list of tags to associate with the component. You can use Search API to search on the tags.
2647 */
2648 Tags?: TagList;
2649 }
2650 export interface CreateTrialComponentResponse {
2651 /**
2652 * The Amazon Resource Name (ARN) of the trial component.
2653 */
2654 TrialComponentArn?: TrialComponentArn;
2655 }
2656 export interface CreateTrialRequest {
2657 /**
2658 * The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
2659 */
2660 TrialName: ExperimentEntityName;
2661 /**
2662 * The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
2663 */
2664 DisplayName?: ExperimentEntityName;
2665 /**
2666 * The name of the experiment to associate the trial with.
2667 */
2668 ExperimentName: ExperimentEntityName;
2669 /**
2670 * A list of tags to associate with the trial. You can use Search API to search on the tags.
2671 */
2672 Tags?: TagList;
2673 }
2674 export interface CreateTrialResponse {
2675 /**
2676 * The Amazon Resource Name (ARN) of the trial.
2677 */
2678 TrialArn?: TrialArn;
2679 }
2680 export interface CreateUserProfileRequest {
2681 /**
2682 * The ID of the associated Domain.
2683 */
2684 DomainId: DomainId;
2685 /**
2686 * A name for the UserProfile.
2687 */
2688 UserProfileName: UserProfileName;
2689 /**
2690 * A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
2691 */
2692 SingleSignOnUserIdentifier?: SingleSignOnUserIdentifier;
2693 /**
2694 * The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
2695 */
2696 SingleSignOnUserValue?: String256;
2697 /**
2698 * Each tag consists of a key and an optional value. Tag keys must be unique per resource.
2699 */
2700 Tags?: TagList;
2701 /**
2702 * A collection of settings.
2703 */
2704 UserSettings?: UserSettings;
2705 }
2706 export interface CreateUserProfileResponse {
2707 /**
2708 * The user profile Amazon Resource Name (ARN).
2709 */
2710 UserProfileArn?: UserProfileArn;
2711 }
2712 export interface CreateWorkteamRequest {
2713 /**
2714 * The name of the work team. Use this name to identify the work team.
2715 */
2716 WorkteamName: WorkteamName;
2717 /**
2718 * 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.
2719 */
2720 MemberDefinitions: MemberDefinitions;
2721 /**
2722 * A description of the work team.
2723 */
2724 Description: String200;
2725 /**
2726 * Configures notification of workers regarding available or expiring work items.
2727 */
2728 NotificationConfiguration?: NotificationConfiguration;
2729 /**
2730 * 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.
2731 */
2732 Tags?: TagList;
2733 }
2734 export interface CreateWorkteamResponse {
2735 /**
2736 * The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
2737 */
2738 WorkteamArn?: WorkteamArn;
2739 }
2740 export type CreationTime = Date;
2741 export type CsvContentType = string;
2742 export type CsvContentTypes = CsvContentType[];
2743 export interface DataCaptureConfig {
2744 /**
2745 *
2746 */
2747 EnableCapture?: EnableCapture;
2748 /**
2749 *
2750 */
2751 InitialSamplingPercentage: SamplingPercentage;
2752 /**
2753 *
2754 */
2755 DestinationS3Uri: DestinationS3Uri;
2756 /**
2757 *
2758 */
2759 KmsKeyId?: KmsKeyId;
2760 /**
2761 *
2762 */
2763 CaptureOptions: CaptureOptionList;
2764 /**
2765 *
2766 */
2767 CaptureContentTypeHeader?: CaptureContentTypeHeader;
2768 }
2769 export interface DataCaptureConfigSummary {
2770 /**
2771 *
2772 */
2773 EnableCapture: EnableCapture;
2774 /**
2775 *
2776 */
2777 CaptureStatus: CaptureStatus;
2778 /**
2779 *
2780 */
2781 CurrentSamplingPercentage: SamplingPercentage;
2782 /**
2783 *
2784 */
2785 DestinationS3Uri: DestinationS3Uri;
2786 /**
2787 *
2788 */
2789 KmsKeyId: KmsKeyId;
2790 }
2791 export type DataExplorationNotebookLocation = string;
2792 export type DataInputConfig = string;
2793 export interface DataProcessing {
2794 /**
2795 * 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"
2796 */
2797 InputFilter?: JsonPath;
2798 /**
2799 * 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']"
2800 */
2801 OutputFilter?: JsonPath;
2802 /**
2803 * 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.
2804 */
2805 JoinSource?: JoinSource;
2806 }
2807 export interface DataSource {
2808 /**
2809 * The S3 location of the data source that is associated with a channel.
2810 */
2811 S3DataSource?: S3DataSource;
2812 /**
2813 * The file system that is associated with a channel.
2814 */
2815 FileSystemDataSource?: FileSystemDataSource;
2816 }
2817 export interface DebugHookConfig {
2818 /**
2819 * Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/.
2820 */
2821 LocalPath?: DirectoryPath;
2822 /**
2823 * Path to Amazon S3 storage location for tensors.
2824 */
2825 S3OutputPath: S3Uri;
2826 /**
2827 * Configuration information for the debug hook parameters.
2828 */
2829 HookParameters?: HookParameters;
2830 /**
2831 * Configuration information for tensor collections.
2832 */
2833 CollectionConfigurations?: CollectionConfigurations;
2834 }
2835 export interface DebugRuleConfiguration {
2836 /**
2837 * The name of the rule configuration. It must be unique relative to other rule configuration names.
2838 */
2839 RuleConfigurationName: RuleConfigurationName;
2840 /**
2841 * Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
2842 */
2843 LocalPath?: DirectoryPath;
2844 /**
2845 * Path to Amazon S3 storage location for rules.
2846 */
2847 S3OutputPath?: S3Uri;
2848 /**
2849 * The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
2850 */
2851 RuleEvaluatorImage: AlgorithmImage;
2852 /**
2853 * The instance type to deploy for a training job.
2854 */
2855 InstanceType?: ProcessingInstanceType;
2856 /**
2857 * The size, in GB, of the ML storage volume attached to the processing instance.
2858 */
2859 VolumeSizeInGB?: OptionalVolumeSizeInGB;
2860 /**
2861 * Runtime configuration for rule container.
2862 */
2863 RuleParameters?: RuleParameters;
2864 }
2865 export type DebugRuleConfigurations = DebugRuleConfiguration[];
2866 export interface DebugRuleEvaluationStatus {
2867 /**
2868 * The name of the rule configuration
2869 */
2870 RuleConfigurationName?: RuleConfigurationName;
2871 /**
2872 * The Amazon Resource Name (ARN) of the rule evaluation job.
2873 */
2874 RuleEvaluationJobArn?: ProcessingJobArn;
2875 /**
2876 * Status of the rule evaluation.
2877 */
2878 RuleEvaluationStatus?: RuleEvaluationStatus;
2879 /**
2880 * Details from the rule evaluation.
2881 */
2882 StatusDetails?: StatusDetails;
2883 /**
2884 * Timestamp when the rule evaluation status was last modified.
2885 */
2886 LastModifiedTime?: Timestamp;
2887 }
2888 export type DebugRuleEvaluationStatuses = DebugRuleEvaluationStatus[];
2889 export interface DeleteAlgorithmInput {
2890 /**
2891 * The name of the algorithm to delete.
2892 */
2893 AlgorithmName: EntityName;
2894 }
2895 export interface DeleteAppRequest {
2896 /**
2897 * The domain ID.
2898 */
2899 DomainId: DomainId;
2900 /**
2901 * The user profile name.
2902 */
2903 UserProfileName: UserProfileName;
2904 /**
2905 * The type of app.
2906 */
2907 AppType: AppType;
2908 /**
2909 * The name of the app.
2910 */
2911 AppName: AppName;
2912 }
2913 export interface DeleteCodeRepositoryInput {
2914 /**
2915 * The name of the Git repository to delete.
2916 */
2917 CodeRepositoryName: EntityName;
2918 }
2919 export interface DeleteDomainRequest {
2920 /**
2921 * The domain ID.
2922 */
2923 DomainId: DomainId;
2924 /**
2925 * The retention policy for this domain, which specifies which resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).
2926 */
2927 RetentionPolicy?: RetentionPolicy;
2928 }
2929 export interface DeleteEndpointConfigInput {
2930 /**
2931 * The name of the endpoint configuration that you want to delete.
2932 */
2933 EndpointConfigName: EndpointConfigName;
2934 }
2935 export interface DeleteEndpointInput {
2936 /**
2937 * The name of the endpoint that you want to delete.
2938 */
2939 EndpointName: EndpointName;
2940 }
2941 export interface DeleteExperimentRequest {
2942 /**
2943 * The name of the experiment to delete.
2944 */
2945 ExperimentName: ExperimentEntityName;
2946 }
2947 export interface DeleteExperimentResponse {
2948 /**
2949 * The Amazon Resource Name (ARN) of the experiment that is being deleted.
2950 */
2951 ExperimentArn?: ExperimentArn;
2952 }
2953 export interface DeleteFlowDefinitionRequest {
2954 /**
2955 * The name of the flow definition you are deleting.
2956 */
2957 FlowDefinitionName: FlowDefinitionName;
2958 }
2959 export interface DeleteFlowDefinitionResponse {
2960 }
2961 export interface DeleteModelInput {
2962 /**
2963 * The name of the model to delete.
2964 */
2965 ModelName: ModelName;
2966 }
2967 export interface DeleteModelPackageInput {
2968 /**
2969 * 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).
2970 */
2971 ModelPackageName: EntityName;
2972 }
2973 export interface DeleteMonitoringScheduleRequest {
2974 /**
2975 * The name of the monitoring schedule to delete.
2976 */
2977 MonitoringScheduleName: MonitoringScheduleName;
2978 }
2979 export interface DeleteNotebookInstanceInput {
2980 /**
2981 * The name of the Amazon SageMaker notebook instance to delete.
2982 */
2983 NotebookInstanceName: NotebookInstanceName;
2984 }
2985 export interface DeleteNotebookInstanceLifecycleConfigInput {
2986 /**
2987 * The name of the lifecycle configuration to delete.
2988 */
2989 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
2990 }
2991 export interface DeleteTagsInput {
2992 /**
2993 * The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
2994 */
2995 ResourceArn: ResourceArn;
2996 /**
2997 * An array or one or more tag keys to delete.
2998 */
2999 TagKeys: TagKeyList;
3000 }
3001 export interface DeleteTagsOutput {
3002 }
3003 export interface DeleteTrialComponentRequest {
3004 /**
3005 * The name of the component to delete.
3006 */
3007 TrialComponentName: ExperimentEntityName;
3008 }
3009 export interface DeleteTrialComponentResponse {
3010 /**
3011 * The Amazon Resource Name (ARN) of the component is being deleted.
3012 */
3013 TrialComponentArn?: TrialComponentArn;
3014 }
3015 export interface DeleteTrialRequest {
3016 /**
3017 * The name of the trial to delete.
3018 */
3019 TrialName: ExperimentEntityName;
3020 }
3021 export interface DeleteTrialResponse {
3022 /**
3023 * The Amazon Resource Name (ARN) of the trial that is being deleted.
3024 */
3025 TrialArn?: TrialArn;
3026 }
3027 export interface DeleteUserProfileRequest {
3028 /**
3029 * The domain ID.
3030 */
3031 DomainId: DomainId;
3032 /**
3033 * The user profile name.
3034 */
3035 UserProfileName: UserProfileName;
3036 }
3037 export interface DeleteWorkteamRequest {
3038 /**
3039 * The name of the work team to delete.
3040 */
3041 WorkteamName: WorkteamName;
3042 }
3043 export interface DeleteWorkteamResponse {
3044 /**
3045 * Returns true if the work team was successfully deleted; otherwise, returns false.
3046 */
3047 Success: Success;
3048 }
3049 export interface DeployedImage {
3050 /**
3051 * The image path you specified when you created the model.
3052 */
3053 SpecifiedImage?: Image;
3054 /**
3055 * The specific digest path of the image hosted in this ProductionVariant.
3056 */
3057 ResolvedImage?: Image;
3058 /**
3059 * The date and time when the image path for the model resolved to the ResolvedImage
3060 */
3061 ResolutionTime?: Timestamp;
3062 }
3063 export type DeployedImages = DeployedImage[];
3064 export interface DescribeAlgorithmInput {
3065 /**
3066 * The name of the algorithm to describe.
3067 */
3068 AlgorithmName: ArnOrName;
3069 }
3070 export interface DescribeAlgorithmOutput {
3071 /**
3072 * The name of the algorithm being described.
3073 */
3074 AlgorithmName: EntityName;
3075 /**
3076 * The Amazon Resource Name (ARN) of the algorithm.
3077 */
3078 AlgorithmArn: AlgorithmArn;
3079 /**
3080 * A brief summary about the algorithm.
3081 */
3082 AlgorithmDescription?: EntityDescription;
3083 /**
3084 * A timestamp specifying when the algorithm was created.
3085 */
3086 CreationTime: CreationTime;
3087 /**
3088 * Details about training jobs run by this algorithm.
3089 */
3090 TrainingSpecification: TrainingSpecification;
3091 /**
3092 * Details about inference jobs that the algorithm runs.
3093 */
3094 InferenceSpecification?: InferenceSpecification;
3095 /**
3096 * Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
3097 */
3098 ValidationSpecification?: AlgorithmValidationSpecification;
3099 /**
3100 * The current status of the algorithm.
3101 */
3102 AlgorithmStatus: AlgorithmStatus;
3103 /**
3104 * Details about the current status of the algorithm.
3105 */
3106 AlgorithmStatusDetails: AlgorithmStatusDetails;
3107 /**
3108 * The product identifier of the algorithm.
3109 */
3110 ProductId?: ProductId;
3111 /**
3112 * Whether the algorithm is certified to be listed in AWS Marketplace.
3113 */
3114 CertifyForMarketplace?: CertifyForMarketplace;
3115 }
3116 export interface DescribeAppRequest {
3117 /**
3118 * The domain ID.
3119 */
3120 DomainId: DomainId;
3121 /**
3122 * The user profile name.
3123 */
3124 UserProfileName: UserProfileName;
3125 /**
3126 * The type of app.
3127 */
3128 AppType: AppType;
3129 /**
3130 * The name of the app.
3131 */
3132 AppName: AppName;
3133 }
3134 export interface DescribeAppResponse {
3135 /**
3136 * The app's Amazon Resource Name (ARN).
3137 */
3138 AppArn?: AppArn;
3139 /**
3140 * The type of app.
3141 */
3142 AppType?: AppType;
3143 /**
3144 * The name of the app.
3145 */
3146 AppName?: AppName;
3147 /**
3148 * The domain ID.
3149 */
3150 DomainId?: DomainId;
3151 /**
3152 * The user profile name.
3153 */
3154 UserProfileName?: UserProfileName;
3155 /**
3156 * The status.
3157 */
3158 Status?: AppStatus;
3159 /**
3160 * The timestamp of the last health check.
3161 */
3162 LastHealthCheckTimestamp?: Timestamp;
3163 /**
3164 * The timestamp of the last user's activity.
3165 */
3166 LastUserActivityTimestamp?: Timestamp;
3167 /**
3168 * The creation time.
3169 */
3170 CreationTime?: CreationTime;
3171 /**
3172 * The failure reason.
3173 */
3174 FailureReason?: FailureReason;
3175 /**
3176 * The instance type and quantity.
3177 */
3178 ResourceSpec?: ResourceSpec;
3179 }
3180 export interface DescribeAutoMLJobRequest {
3181 /**
3182 * Request information about a job using that job's unique name.
3183 */
3184 AutoMLJobName: AutoMLJobName;
3185 }
3186 export interface DescribeAutoMLJobResponse {
3187 /**
3188 * Returns the name of a job.
3189 */
3190 AutoMLJobName: AutoMLJobName;
3191 /**
3192 * Returns the job's ARN.
3193 */
3194 AutoMLJobArn: AutoMLJobArn;
3195 /**
3196 * Returns the job's input data config.
3197 */
3198 InputDataConfig: AutoMLInputDataConfig;
3199 /**
3200 * Returns the job's output data config.
3201 */
3202 OutputDataConfig: AutoMLOutputDataConfig;
3203 /**
3204 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
3205 */
3206 RoleArn: RoleArn;
3207 /**
3208 * Returns the job's objective.
3209 */
3210 AutoMLJobObjective?: AutoMLJobObjective;
3211 /**
3212 * Returns the job's problem type.
3213 */
3214 ProblemType?: ProblemType;
3215 /**
3216 * Returns the job's config.
3217 */
3218 AutoMLJobConfig?: AutoMLJobConfig;
3219 /**
3220 * Returns the job's creation time.
3221 */
3222 CreationTime: Timestamp;
3223 /**
3224 * Returns the job's end time.
3225 */
3226 EndTime?: Timestamp;
3227 /**
3228 * Returns the job's last modified time.
3229 */
3230 LastModifiedTime: Timestamp;
3231 /**
3232 * Returns the job's FailureReason.
3233 */
3234 FailureReason?: AutoMLFailureReason;
3235 /**
3236 * Returns the job's BestCandidate.
3237 */
3238 BestCandidate?: AutoMLCandidate;
3239 /**
3240 * Returns the job's AutoMLJobStatus.
3241 */
3242 AutoMLJobStatus: AutoMLJobStatus;
3243 /**
3244 * Returns the job's AutoMLJobSecondaryStatus.
3245 */
3246 AutoMLJobSecondaryStatus: AutoMLJobSecondaryStatus;
3247 /**
3248 * Returns the job's output from GenerateCandidateDefinitionsOnly.
3249 */
3250 GenerateCandidateDefinitionsOnly?: GenerateCandidateDefinitionsOnly;
3251 /**
3252 * Returns information on the job's artifacts found in AutoMLJobArtifacts.
3253 */
3254 AutoMLJobArtifacts?: AutoMLJobArtifacts;
3255 /**
3256 * This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're auto-inferred values, if not provided by you. If you do provide them, then they'll be the same as provided.
3257 */
3258 ResolvedAttributes?: ResolvedAttributes;
3259 }
3260 export interface DescribeCodeRepositoryInput {
3261 /**
3262 * The name of the Git repository to describe.
3263 */
3264 CodeRepositoryName: EntityName;
3265 }
3266 export interface DescribeCodeRepositoryOutput {
3267 /**
3268 * The name of the Git repository.
3269 */
3270 CodeRepositoryName: EntityName;
3271 /**
3272 * The Amazon Resource Name (ARN) of the Git repository.
3273 */
3274 CodeRepositoryArn: CodeRepositoryArn;
3275 /**
3276 * The date and time that the repository was created.
3277 */
3278 CreationTime: CreationTime;
3279 /**
3280 * The date and time that the repository was last changed.
3281 */
3282 LastModifiedTime: LastModifiedTime;
3283 /**
3284 * 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.
3285 */
3286 GitConfig?: GitConfig;
3287 }
3288 export interface DescribeCompilationJobRequest {
3289 /**
3290 * The name of the model compilation job that you want information about.
3291 */
3292 CompilationJobName: EntityName;
3293 }
3294 export interface DescribeCompilationJobResponse {
3295 /**
3296 * The name of the model compilation job.
3297 */
3298 CompilationJobName: EntityName;
3299 /**
3300 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
3301 */
3302 CompilationJobArn: CompilationJobArn;
3303 /**
3304 * The status of the model compilation job.
3305 */
3306 CompilationJobStatus: CompilationJobStatus;
3307 /**
3308 * 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.
3309 */
3310 CompilationStartTime?: Timestamp;
3311 /**
3312 * 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.
3313 */
3314 CompilationEndTime?: Timestamp;
3315 /**
3316 * 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.
3317 */
3318 StoppingCondition: StoppingCondition;
3319 /**
3320 * The time that the model compilation job was created.
3321 */
3322 CreationTime: CreationTime;
3323 /**
3324 * The time that the status of the model compilation job was last modified.
3325 */
3326 LastModifiedTime: LastModifiedTime;
3327 /**
3328 * If a model compilation job failed, the reason it failed.
3329 */
3330 FailureReason: FailureReason;
3331 /**
3332 * Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
3333 */
3334 ModelArtifacts: ModelArtifacts;
3335 /**
3336 * The Amazon Resource Name (ARN) of the model compilation job.
3337 */
3338 RoleArn: RoleArn;
3339 /**
3340 * 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.
3341 */
3342 InputConfig: InputConfig;
3343 /**
3344 * Information about the output location for the compiled model and the target device that the model runs on.
3345 */
3346 OutputConfig: OutputConfig;
3347 }
3348 export interface DescribeDomainRequest {
3349 /**
3350 * The domain ID.
3351 */
3352 DomainId: DomainId;
3353 }
3354 export interface DescribeDomainResponse {
3355 /**
3356 * The domain's Amazon Resource Name (ARN).
3357 */
3358 DomainArn?: DomainArn;
3359 /**
3360 * The domain ID.
3361 */
3362 DomainId?: DomainId;
3363 /**
3364 * The domain name.
3365 */
3366 DomainName?: DomainName;
3367 /**
3368 * The ID of the Amazon Elastic File System (EFS) managed by this Domain.
3369 */
3370 HomeEfsFileSystemId?: ResourceId;
3371 /**
3372 * The SSO managed application instance ID.
3373 */
3374 SingleSignOnManagedApplicationInstanceId?: String256;
3375 /**
3376 * The status.
3377 */
3378 Status?: DomainStatus;
3379 /**
3380 * The creation time.
3381 */
3382 CreationTime?: CreationTime;
3383 /**
3384 * The last modified time.
3385 */
3386 LastModifiedTime?: LastModifiedTime;
3387 /**
3388 * The failure reason.
3389 */
3390 FailureReason?: FailureReason;
3391 /**
3392 * The domain's authentication mode.
3393 */
3394 AuthMode?: AuthMode;
3395 /**
3396 * Settings which are applied to all UserProfile in this domain, if settings are not explicitly specified in a given UserProfile.
3397 */
3398 DefaultUserSettings?: UserSettings;
3399 /**
3400 * The AWS Key Management Service encryption key ID.
3401 */
3402 HomeEfsFileSystemKmsKeyId?: KmsKeyId;
3403 /**
3404 * Security setting to limit to a set of subnets.
3405 */
3406 SubnetIds?: Subnets;
3407 /**
3408 * The domain's URL.
3409 */
3410 Url?: String1024;
3411 /**
3412 * The ID of the Amazon Virtual Private Cloud.
3413 */
3414 VpcId?: VpcId;
3415 }
3416 export interface DescribeEndpointConfigInput {
3417 /**
3418 * The name of the endpoint configuration.
3419 */
3420 EndpointConfigName: EndpointConfigName;
3421 }
3422 export interface DescribeEndpointConfigOutput {
3423 /**
3424 * Name of the Amazon SageMaker endpoint configuration.
3425 */
3426 EndpointConfigName: EndpointConfigName;
3427 /**
3428 * The Amazon Resource Name (ARN) of the endpoint configuration.
3429 */
3430 EndpointConfigArn: EndpointConfigArn;
3431 /**
3432 * An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
3433 */
3434 ProductionVariants: ProductionVariantList;
3435 DataCaptureConfig?: DataCaptureConfig;
3436 /**
3437 * AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
3438 */
3439 KmsKeyId?: KmsKeyId;
3440 /**
3441 * A timestamp that shows when the endpoint configuration was created.
3442 */
3443 CreationTime: Timestamp;
3444 }
3445 export interface DescribeEndpointInput {
3446 /**
3447 * The name of the endpoint.
3448 */
3449 EndpointName: EndpointName;
3450 }
3451 export interface DescribeEndpointOutput {
3452 /**
3453 * Name of the endpoint.
3454 */
3455 EndpointName: EndpointName;
3456 /**
3457 * The Amazon Resource Name (ARN) of the endpoint.
3458 */
3459 EndpointArn: EndpointArn;
3460 /**
3461 * The name of the endpoint configuration associated with this endpoint.
3462 */
3463 EndpointConfigName: EndpointConfigName;
3464 /**
3465 * An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
3466 */
3467 ProductionVariants?: ProductionVariantSummaryList;
3468 DataCaptureConfig?: DataCaptureConfigSummary;
3469 /**
3470 * 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.
3471 */
3472 EndpointStatus: EndpointStatus;
3473 /**
3474 * If the status of the endpoint is Failed, the reason why it failed.
3475 */
3476 FailureReason?: FailureReason;
3477 /**
3478 * A timestamp that shows when the endpoint was created.
3479 */
3480 CreationTime: Timestamp;
3481 /**
3482 * A timestamp that shows when the endpoint was last modified.
3483 */
3484 LastModifiedTime: Timestamp;
3485 }
3486 export interface DescribeExperimentRequest {
3487 /**
3488 * The name of the experiment to describe.
3489 */
3490 ExperimentName: ExperimentEntityName;
3491 }
3492 export interface DescribeExperimentResponse {
3493 /**
3494 * The name of the experiment.
3495 */
3496 ExperimentName?: ExperimentEntityName;
3497 /**
3498 * The Amazon Resource Name (ARN) of the experiment.
3499 */
3500 ExperimentArn?: ExperimentArn;
3501 /**
3502 * The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
3503 */
3504 DisplayName?: ExperimentEntityName;
3505 /**
3506 * The ARN of the source and, optionally, the type.
3507 */
3508 Source?: ExperimentSource;
3509 /**
3510 * The description of the experiment.
3511 */
3512 Description?: ExperimentDescription;
3513 /**
3514 * When the experiment was created.
3515 */
3516 CreationTime?: Timestamp;
3517 /**
3518 * Who created the experiment.
3519 */
3520 CreatedBy?: UserContext;
3521 /**
3522 * When the experiment was last modified.
3523 */
3524 LastModifiedTime?: Timestamp;
3525 /**
3526 * Who last modified the experiment.
3527 */
3528 LastModifiedBy?: UserContext;
3529 }
3530 export interface DescribeFlowDefinitionRequest {
3531 /**
3532 * The name of the flow definition.
3533 */
3534 FlowDefinitionName: FlowDefinitionName;
3535 }
3536 export interface DescribeFlowDefinitionResponse {
3537 /**
3538 * The Amazon Resource Name (ARN) of the flow defintion.
3539 */
3540 FlowDefinitionArn: FlowDefinitionArn;
3541 /**
3542 * The Amazon Resource Name (ARN) of the flow definition.
3543 */
3544 FlowDefinitionName: FlowDefinitionName;
3545 /**
3546 * The status of the flow definition. Valid values are listed below.
3547 */
3548 FlowDefinitionStatus: FlowDefinitionStatus;
3549 /**
3550 * The timestamp when the flow definition was created.
3551 */
3552 CreationTime: Timestamp;
3553 HumanLoopRequestSource?: HumanLoopRequestSource;
3554 /**
3555 * An object containing information about what triggers a human review workflow.
3556 */
3557 HumanLoopActivationConfig?: HumanLoopActivationConfig;
3558 /**
3559 * An object containing information about who works on the task, the workforce task price, and other task details.
3560 */
3561 HumanLoopConfig: HumanLoopConfig;
3562 /**
3563 * An object containing information about the output file.
3564 */
3565 OutputConfig: FlowDefinitionOutputConfig;
3566 /**
3567 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.
3568 */
3569 RoleArn: RoleArn;
3570 /**
3571 *
3572 */
3573 FailureReason?: FailureReason;
3574 }
3575 export interface DescribeHumanTaskUiRequest {
3576 /**
3577 * The name of the human task user interface you want information about.
3578 */
3579 HumanTaskUiName: HumanTaskUiName;
3580 }
3581 export interface DescribeHumanTaskUiResponse {
3582 /**
3583 * The Amazon Resource Name (ARN) of the human task user interface.
3584 */
3585 HumanTaskUiArn: HumanTaskUiArn;
3586 /**
3587 * The name of the human task user interface.
3588 */
3589 HumanTaskUiName: HumanTaskUiName;
3590 /**
3591 * The timestamp when the human task user interface was created.
3592 */
3593 CreationTime: Timestamp;
3594 UiTemplate: UiTemplateInfo;
3595 }
3596 export interface DescribeHyperParameterTuningJobRequest {
3597 /**
3598 * The name of the tuning job to describe.
3599 */
3600 HyperParameterTuningJobName: HyperParameterTuningJobName;
3601 }
3602 export interface DescribeHyperParameterTuningJobResponse {
3603 /**
3604 * The name of the tuning job.
3605 */
3606 HyperParameterTuningJobName: HyperParameterTuningJobName;
3607 /**
3608 * The Amazon Resource Name (ARN) of the tuning job.
3609 */
3610 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
3611 /**
3612 * The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
3613 */
3614 HyperParameterTuningJobConfig: HyperParameterTuningJobConfig;
3615 /**
3616 * The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
3617 */
3618 TrainingJobDefinition?: HyperParameterTrainingJobDefinition;
3619 /**
3620 *
3621 */
3622 TrainingJobDefinitions?: HyperParameterTrainingJobDefinitions;
3623 /**
3624 * The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
3625 */
3626 HyperParameterTuningJobStatus: HyperParameterTuningJobStatus;
3627 /**
3628 * The date and time that the tuning job started.
3629 */
3630 CreationTime: Timestamp;
3631 /**
3632 * The date and time that the tuning job ended.
3633 */
3634 HyperParameterTuningEndTime?: Timestamp;
3635 /**
3636 * The date and time that the status of the tuning job was modified.
3637 */
3638 LastModifiedTime?: Timestamp;
3639 /**
3640 * The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
3641 */
3642 TrainingJobStatusCounters: TrainingJobStatusCounters;
3643 /**
3644 * The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
3645 */
3646 ObjectiveStatusCounters: ObjectiveStatusCounters;
3647 /**
3648 * A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
3649 */
3650 BestTrainingJob?: HyperParameterTrainingJobSummary;
3651 /**
3652 * 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.
3653 */
3654 OverallBestTrainingJob?: HyperParameterTrainingJobSummary;
3655 /**
3656 * 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.
3657 */
3658 WarmStartConfig?: HyperParameterTuningJobWarmStartConfig;
3659 /**
3660 * If the tuning job failed, the reason it failed.
3661 */
3662 FailureReason?: FailureReason;
3663 }
3664 export interface DescribeLabelingJobRequest {
3665 /**
3666 * The name of the labeling job to return information for.
3667 */
3668 LabelingJobName: LabelingJobName;
3669 }
3670 export interface DescribeLabelingJobResponse {
3671 /**
3672 * The processing status of the labeling job.
3673 */
3674 LabelingJobStatus: LabelingJobStatus;
3675 /**
3676 * 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.
3677 */
3678 LabelCounters: LabelCounters;
3679 /**
3680 * If the job failed, the reason that it failed.
3681 */
3682 FailureReason?: FailureReason;
3683 /**
3684 * The date and time that the labeling job was created.
3685 */
3686 CreationTime: Timestamp;
3687 /**
3688 * The date and time that the labeling job was last updated.
3689 */
3690 LastModifiedTime: Timestamp;
3691 /**
3692 * A unique identifier for work done as part of a labeling job.
3693 */
3694 JobReferenceCode: JobReferenceCode;
3695 /**
3696 * The name assigned to the labeling job when it was created.
3697 */
3698 LabelingJobName: LabelingJobName;
3699 /**
3700 * The Amazon Resource Name (ARN) of the labeling job.
3701 */
3702 LabelingJobArn: LabelingJobArn;
3703 /**
3704 * The attribute used as the label in the output manifest file.
3705 */
3706 LabelAttributeName?: LabelAttributeName;
3707 /**
3708 * 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.
3709 */
3710 InputConfig: LabelingJobInputConfig;
3711 /**
3712 * 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.
3713 */
3714 OutputConfig: LabelingJobOutputConfig;
3715 /**
3716 * The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
3717 */
3718 RoleArn: RoleArn;
3719 /**
3720 * The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits: Semantic segmentation labeling jobs using automated labeling: 20 labels Box bounding labeling jobs (all): 10 labels 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" } ] }
3721 */
3722 LabelCategoryConfigS3Uri?: S3Uri;
3723 /**
3724 * A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
3725 */
3726 StoppingConditions?: LabelingJobStoppingConditions;
3727 /**
3728 * Configuration information for automated data labeling.
3729 */
3730 LabelingJobAlgorithmsConfig?: LabelingJobAlgorithmsConfig;
3731 /**
3732 * Configuration information required for human workers to complete a labeling task.
3733 */
3734 HumanTaskConfig: HumanTaskConfig;
3735 /**
3736 * An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
3737 */
3738 Tags?: TagList;
3739 /**
3740 * The location of the output produced by the labeling job.
3741 */
3742 LabelingJobOutput?: LabelingJobOutput;
3743 }
3744 export interface DescribeModelInput {
3745 /**
3746 * The name of the model.
3747 */
3748 ModelName: ModelName;
3749 }
3750 export interface DescribeModelOutput {
3751 /**
3752 * Name of the Amazon SageMaker model.
3753 */
3754 ModelName: ModelName;
3755 /**
3756 * The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
3757 */
3758 PrimaryContainer?: ContainerDefinition;
3759 /**
3760 * The containers in the inference pipeline.
3761 */
3762 Containers?: ContainerDefinitionList;
3763 /**
3764 * The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
3765 */
3766 ExecutionRoleArn: RoleArn;
3767 /**
3768 * 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
3769 */
3770 VpcConfig?: VpcConfig;
3771 /**
3772 * A timestamp that shows when the model was created.
3773 */
3774 CreationTime: Timestamp;
3775 /**
3776 * The Amazon Resource Name (ARN) of the model.
3777 */
3778 ModelArn: ModelArn;
3779 /**
3780 * If True, no inbound or outbound network calls can be made to or from the model container.
3781 */
3782 EnableNetworkIsolation?: Boolean;
3783 }
3784 export interface DescribeModelPackageInput {
3785 /**
3786 * The name of the model package to describe.
3787 */
3788 ModelPackageName: ArnOrName;
3789 }
3790 export interface DescribeModelPackageOutput {
3791 /**
3792 * The name of the model package being described.
3793 */
3794 ModelPackageName: EntityName;
3795 /**
3796 * The Amazon Resource Name (ARN) of the model package.
3797 */
3798 ModelPackageArn: ModelPackageArn;
3799 /**
3800 * A brief summary of the model package.
3801 */
3802 ModelPackageDescription?: EntityDescription;
3803 /**
3804 * A timestamp specifying when the model package was created.
3805 */
3806 CreationTime: CreationTime;
3807 /**
3808 * Details about inference jobs that can be run with models based on this model package.
3809 */
3810 InferenceSpecification?: InferenceSpecification;
3811 /**
3812 * Details about the algorithm that was used to create the model package.
3813 */
3814 SourceAlgorithmSpecification?: SourceAlgorithmSpecification;
3815 /**
3816 * Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
3817 */
3818 ValidationSpecification?: ModelPackageValidationSpecification;
3819 /**
3820 * The current status of the model package.
3821 */
3822 ModelPackageStatus: ModelPackageStatus;
3823 /**
3824 * Details about the current status of the model package.
3825 */
3826 ModelPackageStatusDetails: ModelPackageStatusDetails;
3827 /**
3828 * Whether the model package is certified for listing on AWS Marketplace.
3829 */
3830 CertifyForMarketplace?: CertifyForMarketplace;
3831 }
3832 export interface DescribeMonitoringScheduleRequest {
3833 /**
3834 * Name of a previously created monitoring schedule.
3835 */
3836 MonitoringScheduleName: MonitoringScheduleName;
3837 }
3838 export interface DescribeMonitoringScheduleResponse {
3839 /**
3840 * The Amazon Resource Name (ARN) of the monitoring schedule.
3841 */
3842 MonitoringScheduleArn: MonitoringScheduleArn;
3843 /**
3844 * Name of the monitoring schedule.
3845 */
3846 MonitoringScheduleName: MonitoringScheduleName;
3847 /**
3848 * The status of an monitoring job.
3849 */
3850 MonitoringScheduleStatus: ScheduleStatus;
3851 /**
3852 * A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
3853 */
3854 FailureReason?: FailureReason;
3855 /**
3856 * The time at which the monitoring job was created.
3857 */
3858 CreationTime: Timestamp;
3859 /**
3860 * The time at which the monitoring job was last modified.
3861 */
3862 LastModifiedTime: Timestamp;
3863 /**
3864 * The configuration object that specifies the monitoring schedule and defines the monitoring job.
3865 */
3866 MonitoringScheduleConfig: MonitoringScheduleConfig;
3867 /**
3868 * The name of the endpoint for the monitoring job.
3869 */
3870 EndpointName?: EndpointName;
3871 /**
3872 * Describes metadata on the last execution to run, if there was one.
3873 */
3874 LastMonitoringExecutionSummary?: MonitoringExecutionSummary;
3875 }
3876 export interface DescribeNotebookInstanceInput {
3877 /**
3878 * The name of the notebook instance that you want information about.
3879 */
3880 NotebookInstanceName: NotebookInstanceName;
3881 }
3882 export interface DescribeNotebookInstanceLifecycleConfigInput {
3883 /**
3884 * The name of the lifecycle configuration to describe.
3885 */
3886 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
3887 }
3888 export interface DescribeNotebookInstanceLifecycleConfigOutput {
3889 /**
3890 * The Amazon Resource Name (ARN) of the lifecycle configuration.
3891 */
3892 NotebookInstanceLifecycleConfigArn?: NotebookInstanceLifecycleConfigArn;
3893 /**
3894 * The name of the lifecycle configuration.
3895 */
3896 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
3897 /**
3898 * The shell script that runs only once, when you create a notebook instance.
3899 */
3900 OnCreate?: NotebookInstanceLifecycleConfigList;
3901 /**
3902 * The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
3903 */
3904 OnStart?: NotebookInstanceLifecycleConfigList;
3905 /**
3906 * A timestamp that tells when the lifecycle configuration was last modified.
3907 */
3908 LastModifiedTime?: LastModifiedTime;
3909 /**
3910 * A timestamp that tells when the lifecycle configuration was created.
3911 */
3912 CreationTime?: CreationTime;
3913 }
3914 export interface DescribeNotebookInstanceOutput {
3915 /**
3916 * The Amazon Resource Name (ARN) of the notebook instance.
3917 */
3918 NotebookInstanceArn?: NotebookInstanceArn;
3919 /**
3920 * The name of the Amazon SageMaker notebook instance.
3921 */
3922 NotebookInstanceName?: NotebookInstanceName;
3923 /**
3924 * The status of the notebook instance.
3925 */
3926 NotebookInstanceStatus?: NotebookInstanceStatus;
3927 /**
3928 * If status is Failed, the reason it failed.
3929 */
3930 FailureReason?: FailureReason;
3931 /**
3932 * The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
3933 */
3934 Url?: NotebookInstanceUrl;
3935 /**
3936 * The type of ML compute instance running on the notebook instance.
3937 */
3938 InstanceType?: InstanceType;
3939 /**
3940 * The ID of the VPC subnet.
3941 */
3942 SubnetId?: SubnetId;
3943 /**
3944 * The IDs of the VPC security groups.
3945 */
3946 SecurityGroups?: SecurityGroupIds;
3947 /**
3948 * The Amazon Resource Name (ARN) of the IAM role associated with the instance.
3949 */
3950 RoleArn?: RoleArn;
3951 /**
3952 * The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
3953 */
3954 KmsKeyId?: KmsKeyId;
3955 /**
3956 * The network interface IDs that Amazon SageMaker created at the time of creating the instance.
3957 */
3958 NetworkInterfaceId?: NetworkInterfaceId;
3959 /**
3960 * A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
3961 */
3962 LastModifiedTime?: LastModifiedTime;
3963 /**
3964 * A timestamp. Use this parameter to return the time when the notebook instance was created
3965 */
3966 CreationTime?: CreationTime;
3967 /**
3968 * 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
3969 */
3970 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
3971 /**
3972 * 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.
3973 */
3974 DirectInternetAccess?: DirectInternetAccess;
3975 /**
3976 * The size, in GB, of the ML storage volume attached to the notebook instance.
3977 */
3978 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
3979 /**
3980 * 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.
3981 */
3982 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
3983 /**
3984 * 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.
3985 */
3986 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
3987 /**
3988 * 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.
3989 */
3990 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
3991 /**
3992 * 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.
3993 */
3994 RootAccess?: RootAccess;
3995 }
3996 export interface DescribeProcessingJobRequest {
3997 /**
3998 * The name of the processing job. The name must be unique within an AWS Region in the AWS account.
3999 */
4000 ProcessingJobName: ProcessingJobName;
4001 }
4002 export interface DescribeProcessingJobResponse {
4003 /**
4004 * The inputs for a processing job.
4005 */
4006 ProcessingInputs?: ProcessingInputs;
4007 /**
4008 * Output configuration for the processing job.
4009 */
4010 ProcessingOutputConfig?: ProcessingOutputConfig;
4011 /**
4012 * The name of the processing job. The name must be unique within an AWS Region in the AWS account.
4013 */
4014 ProcessingJobName: ProcessingJobName;
4015 /**
4016 * Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
4017 */
4018 ProcessingResources: ProcessingResources;
4019 /**
4020 * The time limit for how long the processing job is allowed to run.
4021 */
4022 StoppingCondition?: ProcessingStoppingCondition;
4023 /**
4024 * Configures the processing job to run a specified container image.
4025 */
4026 AppSpecification: AppSpecification;
4027 /**
4028 * The environment variables set in the Docker container.
4029 */
4030 Environment?: ProcessingEnvironmentMap;
4031 /**
4032 * Networking options for a processing job.
4033 */
4034 NetworkConfig?: NetworkConfig;
4035 /**
4036 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
4037 */
4038 RoleArn?: RoleArn;
4039 /**
4040 * The configuration information used to create an experiment.
4041 */
4042 ExperimentConfig?: ExperimentConfig;
4043 /**
4044 * The Amazon Resource Name (ARN) of the processing job.
4045 */
4046 ProcessingJobArn: ProcessingJobArn;
4047 /**
4048 * Provides the status of a processing job.
4049 */
4050 ProcessingJobStatus: ProcessingJobStatus;
4051 /**
4052 * An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
4053 */
4054 ExitMessage?: ExitMessage;
4055 /**
4056 * A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
4057 */
4058 FailureReason?: FailureReason;
4059 /**
4060 * The time at which the processing job completed.
4061 */
4062 ProcessingEndTime?: Timestamp;
4063 /**
4064 * The time at which the processing job started.
4065 */
4066 ProcessingStartTime?: Timestamp;
4067 /**
4068 * The time at which the processing job was last modified.
4069 */
4070 LastModifiedTime?: Timestamp;
4071 /**
4072 * The time at which the processing job was created.
4073 */
4074 CreationTime: Timestamp;
4075 /**
4076 * The ARN of a monitoring schedule for an endpoint associated with this processing job.
4077 */
4078 MonitoringScheduleArn?: MonitoringScheduleArn;
4079 /**
4080 * The ARN of an AutoML job associated with this processing job.
4081 */
4082 AutoMLJobArn?: AutoMLJobArn;
4083 /**
4084 * The ARN of a training job associated with this processing job.
4085 */
4086 TrainingJobArn?: TrainingJobArn;
4087 }
4088 export interface DescribeSubscribedWorkteamRequest {
4089 /**
4090 * The Amazon Resource Name (ARN) of the subscribed work team to describe.
4091 */
4092 WorkteamArn: WorkteamArn;
4093 }
4094 export interface DescribeSubscribedWorkteamResponse {
4095 /**
4096 * A Workteam instance that contains information about the work team.
4097 */
4098 SubscribedWorkteam: SubscribedWorkteam;
4099 }
4100 export interface DescribeTrainingJobRequest {
4101 /**
4102 * The name of the training job.
4103 */
4104 TrainingJobName: TrainingJobName;
4105 }
4106 export interface DescribeTrainingJobResponse {
4107 /**
4108 * Name of the model training job.
4109 */
4110 TrainingJobName: TrainingJobName;
4111 /**
4112 * The Amazon Resource Name (ARN) of the training job.
4113 */
4114 TrainingJobArn: TrainingJobArn;
4115 /**
4116 * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
4117 */
4118 TuningJobArn?: HyperParameterTuningJobArn;
4119 /**
4120 * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
4121 */
4122 LabelingJobArn?: LabelingJobArn;
4123 /**
4124 *
4125 */
4126 AutoMLJobArn?: AutoMLJobArn;
4127 /**
4128 * Information about the Amazon S3 location that is configured for storing model artifacts.
4129 */
4130 ModelArtifacts: ModelArtifacts;
4131 /**
4132 * 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.
4133 */
4134 TrainingJobStatus: TrainingJobStatus;
4135 /**
4136 * 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
4137 */
4138 SecondaryStatus: SecondaryStatus;
4139 /**
4140 * If the training job failed, the reason it failed.
4141 */
4142 FailureReason?: FailureReason;
4143 /**
4144 * Algorithm-specific parameters.
4145 */
4146 HyperParameters?: HyperParameters;
4147 /**
4148 * Information about the algorithm used for training, and algorithm metadata.
4149 */
4150 AlgorithmSpecification: AlgorithmSpecification;
4151 /**
4152 * The AWS Identity and Access Management (IAM) role configured for the training job.
4153 */
4154 RoleArn?: RoleArn;
4155 /**
4156 * An array of Channel objects that describes each data input channel.
4157 */
4158 InputDataConfig?: InputDataConfig;
4159 /**
4160 * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
4161 */
4162 OutputDataConfig?: OutputDataConfig;
4163 /**
4164 * Resources, including ML compute instances and ML storage volumes, that are configured for model training.
4165 */
4166 ResourceConfig: ResourceConfig;
4167 /**
4168 * 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.
4169 */
4170 VpcConfig?: VpcConfig;
4171 /**
4172 * 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.
4173 */
4174 StoppingCondition: StoppingCondition;
4175 /**
4176 * A timestamp that indicates when the training job was created.
4177 */
4178 CreationTime: Timestamp;
4179 /**
4180 * 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.
4181 */
4182 TrainingStartTime?: Timestamp;
4183 /**
4184 * 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.
4185 */
4186 TrainingEndTime?: Timestamp;
4187 /**
4188 * A timestamp that indicates when the status of the training job was last modified.
4189 */
4190 LastModifiedTime?: Timestamp;
4191 /**
4192 * A history of all of the secondary statuses that the training job has transitioned through.
4193 */
4194 SecondaryStatusTransitions?: SecondaryStatusTransitions;
4195 /**
4196 * A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
4197 */
4198 FinalMetricDataList?: FinalMetricDataList;
4199 /**
4200 * 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.
4201 */
4202 EnableNetworkIsolation?: Boolean;
4203 /**
4204 * 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.
4205 */
4206 EnableInterContainerTrafficEncryption?: Boolean;
4207 /**
4208 * A Boolean indicating whether managed spot training is enabled (True) or not (False).
4209 */
4210 EnableManagedSpotTraining?: Boolean;
4211 CheckpointConfig?: CheckpointConfig;
4212 /**
4213 * The training time in seconds.
4214 */
4215 TrainingTimeInSeconds?: TrainingTimeInSeconds;
4216 /**
4217 * 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%.
4218 */
4219 BillableTimeInSeconds?: BillableTimeInSeconds;
4220 DebugHookConfig?: DebugHookConfig;
4221 ExperimentConfig?: ExperimentConfig;
4222 /**
4223 * Configuration information for debugging rules.
4224 */
4225 DebugRuleConfigurations?: DebugRuleConfigurations;
4226 TensorBoardOutputConfig?: TensorBoardOutputConfig;
4227 /**
4228 * Status about the debug rule evaluation.
4229 */
4230 DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatuses;
4231 }
4232 export interface DescribeTransformJobRequest {
4233 /**
4234 * The name of the transform job that you want to view details of.
4235 */
4236 TransformJobName: TransformJobName;
4237 }
4238 export interface DescribeTransformJobResponse {
4239 /**
4240 * The name of the transform job.
4241 */
4242 TransformJobName: TransformJobName;
4243 /**
4244 * The Amazon Resource Name (ARN) of the transform job.
4245 */
4246 TransformJobArn: TransformJobArn;
4247 /**
4248 * The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
4249 */
4250 TransformJobStatus: TransformJobStatus;
4251 /**
4252 * 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.
4253 */
4254 FailureReason?: FailureReason;
4255 /**
4256 * The name of the model used in the transform job.
4257 */
4258 ModelName: ModelName;
4259 /**
4260 * The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
4261 */
4262 MaxConcurrentTransforms?: MaxConcurrentTransforms;
4263 /**
4264 * The maximum payload size, in MB, used in the transform job.
4265 */
4266 MaxPayloadInMB?: MaxPayloadInMB;
4267 /**
4268 * 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.
4269 */
4270 BatchStrategy?: BatchStrategy;
4271 /**
4272 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
4273 */
4274 Environment?: TransformEnvironmentMap;
4275 /**
4276 * Describes the dataset to be transformed and the Amazon S3 location where it is stored.
4277 */
4278 TransformInput: TransformInput;
4279 /**
4280 * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
4281 */
4282 TransformOutput?: TransformOutput;
4283 /**
4284 * Describes the resources, including ML instance types and ML instance count, to use for the transform job.
4285 */
4286 TransformResources: TransformResources;
4287 /**
4288 * A timestamp that shows when the transform Job was created.
4289 */
4290 CreationTime: Timestamp;
4291 /**
4292 * Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
4293 */
4294 TransformStartTime?: Timestamp;
4295 /**
4296 * 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.
4297 */
4298 TransformEndTime?: Timestamp;
4299 /**
4300 * The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
4301 */
4302 LabelingJobArn?: LabelingJobArn;
4303 /**
4304 *
4305 */
4306 AutoMLJobArn?: AutoMLJobArn;
4307 DataProcessing?: DataProcessing;
4308 ExperimentConfig?: ExperimentConfig;
4309 }
4310 export interface DescribeTrialComponentRequest {
4311 /**
4312 * The name of the trial component to describe.
4313 */
4314 TrialComponentName: ExperimentEntityName;
4315 }
4316 export interface DescribeTrialComponentResponse {
4317 /**
4318 * The name of the trial component.
4319 */
4320 TrialComponentName?: ExperimentEntityName;
4321 /**
4322 * The Amazon Resource Name (ARN) of the trial component.
4323 */
4324 TrialComponentArn?: TrialComponentArn;
4325 /**
4326 * The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
4327 */
4328 DisplayName?: ExperimentEntityName;
4329 /**
4330 * The Amazon Resource Name (ARN) of the source and, optionally, the job type.
4331 */
4332 Source?: TrialComponentSource;
4333 /**
4334 * The status of the component. States include: InProgress Completed Failed
4335 */
4336 Status?: TrialComponentStatus;
4337 /**
4338 * When the component started.
4339 */
4340 StartTime?: Timestamp;
4341 /**
4342 * When the component ended.
4343 */
4344 EndTime?: Timestamp;
4345 /**
4346 * When the component was created.
4347 */
4348 CreationTime?: Timestamp;
4349 /**
4350 * Who created the component.
4351 */
4352 CreatedBy?: UserContext;
4353 /**
4354 * When the component was last modified.
4355 */
4356 LastModifiedTime?: Timestamp;
4357 /**
4358 * Who last modified the component.
4359 */
4360 LastModifiedBy?: UserContext;
4361 /**
4362 * The hyperparameters of the component.
4363 */
4364 Parameters?: TrialComponentParameters;
4365 /**
4366 * The input artifacts of the component.
4367 */
4368 InputArtifacts?: TrialComponentArtifacts;
4369 /**
4370 * The output artifacts of the component.
4371 */
4372 OutputArtifacts?: TrialComponentArtifacts;
4373 /**
4374 * The metrics for the component.
4375 */
4376 Metrics?: TrialComponentMetricSummaries;
4377 }
4378 export interface DescribeTrialRequest {
4379 /**
4380 * The name of the trial to describe.
4381 */
4382 TrialName: ExperimentEntityName;
4383 }
4384 export interface DescribeTrialResponse {
4385 /**
4386 * The name of the trial.
4387 */
4388 TrialName?: ExperimentEntityName;
4389 /**
4390 * The Amazon Resource Name (ARN) of the trial.
4391 */
4392 TrialArn?: TrialArn;
4393 /**
4394 * The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
4395 */
4396 DisplayName?: ExperimentEntityName;
4397 /**
4398 * The name of the experiment the trial is part of.
4399 */
4400 ExperimentName?: ExperimentEntityName;
4401 /**
4402 * The Amazon Resource Name (ARN) of the source and, optionally, the job type.
4403 */
4404 Source?: TrialSource;
4405 /**
4406 * When the trial was created.
4407 */
4408 CreationTime?: Timestamp;
4409 /**
4410 * Who created the trial.
4411 */
4412 CreatedBy?: UserContext;
4413 /**
4414 * When the trial was last modified.
4415 */
4416 LastModifiedTime?: Timestamp;
4417 /**
4418 * Who last modified the trial.
4419 */
4420 LastModifiedBy?: UserContext;
4421 }
4422 export interface DescribeUserProfileRequest {
4423 /**
4424 * The domain ID.
4425 */
4426 DomainId: DomainId;
4427 /**
4428 * The user profile name.
4429 */
4430 UserProfileName: UserProfileName;
4431 }
4432 export interface DescribeUserProfileResponse {
4433 /**
4434 * The domain ID.
4435 */
4436 DomainId?: DomainId;
4437 /**
4438 * The user profile Amazon Resource Name (ARN).
4439 */
4440 UserProfileArn?: UserProfileArn;
4441 /**
4442 * The user profile name.
4443 */
4444 UserProfileName?: UserProfileName;
4445 /**
4446 * The homa Amazon Elastic File System (EFS) Uid.
4447 */
4448 HomeEfsFileSystemUid?: EfsUid;
4449 /**
4450 * The status.
4451 */
4452 Status?: UserProfileStatus;
4453 /**
4454 * The last modified time.
4455 */
4456 LastModifiedTime?: LastModifiedTime;
4457 /**
4458 * The creation time.
4459 */
4460 CreationTime?: CreationTime;
4461 /**
4462 * The failure reason.
4463 */
4464 FailureReason?: FailureReason;
4465 /**
4466 * The SSO user identifier.
4467 */
4468 SingleSignOnUserIdentifier?: SingleSignOnUserIdentifier;
4469 /**
4470 * The SSO user value.
4471 */
4472 SingleSignOnUserValue?: String256;
4473 /**
4474 * A collection of settings.
4475 */
4476 UserSettings?: UserSettings;
4477 }
4478 export interface DescribeWorkforceRequest {
4479 /**
4480 * The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.
4481 */
4482 WorkforceName: WorkforceName;
4483 }
4484 export interface DescribeWorkforceResponse {
4485 /**
4486 * A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
4487 */
4488 Workforce: Workforce;
4489 }
4490 export interface DescribeWorkteamRequest {
4491 /**
4492 * The name of the work team to return a description of.
4493 */
4494 WorkteamName: WorkteamName;
4495 }
4496 export interface DescribeWorkteamResponse {
4497 /**
4498 * A Workteam instance that contains information about the work team.
4499 */
4500 Workteam: Workteam;
4501 }
4502 export interface DesiredWeightAndCapacity {
4503 /**
4504 * The name of the variant to update.
4505 */
4506 VariantName: VariantName;
4507 /**
4508 * The variant's weight.
4509 */
4510 DesiredWeight?: VariantWeight;
4511 /**
4512 * The variant's capacity.
4513 */
4514 DesiredInstanceCount?: TaskCount;
4515 }
4516 export type DesiredWeightAndCapacityList = DesiredWeightAndCapacity[];
4517 export type DestinationS3Uri = string;
4518 export type DetailedAlgorithmStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string;
4519 export type DetailedModelPackageStatus = "NotStarted"|"InProgress"|"Completed"|"Failed"|string;
4520 export type DirectInternetAccess = "Enabled"|"Disabled"|string;
4521 export type DirectoryPath = string;
4522 export type DisassociateAdditionalCodeRepositories = boolean;
4523 export type DisassociateDefaultCodeRepository = boolean;
4524 export type DisassociateNotebookInstanceAcceleratorTypes = boolean;
4525 export type DisassociateNotebookInstanceLifecycleConfig = boolean;
4526 export interface DisassociateTrialComponentRequest {
4527 /**
4528 * The name of the component to disassociate from the trial.
4529 */
4530 TrialComponentName: ExperimentEntityName;
4531 /**
4532 * The name of the trial to disassociate from.
4533 */
4534 TrialName: ExperimentEntityName;
4535 }
4536 export interface DisassociateTrialComponentResponse {
4537 /**
4538 * The ARN of the trial component.
4539 */
4540 TrialComponentArn?: TrialComponentArn;
4541 /**
4542 * The Amazon Resource Name (ARN) of the trial.
4543 */
4544 TrialArn?: TrialArn;
4545 }
4546 export type Dollars = number;
4547 export type DomainArn = string;
4548 export interface DomainDetails {
4549 /**
4550 * The domain's Amazon Resource Name (ARN).
4551 */
4552 DomainArn?: DomainArn;
4553 /**
4554 * The domain ID.
4555 */
4556 DomainId?: DomainId;
4557 /**
4558 * The domain name.
4559 */
4560 DomainName?: DomainName;
4561 /**
4562 * The status.
4563 */
4564 Status?: DomainStatus;
4565 /**
4566 * The creation time.
4567 */
4568 CreationTime?: CreationTime;
4569 /**
4570 * The last modified time.
4571 */
4572 LastModifiedTime?: LastModifiedTime;
4573 /**
4574 * The domain's URL.
4575 */
4576 Url?: String1024;
4577 }
4578 export type DomainId = string;
4579 export type DomainList = DomainDetails[];
4580 export type DomainName = string;
4581 export type DomainStatus = "Deleting"|"Failed"|"InService"|"Pending"|string;
4582 export type DoubleParameterValue = number;
4583 export type EfsUid = string;
4584 export type EnableCapture = boolean;
4585 export type EndpointArn = string;
4586 export type EndpointConfigArn = string;
4587 export type EndpointConfigName = string;
4588 export type EndpointConfigNameContains = string;
4589 export type EndpointConfigSortKey = "Name"|"CreationTime"|string;
4590 export interface EndpointConfigSummary {
4591 /**
4592 * The name of the endpoint configuration.
4593 */
4594 EndpointConfigName: EndpointConfigName;
4595 /**
4596 * The Amazon Resource Name (ARN) of the endpoint configuration.
4597 */
4598 EndpointConfigArn: EndpointConfigArn;
4599 /**
4600 * A timestamp that shows when the endpoint configuration was created.
4601 */
4602 CreationTime: Timestamp;
4603 }
4604 export type EndpointConfigSummaryList = EndpointConfigSummary[];
4605 export interface EndpointInput {
4606 /**
4607 * An endpoint in customer's account which has enabled DataCaptureConfig enabled.
4608 */
4609 EndpointName: EndpointName;
4610 /**
4611 * Path to the filesystem where the endpoint data is available to the container.
4612 */
4613 LocalPath: ProcessingLocalPath;
4614 /**
4615 * Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
4616 */
4617 S3InputMode?: ProcessingS3InputMode;
4618 /**
4619 * Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated
4620 */
4621 S3DataDistributionType?: ProcessingS3DataDistributionType;
4622 }
4623 export type EndpointName = string;
4624 export type EndpointNameContains = string;
4625 export type EndpointSortKey = "Name"|"CreationTime"|"Status"|string;
4626 export type EndpointStatus = "OutOfService"|"Creating"|"Updating"|"SystemUpdating"|"RollingBack"|"InService"|"Deleting"|"Failed"|string;
4627 export interface EndpointSummary {
4628 /**
4629 * The name of the endpoint.
4630 */
4631 EndpointName: EndpointName;
4632 /**
4633 * The Amazon Resource Name (ARN) of the endpoint.
4634 */
4635 EndpointArn: EndpointArn;
4636 /**
4637 * A timestamp that shows when the endpoint was created.
4638 */
4639 CreationTime: Timestamp;
4640 /**
4641 * A timestamp that shows when the endpoint was last modified.
4642 */
4643 LastModifiedTime: Timestamp;
4644 /**
4645 * 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.
4646 */
4647 EndpointStatus: EndpointStatus;
4648 }
4649 export type EndpointSummaryList = EndpointSummary[];
4650 export type EntityDescription = string;
4651 export type EntityName = string;
4652 export type EnvironmentArn = string;
4653 export type EnvironmentKey = string;
4654 export type EnvironmentMap = {[key: string]: EnvironmentValue};
4655 export type EnvironmentValue = string;
4656 export type ExecutionStatus = "Pending"|"Completed"|"CompletedWithViolations"|"InProgress"|"Failed"|"Stopping"|"Stopped"|string;
4657 export type ExitMessage = string;
4658 export interface Experiment {
4659 /**
4660 * The name of the experiment.
4661 */
4662 ExperimentName?: ExperimentEntityName;
4663 /**
4664 * The Amazon Resource Name (ARN) of the experiment.
4665 */
4666 ExperimentArn?: ExperimentArn;
4667 /**
4668 * The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
4669 */
4670 DisplayName?: ExperimentEntityName;
4671 Source?: ExperimentSource;
4672 /**
4673 * The description of the experiment.
4674 */
4675 Description?: ExperimentDescription;
4676 /**
4677 * When the experiment was created.
4678 */
4679 CreationTime?: Timestamp;
4680 CreatedBy?: UserContext;
4681 /**
4682 * When the experiment was last modified.
4683 */
4684 LastModifiedTime?: Timestamp;
4685 LastModifiedBy?: UserContext;
4686 /**
4687 * The list of tags that are associated with the experiment. You can use Search API to search on the tags.
4688 */
4689 Tags?: TagList;
4690 }
4691 export type ExperimentArn = string;
4692 export interface ExperimentConfig {
4693 /**
4694 * The name of the experiment.
4695 */
4696 ExperimentName?: ExperimentEntityName;
4697 /**
4698 * The name of the trial.
4699 */
4700 TrialName?: ExperimentEntityName;
4701 /**
4702 * Display name for the trial component.
4703 */
4704 TrialComponentDisplayName?: ExperimentEntityName;
4705 }
4706 export type ExperimentDescription = string;
4707 export type ExperimentEntityName = string;
4708 export interface ExperimentSource {
4709 /**
4710 * The Amazon Resource Name (ARN) of the source.
4711 */
4712 SourceArn: ExperimentSourceArn;
4713 /**
4714 * The source type.
4715 */
4716 SourceType?: SourceType;
4717 }
4718 export type ExperimentSourceArn = string;
4719 export type ExperimentSummaries = ExperimentSummary[];
4720 export interface ExperimentSummary {
4721 /**
4722 * The Amazon Resource Name (ARN) of the experiment.
4723 */
4724 ExperimentArn?: ExperimentArn;
4725 /**
4726 * The name of the experiment.
4727 */
4728 ExperimentName?: ExperimentEntityName;
4729 /**
4730 * The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
4731 */
4732 DisplayName?: ExperimentEntityName;
4733 ExperimentSource?: ExperimentSource;
4734 /**
4735 * When the experiment was created.
4736 */
4737 CreationTime?: Timestamp;
4738 /**
4739 * When the experiment was last modified.
4740 */
4741 LastModifiedTime?: Timestamp;
4742 }
4743 export type FailureReason = string;
4744 export type FileSystemAccessMode = "rw"|"ro"|string;
4745 export interface FileSystemDataSource {
4746 /**
4747 * The file system id.
4748 */
4749 FileSystemId: FileSystemId;
4750 /**
4751 * 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.
4752 */
4753 FileSystemAccessMode: FileSystemAccessMode;
4754 /**
4755 * The file system type.
4756 */
4757 FileSystemType: FileSystemType;
4758 /**
4759 * The full path to the directory to associate with the channel.
4760 */
4761 DirectoryPath: DirectoryPath;
4762 }
4763 export type FileSystemId = string;
4764 export type FileSystemType = "EFS"|"FSxLustre"|string;
4765 export interface Filter {
4766 /**
4767 * 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.
4768 */
4769 Name: ResourcePropertyName;
4770 /**
4771 * 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. A SearchExpression can include only one Contains operator. If you have specified a filter Value, the default is Equals.
4772 */
4773 Operator?: Operator;
4774 /**
4775 * 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.
4776 */
4777 Value?: FilterValue;
4778 }
4779 export type FilterList = Filter[];
4780 export type FilterValue = string;
4781 export interface FinalAutoMLJobObjectiveMetric {
4782 /**
4783 * The metric type used.
4784 */
4785 Type?: AutoMLJobObjectiveType;
4786 /**
4787 * The name of the metric.
4788 */
4789 MetricName: AutoMLMetricEnum;
4790 /**
4791 * The value of the metric.
4792 */
4793 Value: MetricValue;
4794 }
4795 export interface FinalHyperParameterTuningJobObjectiveMetric {
4796 /**
4797 * Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.
4798 */
4799 Type?: HyperParameterTuningJobObjectiveType;
4800 /**
4801 * The name of the objective metric.
4802 */
4803 MetricName: MetricName;
4804 /**
4805 * The value of the objective metric.
4806 */
4807 Value: MetricValue;
4808 }
4809 export type FinalMetricDataList = MetricData[];
4810 export type Float = number;
4811 export type FlowDefinitionArn = string;
4812 export type FlowDefinitionName = string;
4813 export interface FlowDefinitionOutputConfig {
4814 /**
4815 * The Amazon S3 path where the object containing human output will be made available.
4816 */
4817 S3OutputPath: S3Uri;
4818 /**
4819 * The Amazon Key Management Service (KMS) key ID for server-side encryption.
4820 */
4821 KmsKeyId?: KmsKeyId;
4822 }
4823 export type FlowDefinitionStatus = "Initializing"|"Active"|"Failed"|"Deleting"|string;
4824 export type FlowDefinitionSummaries = FlowDefinitionSummary[];
4825 export interface FlowDefinitionSummary {
4826 /**
4827 * The name of the flow definition.
4828 */
4829 FlowDefinitionName: FlowDefinitionName;
4830 /**
4831 * The Amazon Resource Name (ARN) of the flow definition.
4832 */
4833 FlowDefinitionArn: FlowDefinitionArn;
4834 /**
4835 * The status of the flow definition. Valid values:
4836 */
4837 FlowDefinitionStatus: FlowDefinitionStatus;
4838 /**
4839 * The timestamp when SageMaker created the flow definition.
4840 */
4841 CreationTime: Timestamp;
4842 /**
4843 * The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
4844 */
4845 FailureReason?: FailureReason;
4846 }
4847 export type FlowDefinitionTaskAvailabilityLifetimeInSeconds = number;
4848 export type FlowDefinitionTaskCount = number;
4849 export type FlowDefinitionTaskDescription = string;
4850 export type FlowDefinitionTaskKeyword = string;
4851 export type FlowDefinitionTaskKeywords = FlowDefinitionTaskKeyword[];
4852 export type FlowDefinitionTaskTimeLimitInSeconds = number;
4853 export type FlowDefinitionTaskTitle = string;
4854 export type Framework = "TENSORFLOW"|"KERAS"|"MXNET"|"ONNX"|"PYTORCH"|"XGBOOST"|string;
4855 export type GenerateCandidateDefinitionsOnly = boolean;
4856 export interface GetSearchSuggestionsRequest {
4857 /**
4858 * The name of the Amazon SageMaker resource to Search for.
4859 */
4860 Resource: ResourceType;
4861 /**
4862 * Limits the property names that are included in the response.
4863 */
4864 SuggestionQuery?: SuggestionQuery;
4865 }
4866 export interface GetSearchSuggestionsResponse {
4867 /**
4868 * A list of property names for a Resource that match a SuggestionQuery.
4869 */
4870 PropertyNameSuggestions?: PropertyNameSuggestionList;
4871 }
4872 export interface GitConfig {
4873 /**
4874 * The URL where the Git repository is located.
4875 */
4876 RepositoryUrl: GitConfigUrl;
4877 /**
4878 * The default branch for the Git repository.
4879 */
4880 Branch?: Branch;
4881 /**
4882 * 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}
4883 */
4884 SecretArn?: SecretArn;
4885 }
4886 export interface GitConfigForUpdate {
4887 /**
4888 * 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}
4889 */
4890 SecretArn?: SecretArn;
4891 }
4892 export type GitConfigUrl = string;
4893 export type HookParameters = {[key: string]: ConfigValue};
4894 export type HumanLoopActivationConditions = string;
4895 export interface HumanLoopActivationConditionsConfig {
4896 /**
4897 * JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
4898 */
4899 HumanLoopActivationConditions: HumanLoopActivationConditions;
4900 }
4901 export interface HumanLoopActivationConfig {
4902 /**
4903 * Container structure for defining under what conditions SageMaker creates a human loop.
4904 */
4905 HumanLoopActivationConditionsConfig: HumanLoopActivationConditionsConfig;
4906 }
4907 export interface HumanLoopConfig {
4908 /**
4909 * Amazon Resource Name (ARN) of a team of workers.
4910 */
4911 WorkteamArn: WorkteamArn;
4912 /**
4913 * The Amazon Resource Name (ARN) of the human task user interface.
4914 */
4915 HumanTaskUiArn: HumanTaskUiArn;
4916 /**
4917 * A title for the human worker task.
4918 */
4919 TaskTitle: FlowDefinitionTaskTitle;
4920 /**
4921 * A description for the human worker task.
4922 */
4923 TaskDescription: FlowDefinitionTaskDescription;
4924 /**
4925 * The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.
4926 */
4927 TaskCount: FlowDefinitionTaskCount;
4928 /**
4929 * The length of time that a task remains available for labeling by human workers.
4930 */
4931 TaskAvailabilityLifetimeInSeconds?: FlowDefinitionTaskAvailabilityLifetimeInSeconds;
4932 /**
4933 * The amount of time that a worker has to complete a task.
4934 */
4935 TaskTimeLimitInSeconds?: FlowDefinitionTaskTimeLimitInSeconds;
4936 /**
4937 * Keywords used to describe the task so that workers can discover the task.
4938 */
4939 TaskKeywords?: FlowDefinitionTaskKeywords;
4940 PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice;
4941 }
4942 export interface HumanLoopRequestSource {
4943 /**
4944 * Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:
4945 */
4946 AwsManagedHumanLoopRequestSource: AwsManagedHumanLoopRequestSource;
4947 }
4948 export interface HumanTaskConfig {
4949 /**
4950 * The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
4951 */
4952 WorkteamArn: WorkteamArn;
4953 /**
4954 * Information about the user interface that workers use to complete the labeling task.
4955 */
4956 UiConfig: UiConfig;
4957 /**
4958 * 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation Canada (Central) (ca-central-1): arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation EU (London) (eu-west-2): arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation EU Frankfurt (eu-central-1): arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation Asia Pacific (Seoul) (ap-northeast-2): arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation Asia Pacific (Mumbai) (ap-south-1): arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation Asia Pacific (Singapore) (ap-southeast-1): arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation 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-ImageMultiClassMultiLabel 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-TextMultiClassMultiLabel arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
4959 */
4960 PreHumanTaskLambdaArn: LambdaFunctionArn;
4961 /**
4962 * Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
4963 */
4964 TaskKeywords?: TaskKeywords;
4965 /**
4966 * A title for the task for your human workers.
4967 */
4968 TaskTitle: TaskTitle;
4969 /**
4970 * A description of the task for your human workers.
4971 */
4972 TaskDescription: TaskDescription;
4973 /**
4974 * The number of human workers that will label an object.
4975 */
4976 NumberOfHumanWorkersPerDataObject: NumberOfHumanWorkersPerDataObject;
4977 /**
4978 * The amount of time that a worker has to complete a task.
4979 */
4980 TaskTimeLimitInSeconds: TaskTimeLimitInSeconds;
4981 /**
4982 * 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). The default value is 864000 seconds (10 days). For private and vendor workforces, the maximum is as listed.
4983 */
4984 TaskAvailabilityLifetimeInSeconds?: TaskAvailabilityLifetimeInSeconds;
4985 /**
4986 * Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects.
4987 */
4988 MaxConcurrentTaskCount?: MaxConcurrentTaskCount;
4989 /**
4990 * Configures how labels are consolidated across human workers.
4991 */
4992 AnnotationConsolidationConfig: AnnotationConsolidationConfig;
4993 /**
4994 * The price that you pay for each task performed by an Amazon Mechanical Turk worker.
4995 */
4996 PublicWorkforceTaskPrice?: PublicWorkforceTaskPrice;
4997 }
4998 export type HumanTaskUiArn = string;
4999 export type HumanTaskUiName = string;
5000 export type HumanTaskUiSummaries = HumanTaskUiSummary[];
5001 export interface HumanTaskUiSummary {
5002 /**
5003 * The name of the human task user interface.
5004 */
5005 HumanTaskUiName: HumanTaskUiName;
5006 /**
5007 * The Amazon Resource Name (ARN) of the human task user interface.
5008 */
5009 HumanTaskUiArn: HumanTaskUiArn;
5010 /**
5011 * A timestamp when SageMaker created the human task user interface.
5012 */
5013 CreationTime: Timestamp;
5014 }
5015 export interface HyperParameterAlgorithmSpecification {
5016 /**
5017 * 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.
5018 */
5019 TrainingImage?: AlgorithmImage;
5020 /**
5021 * 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.
5022 */
5023 TrainingInputMode: TrainingInputMode;
5024 /**
5025 * 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.
5026 */
5027 AlgorithmName?: ArnOrName;
5028 /**
5029 * An array of MetricDefinition objects that specify the metrics that the algorithm emits.
5030 */
5031 MetricDefinitions?: MetricDefinitionList;
5032 }
5033 export type HyperParameterScalingType = "Auto"|"Linear"|"Logarithmic"|"ReverseLogarithmic"|string;
5034 export interface HyperParameterSpecification {
5035 /**
5036 * The name of this hyperparameter. The name must be unique.
5037 */
5038 Name: ParameterName;
5039 /**
5040 * A brief description of the hyperparameter.
5041 */
5042 Description?: EntityDescription;
5043 /**
5044 * The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
5045 */
5046 Type: ParameterType;
5047 /**
5048 * The allowed range for this hyperparameter.
5049 */
5050 Range?: ParameterRange;
5051 /**
5052 * Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
5053 */
5054 IsTunable?: Boolean;
5055 /**
5056 * Indicates whether this hyperparameter is required.
5057 */
5058 IsRequired?: Boolean;
5059 /**
5060 * The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
5061 */
5062 DefaultValue?: ParameterValue;
5063 }
5064 export type HyperParameterSpecifications = HyperParameterSpecification[];
5065 export interface HyperParameterTrainingJobDefinition {
5066 /**
5067 * The job definition name.
5068 */
5069 DefinitionName?: HyperParameterTrainingJobDefinitionName;
5070 TuningObjective?: HyperParameterTuningJobObjective;
5071 HyperParameterRanges?: ParameterRanges;
5072 /**
5073 * Specifies the values of hyperparameters that do not change for the tuning job.
5074 */
5075 StaticHyperParameters?: HyperParameters;
5076 /**
5077 * The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
5078 */
5079 AlgorithmSpecification: HyperParameterAlgorithmSpecification;
5080 /**
5081 * The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
5082 */
5083 RoleArn: RoleArn;
5084 /**
5085 * An array of Channel objects that specify the input for the training jobs that the tuning job launches.
5086 */
5087 InputDataConfig?: InputDataConfig;
5088 /**
5089 * 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.
5090 */
5091 VpcConfig?: VpcConfig;
5092 /**
5093 * Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
5094 */
5095 OutputDataConfig: OutputDataConfig;
5096 /**
5097 * 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.
5098 */
5099 ResourceConfig: ResourceConfig;
5100 /**
5101 * 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.
5102 */
5103 StoppingCondition: StoppingCondition;
5104 /**
5105 * 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.
5106 */
5107 EnableNetworkIsolation?: Boolean;
5108 /**
5109 * 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.
5110 */
5111 EnableInterContainerTrafficEncryption?: Boolean;
5112 /**
5113 * A Boolean indicating whether managed spot training is enabled (True) or not (False).
5114 */
5115 EnableManagedSpotTraining?: Boolean;
5116 CheckpointConfig?: CheckpointConfig;
5117 }
5118 export type HyperParameterTrainingJobDefinitionName = string;
5119 export type HyperParameterTrainingJobDefinitions = HyperParameterTrainingJobDefinition[];
5120 export type HyperParameterTrainingJobSummaries = HyperParameterTrainingJobSummary[];
5121 export interface HyperParameterTrainingJobSummary {
5122 /**
5123 * The training job definition name.
5124 */
5125 TrainingJobDefinitionName?: HyperParameterTrainingJobDefinitionName;
5126 /**
5127 * The name of the training job.
5128 */
5129 TrainingJobName: TrainingJobName;
5130 /**
5131 * The Amazon Resource Name (ARN) of the training job.
5132 */
5133 TrainingJobArn: TrainingJobArn;
5134 /**
5135 * The HyperParameter tuning job that launched the training job.
5136 */
5137 TuningJobName?: HyperParameterTuningJobName;
5138 /**
5139 * The date and time that the training job was created.
5140 */
5141 CreationTime: Timestamp;
5142 /**
5143 * The date and time that the training job started.
5144 */
5145 TrainingStartTime?: Timestamp;
5146 /**
5147 * 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.
5148 */
5149 TrainingEndTime?: Timestamp;
5150 /**
5151 * The status of the training job.
5152 */
5153 TrainingJobStatus: TrainingJobStatus;
5154 /**
5155 * A list of the hyperparameters for which you specified ranges to search.
5156 */
5157 TunedHyperParameters: HyperParameters;
5158 /**
5159 * The reason that the training job failed.
5160 */
5161 FailureReason?: FailureReason;
5162 /**
5163 * The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
5164 */
5165 FinalHyperParameterTuningJobObjectiveMetric?: FinalHyperParameterTuningJobObjectiveMetric;
5166 /**
5167 * 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.
5168 */
5169 ObjectiveStatus?: ObjectiveStatus;
5170 }
5171 export type HyperParameterTuningJobArn = string;
5172 export interface HyperParameterTuningJobConfig {
5173 /**
5174 * Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search strategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.
5175 */
5176 Strategy: HyperParameterTuningJobStrategyType;
5177 /**
5178 * The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
5179 */
5180 HyperParameterTuningJobObjective?: HyperParameterTuningJobObjective;
5181 /**
5182 * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
5183 */
5184 ResourceLimits: ResourceLimits;
5185 /**
5186 * The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
5187 */
5188 ParameterRanges?: ParameterRanges;
5189 /**
5190 * 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.
5191 */
5192 TrainingJobEarlyStoppingType?: TrainingJobEarlyStoppingType;
5193 /**
5194 * The tuning job's completion criteria.
5195 */
5196 TuningJobCompletionCriteria?: TuningJobCompletionCriteria;
5197 }
5198 export type HyperParameterTuningJobName = string;
5199 export interface HyperParameterTuningJobObjective {
5200 /**
5201 * Whether to minimize or maximize the objective metric.
5202 */
5203 Type: HyperParameterTuningJobObjectiveType;
5204 /**
5205 * The name of the metric to use for the objective metric.
5206 */
5207 MetricName: MetricName;
5208 }
5209 export type HyperParameterTuningJobObjectiveType = "Maximize"|"Minimize"|string;
5210 export type HyperParameterTuningJobObjectives = HyperParameterTuningJobObjective[];
5211 export type HyperParameterTuningJobSortByOptions = "Name"|"Status"|"CreationTime"|string;
5212 export type HyperParameterTuningJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|string;
5213 export type HyperParameterTuningJobStrategyType = "Bayesian"|"Random"|string;
5214 export type HyperParameterTuningJobSummaries = HyperParameterTuningJobSummary[];
5215 export interface HyperParameterTuningJobSummary {
5216 /**
5217 * The name of the tuning job.
5218 */
5219 HyperParameterTuningJobName: HyperParameterTuningJobName;
5220 /**
5221 * The Amazon Resource Name (ARN) of the tuning job.
5222 */
5223 HyperParameterTuningJobArn: HyperParameterTuningJobArn;
5224 /**
5225 * The status of the tuning job.
5226 */
5227 HyperParameterTuningJobStatus: HyperParameterTuningJobStatus;
5228 /**
5229 * Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
5230 */
5231 Strategy: HyperParameterTuningJobStrategyType;
5232 /**
5233 * The date and time that the tuning job was created.
5234 */
5235 CreationTime: Timestamp;
5236 /**
5237 * The date and time that the tuning job ended.
5238 */
5239 HyperParameterTuningEndTime?: Timestamp;
5240 /**
5241 * The date and time that the tuning job was modified.
5242 */
5243 LastModifiedTime?: Timestamp;
5244 /**
5245 * The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
5246 */
5247 TrainingJobStatusCounters: TrainingJobStatusCounters;
5248 /**
5249 * The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
5250 */
5251 ObjectiveStatusCounters: ObjectiveStatusCounters;
5252 /**
5253 * The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
5254 */
5255 ResourceLimits?: ResourceLimits;
5256 }
5257 export interface HyperParameterTuningJobWarmStartConfig {
5258 /**
5259 * 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.
5260 */
5261 ParentHyperParameterTuningJobs: ParentHyperParameterTuningJobs;
5262 /**
5263 * 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.
5264 */
5265 WarmStartType: HyperParameterTuningJobWarmStartType;
5266 }
5267 export type HyperParameterTuningJobWarmStartType = "IdenticalDataAndAlgorithm"|"TransferLearning"|string;
5268 export type HyperParameters = {[key: string]: ParameterValue};
5269 export type Image = string;
5270 export type ImageDigest = string;
5271 export type ImageUri = string;
5272 export interface InferenceSpecification {
5273 /**
5274 * The Amazon ECR registry path of the Docker image that contains the inference code.
5275 */
5276 Containers: ModelPackageContainerDefinitionList;
5277 /**
5278 * A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
5279 */
5280 SupportedTransformInstanceTypes: TransformInstanceTypes;
5281 /**
5282 * A list of the instance types that are used to generate inferences in real-time.
5283 */
5284 SupportedRealtimeInferenceInstanceTypes: RealtimeInferenceInstanceTypes;
5285 /**
5286 * The supported MIME types for the input data.
5287 */
5288 SupportedContentTypes: ContentTypes;
5289 /**
5290 * The supported MIME types for the output data.
5291 */
5292 SupportedResponseMIMETypes: ResponseMIMETypes;
5293 }
5294 export interface InputConfig {
5295 /**
5296 * 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).
5297 */
5298 S3Uri: S3Uri;
5299 /**
5300 * 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]} KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different. Examples for one input: If using the console, {"input_1":[1,3,224,224]} If using the CLI, {\"input_1\":[1,3,224,224]} Examples for two inputs: If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]} If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]} 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.
5301 */
5302 DataInputConfig: DataInputConfig;
5303 /**
5304 * Identifies the framework in which the model was trained. For example: TENSORFLOW.
5305 */
5306 Framework: Framework;
5307 }
5308 export type InputDataConfig = Channel[];
5309 export type InputModes = TrainingInputMode[];
5310 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;
5311 export interface IntegerParameterRange {
5312 /**
5313 * The name of the hyperparameter to search.
5314 */
5315 Name: ParameterKey;
5316 /**
5317 * The minimum value of the hyperparameter to search.
5318 */
5319 MinValue: ParameterValue;
5320 /**
5321 * The maximum value of the hyperparameter to search.
5322 */
5323 MaxValue: ParameterValue;
5324 /**
5325 * 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.
5326 */
5327 ScalingType?: HyperParameterScalingType;
5328 }
5329 export interface IntegerParameterRangeSpecification {
5330 /**
5331 * The minimum integer value allowed.
5332 */
5333 MinValue: ParameterValue;
5334 /**
5335 * The maximum integer value allowed.
5336 */
5337 MaxValue: ParameterValue;
5338 }
5339 export type IntegerParameterRanges = IntegerParameterRange[];
5340 export type JobReferenceCode = string;
5341 export type JobReferenceCodeContains = string;
5342 export type JoinSource = "Input"|"None"|string;
5343 export type JsonContentType = string;
5344 export type JsonContentTypes = JsonContentType[];
5345 export type JsonPath = string;
5346 export interface JupyterServerAppSettings {
5347 /**
5348 * The instance type and quantity.
5349 */
5350 DefaultResourceSpec?: ResourceSpec;
5351 }
5352 export interface KernelGatewayAppSettings {
5353 /**
5354 * The instance type and quantity.
5355 */
5356 DefaultResourceSpec?: ResourceSpec;
5357 }
5358 export type KmsKeyId = string;
5359 export type LabelAttributeName = string;
5360 export type LabelCounter = number;
5361 export interface LabelCounters {
5362 /**
5363 * The total number of objects labeled.
5364 */
5365 TotalLabeled?: LabelCounter;
5366 /**
5367 * The total number of objects labeled by a human worker.
5368 */
5369 HumanLabeled?: LabelCounter;
5370 /**
5371 * The total number of objects labeled by automated data labeling.
5372 */
5373 MachineLabeled?: LabelCounter;
5374 /**
5375 * The total number of objects that could not be labeled due to an error.
5376 */
5377 FailedNonRetryableError?: LabelCounter;
5378 /**
5379 * The total number of objects not yet labeled.
5380 */
5381 Unlabeled?: LabelCounter;
5382 }
5383 export interface LabelCountersForWorkteam {
5384 /**
5385 * The total number of data objects labeled by a human worker.
5386 */
5387 HumanLabeled?: LabelCounter;
5388 /**
5389 * The total number of data objects that need to be labeled by a human worker.
5390 */
5391 PendingHuman?: LabelCounter;
5392 /**
5393 * The total number of tasks in the labeling job.
5394 */
5395 Total?: LabelCounter;
5396 }
5397 export type LabelingJobAlgorithmSpecificationArn = string;
5398 export interface LabelingJobAlgorithmsConfig {
5399 /**
5400 * 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
5401 */
5402 LabelingJobAlgorithmSpecificationArn: LabelingJobAlgorithmSpecificationArn;
5403 /**
5404 * 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.
5405 */
5406 InitialActiveLearningModelArn?: ModelArn;
5407 /**
5408 * Provides configuration information for a labeling job.
5409 */
5410 LabelingJobResourceConfig?: LabelingJobResourceConfig;
5411 }
5412 export type LabelingJobArn = string;
5413 export interface LabelingJobDataAttributes {
5414 /**
5415 * 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.
5416 */
5417 ContentClassifiers?: ContentClassifiers;
5418 }
5419 export interface LabelingJobDataSource {
5420 /**
5421 * The Amazon S3 location of the input data objects.
5422 */
5423 S3DataSource: LabelingJobS3DataSource;
5424 }
5425 export interface LabelingJobForWorkteamSummary {
5426 /**
5427 * The name of the labeling job that the work team is assigned to.
5428 */
5429 LabelingJobName?: LabelingJobName;
5430 /**
5431 * A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
5432 */
5433 JobReferenceCode: JobReferenceCode;
5434 /**
5435 *
5436 */
5437 WorkRequesterAccountId: AccountId;
5438 /**
5439 * The date and time that the labeling job was created.
5440 */
5441 CreationTime: Timestamp;
5442 /**
5443 * Provides information about the progress of a labeling job.
5444 */
5445 LabelCounters?: LabelCountersForWorkteam;
5446 /**
5447 * The configured number of workers per data object.
5448 */
5449 NumberOfHumanWorkersPerDataObject?: NumberOfHumanWorkersPerDataObject;
5450 }
5451 export type LabelingJobForWorkteamSummaryList = LabelingJobForWorkteamSummary[];
5452 export interface LabelingJobInputConfig {
5453 /**
5454 * The location of the input data.
5455 */
5456 DataSource: LabelingJobDataSource;
5457 /**
5458 * Attributes of the data specified by the customer.
5459 */
5460 DataAttributes?: LabelingJobDataAttributes;
5461 }
5462 export type LabelingJobName = string;
5463 export interface LabelingJobOutput {
5464 /**
5465 * The Amazon S3 bucket location of the manifest file for labeled data.
5466 */
5467 OutputDatasetS3Uri: S3Uri;
5468 /**
5469 * The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.
5470 */
5471 FinalActiveLearningModelArn?: ModelArn;
5472 }
5473 export interface LabelingJobOutputConfig {
5474 /**
5475 * The Amazon S3 location to write output data.
5476 */
5477 S3OutputPath: S3Uri;
5478 /**
5479 * 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.
5480 */
5481 KmsKeyId?: KmsKeyId;
5482 }
5483 export interface LabelingJobResourceConfig {
5484 /**
5485 * 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"
5486 */
5487 VolumeKmsKeyId?: KmsKeyId;
5488 }
5489 export interface LabelingJobS3DataSource {
5490 /**
5491 * The Amazon S3 location of the manifest file that describes the input data objects.
5492 */
5493 ManifestS3Uri: S3Uri;
5494 }
5495 export type LabelingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
5496 export interface LabelingJobStoppingConditions {
5497 /**
5498 * The maximum number of objects that can be labeled by human workers.
5499 */
5500 MaxHumanLabeledObjectCount?: MaxHumanLabeledObjectCount;
5501 /**
5502 * The maximum number of input data objects that should be labeled.
5503 */
5504 MaxPercentageOfInputDatasetLabeled?: MaxPercentageOfInputDatasetLabeled;
5505 }
5506 export interface LabelingJobSummary {
5507 /**
5508 * The name of the labeling job.
5509 */
5510 LabelingJobName: LabelingJobName;
5511 /**
5512 * The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
5513 */
5514 LabelingJobArn: LabelingJobArn;
5515 /**
5516 * The date and time that the job was created (timestamp).
5517 */
5518 CreationTime: Timestamp;
5519 /**
5520 * The date and time that the job was last modified (timestamp).
5521 */
5522 LastModifiedTime: Timestamp;
5523 /**
5524 * The current status of the labeling job.
5525 */
5526 LabelingJobStatus: LabelingJobStatus;
5527 /**
5528 * Counts showing the progress of the labeling job.
5529 */
5530 LabelCounters: LabelCounters;
5531 /**
5532 * The Amazon Resource Name (ARN) of the work team assigned to the job.
5533 */
5534 WorkteamArn: WorkteamArn;
5535 /**
5536 * The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
5537 */
5538 PreHumanTaskLambdaArn: LambdaFunctionArn;
5539 /**
5540 * 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.
5541 */
5542 AnnotationConsolidationLambdaArn?: LambdaFunctionArn;
5543 /**
5544 * If the LabelingJobStatus field is Failed, this field contains a description of the error.
5545 */
5546 FailureReason?: FailureReason;
5547 /**
5548 * The location of the output produced by the labeling job.
5549 */
5550 LabelingJobOutput?: LabelingJobOutput;
5551 /**
5552 * Input configuration for the labeling job.
5553 */
5554 InputConfig?: LabelingJobInputConfig;
5555 }
5556 export type LabelingJobSummaryList = LabelingJobSummary[];
5557 export type LambdaFunctionArn = string;
5558 export type LastModifiedTime = Date;
5559 export interface ListAlgorithmsInput {
5560 /**
5561 * A filter that returns only algorithms created after the specified time (timestamp).
5562 */
5563 CreationTimeAfter?: CreationTime;
5564 /**
5565 * A filter that returns only algorithms created before the specified time (timestamp).
5566 */
5567 CreationTimeBefore?: CreationTime;
5568 /**
5569 * The maximum number of algorithms to return in the response.
5570 */
5571 MaxResults?: MaxResults;
5572 /**
5573 * A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
5574 */
5575 NameContains?: NameContains;
5576 /**
5577 * 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.
5578 */
5579 NextToken?: NextToken;
5580 /**
5581 * The parameter by which to sort the results. The default is CreationTime.
5582 */
5583 SortBy?: AlgorithmSortBy;
5584 /**
5585 * The sort order for the results. The default is Ascending.
5586 */
5587 SortOrder?: SortOrder;
5588 }
5589 export interface ListAlgorithmsOutput {
5590 /**
5591 * &gt;An array of AlgorithmSummary objects, each of which lists an algorithm.
5592 */
5593 AlgorithmSummaryList: AlgorithmSummaryList;
5594 /**
5595 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
5596 */
5597 NextToken?: NextToken;
5598 }
5599 export interface ListAppsRequest {
5600 /**
5601 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5602 */
5603 NextToken?: NextToken;
5604 /**
5605 * Returns a list up to a specified limit.
5606 */
5607 MaxResults?: MaxResults;
5608 /**
5609 * The sort order for the results. The default is Ascending.
5610 */
5611 SortOrder?: SortOrder;
5612 /**
5613 * The parameter by which to sort the results. The default is CreationTime.
5614 */
5615 SortBy?: AppSortKey;
5616 /**
5617 * A parameter to search for the domain ID.
5618 */
5619 DomainIdEquals?: DomainId;
5620 /**
5621 * A parameter to search by user profile name.
5622 */
5623 UserProfileNameEquals?: UserProfileName;
5624 }
5625 export interface ListAppsResponse {
5626 /**
5627 * The list of apps.
5628 */
5629 Apps?: AppList;
5630 /**
5631 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5632 */
5633 NextToken?: NextToken;
5634 }
5635 export interface ListAutoMLJobsRequest {
5636 /**
5637 * Request a list of jobs, using a filter for time.
5638 */
5639 CreationTimeAfter?: Timestamp;
5640 /**
5641 * Request a list of jobs, using a filter for time.
5642 */
5643 CreationTimeBefore?: Timestamp;
5644 /**
5645 * Request a list of jobs, using a filter for time.
5646 */
5647 LastModifiedTimeAfter?: Timestamp;
5648 /**
5649 * Request a list of jobs, using a filter for time.
5650 */
5651 LastModifiedTimeBefore?: Timestamp;
5652 /**
5653 * Request a list of jobs, using a search filter for name.
5654 */
5655 NameContains?: AutoMLNameContains;
5656 /**
5657 * Request a list of jobs, using a filter for status.
5658 */
5659 StatusEquals?: AutoMLJobStatus;
5660 /**
5661 * The sort order for the results. The default is Descending.
5662 */
5663 SortOrder?: AutoMLSortOrder;
5664 /**
5665 * The parameter by which to sort the results. The default is AutoMLJobName.
5666 */
5667 SortBy?: AutoMLSortBy;
5668 /**
5669 * Request a list of jobs up to a specified limit.
5670 */
5671 MaxResults?: AutoMLMaxResults;
5672 /**
5673 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5674 */
5675 NextToken?: NextToken;
5676 }
5677 export interface ListAutoMLJobsResponse {
5678 /**
5679 * Returns a summary list of jobs.
5680 */
5681 AutoMLJobSummaries: AutoMLJobSummaries;
5682 /**
5683 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5684 */
5685 NextToken?: NextToken;
5686 }
5687 export interface ListCandidatesForAutoMLJobRequest {
5688 /**
5689 * List the Candidates created for the job by providing the job's name.
5690 */
5691 AutoMLJobName: AutoMLJobName;
5692 /**
5693 * List the Candidates for the job and filter by status.
5694 */
5695 StatusEquals?: CandidateStatus;
5696 /**
5697 * List the Candidates for the job and filter by candidate name.
5698 */
5699 CandidateNameEquals?: CandidateName;
5700 /**
5701 * The sort order for the results. The default is Ascending.
5702 */
5703 SortOrder?: AutoMLSortOrder;
5704 /**
5705 * The parameter by which to sort the results. The default is Descending.
5706 */
5707 SortBy?: CandidateSortBy;
5708 /**
5709 * List the job's Candidates up to a specified limit.
5710 */
5711 MaxResults?: AutoMLMaxResults;
5712 /**
5713 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5714 */
5715 NextToken?: NextToken;
5716 }
5717 export interface ListCandidatesForAutoMLJobResponse {
5718 /**
5719 * Summaries about the Candidates.
5720 */
5721 Candidates: AutoMLCandidates;
5722 /**
5723 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5724 */
5725 NextToken?: NextToken;
5726 }
5727 export interface ListCodeRepositoriesInput {
5728 /**
5729 * A filter that returns only Git repositories that were created after the specified time.
5730 */
5731 CreationTimeAfter?: CreationTime;
5732 /**
5733 * A filter that returns only Git repositories that were created before the specified time.
5734 */
5735 CreationTimeBefore?: CreationTime;
5736 /**
5737 * A filter that returns only Git repositories that were last modified after the specified time.
5738 */
5739 LastModifiedTimeAfter?: Timestamp;
5740 /**
5741 * A filter that returns only Git repositories that were last modified before the specified time.
5742 */
5743 LastModifiedTimeBefore?: Timestamp;
5744 /**
5745 * The maximum number of Git repositories to return in the response.
5746 */
5747 MaxResults?: MaxResults;
5748 /**
5749 * A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
5750 */
5751 NameContains?: CodeRepositoryNameContains;
5752 /**
5753 * 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.
5754 */
5755 NextToken?: NextToken;
5756 /**
5757 * The field to sort results by. The default is Name.
5758 */
5759 SortBy?: CodeRepositorySortBy;
5760 /**
5761 * The sort order for results. The default is Ascending.
5762 */
5763 SortOrder?: CodeRepositorySortOrder;
5764 }
5765 export interface ListCodeRepositoriesOutput {
5766 /**
5767 * 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.
5768 */
5769 CodeRepositorySummaryList: CodeRepositorySummaryList;
5770 /**
5771 * 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.
5772 */
5773 NextToken?: NextToken;
5774 }
5775 export interface ListCompilationJobsRequest {
5776 /**
5777 * 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.
5778 */
5779 NextToken?: NextToken;
5780 /**
5781 * The maximum number of model compilation jobs to return in the response.
5782 */
5783 MaxResults?: MaxResults;
5784 /**
5785 * A filter that returns the model compilation jobs that were created after a specified time.
5786 */
5787 CreationTimeAfter?: CreationTime;
5788 /**
5789 * A filter that returns the model compilation jobs that were created before a specified time.
5790 */
5791 CreationTimeBefore?: CreationTime;
5792 /**
5793 * A filter that returns the model compilation jobs that were modified after a specified time.
5794 */
5795 LastModifiedTimeAfter?: LastModifiedTime;
5796 /**
5797 * A filter that returns the model compilation jobs that were modified before a specified time.
5798 */
5799 LastModifiedTimeBefore?: LastModifiedTime;
5800 /**
5801 * A filter that returns the model compilation jobs whose name contains a specified string.
5802 */
5803 NameContains?: NameContains;
5804 /**
5805 * A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.
5806 */
5807 StatusEquals?: CompilationJobStatus;
5808 /**
5809 * The field by which to sort results. The default is CreationTime.
5810 */
5811 SortBy?: ListCompilationJobsSortBy;
5812 /**
5813 * The sort order for results. The default is Ascending.
5814 */
5815 SortOrder?: SortOrder;
5816 }
5817 export interface ListCompilationJobsResponse {
5818 /**
5819 * An array of CompilationJobSummary objects, each describing a model compilation job.
5820 */
5821 CompilationJobSummaries: CompilationJobSummaries;
5822 /**
5823 * 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.
5824 */
5825 NextToken?: NextToken;
5826 }
5827 export type ListCompilationJobsSortBy = "Name"|"CreationTime"|"Status"|string;
5828 export interface ListDomainsRequest {
5829 /**
5830 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5831 */
5832 NextToken?: NextToken;
5833 /**
5834 * Returns a list up to a specified limit.
5835 */
5836 MaxResults?: MaxResults;
5837 }
5838 export interface ListDomainsResponse {
5839 /**
5840 * The list of domains.
5841 */
5842 Domains?: DomainList;
5843 /**
5844 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
5845 */
5846 NextToken?: NextToken;
5847 }
5848 export interface ListEndpointConfigsInput {
5849 /**
5850 * The field to sort results by. The default is CreationTime.
5851 */
5852 SortBy?: EndpointConfigSortKey;
5853 /**
5854 * The sort order for results. The default is Descending.
5855 */
5856 SortOrder?: OrderKey;
5857 /**
5858 * 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.
5859 */
5860 NextToken?: PaginationToken;
5861 /**
5862 * The maximum number of training jobs to return in the response.
5863 */
5864 MaxResults?: MaxResults;
5865 /**
5866 * A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
5867 */
5868 NameContains?: EndpointConfigNameContains;
5869 /**
5870 * A filter that returns only endpoint configurations created before the specified time (timestamp).
5871 */
5872 CreationTimeBefore?: Timestamp;
5873 /**
5874 * A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
5875 */
5876 CreationTimeAfter?: Timestamp;
5877 }
5878 export interface ListEndpointConfigsOutput {
5879 /**
5880 * An array of endpoint configurations.
5881 */
5882 EndpointConfigs: EndpointConfigSummaryList;
5883 /**
5884 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
5885 */
5886 NextToken?: PaginationToken;
5887 }
5888 export interface ListEndpointsInput {
5889 /**
5890 * Sorts the list of results. The default is CreationTime.
5891 */
5892 SortBy?: EndpointSortKey;
5893 /**
5894 * The sort order for results. The default is Descending.
5895 */
5896 SortOrder?: OrderKey;
5897 /**
5898 * 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.
5899 */
5900 NextToken?: PaginationToken;
5901 /**
5902 * The maximum number of endpoints to return in the response.
5903 */
5904 MaxResults?: MaxResults;
5905 /**
5906 * A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
5907 */
5908 NameContains?: EndpointNameContains;
5909 /**
5910 * A filter that returns only endpoints that were created before the specified time (timestamp).
5911 */
5912 CreationTimeBefore?: Timestamp;
5913 /**
5914 * A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
5915 */
5916 CreationTimeAfter?: Timestamp;
5917 /**
5918 * A filter that returns only endpoints that were modified before the specified timestamp.
5919 */
5920 LastModifiedTimeBefore?: Timestamp;
5921 /**
5922 * A filter that returns only endpoints that were modified after the specified timestamp.
5923 */
5924 LastModifiedTimeAfter?: Timestamp;
5925 /**
5926 * A filter that returns only endpoints with the specified status.
5927 */
5928 StatusEquals?: EndpointStatus;
5929 }
5930 export interface ListEndpointsOutput {
5931 /**
5932 * An array or endpoint objects.
5933 */
5934 Endpoints: EndpointSummaryList;
5935 /**
5936 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
5937 */
5938 NextToken?: PaginationToken;
5939 }
5940 export interface ListExperimentsRequest {
5941 /**
5942 * A filter that returns only experiments created after the specified time.
5943 */
5944 CreatedAfter?: Timestamp;
5945 /**
5946 * A filter that returns only experiments created before the specified time.
5947 */
5948 CreatedBefore?: Timestamp;
5949 /**
5950 * The property used to sort results. The default value is CreationTime.
5951 */
5952 SortBy?: SortExperimentsBy;
5953 /**
5954 * The sort order. The default value is Descending.
5955 */
5956 SortOrder?: SortOrder;
5957 /**
5958 * If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.
5959 */
5960 NextToken?: NextToken;
5961 /**
5962 * The maximum number of experiments to return in the response. The default value is 10.
5963 */
5964 MaxResults?: MaxResults;
5965 }
5966 export interface ListExperimentsResponse {
5967 /**
5968 * A list of the summaries of your experiments.
5969 */
5970 ExperimentSummaries?: ExperimentSummaries;
5971 /**
5972 * A token for getting the next set of experiments, if there are any.
5973 */
5974 NextToken?: NextToken;
5975 }
5976 export interface ListFlowDefinitionsRequest {
5977 /**
5978 * A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
5979 */
5980 CreationTimeAfter?: Timestamp;
5981 /**
5982 * A filter that returns only flow definitions that were created before the specified timestamp.
5983 */
5984 CreationTimeBefore?: Timestamp;
5985 /**
5986 * An optional value that specifies whether you want the results sorted in Ascending or Descending order.
5987 */
5988 SortOrder?: SortOrder;
5989 /**
5990 * A token to resume pagination.
5991 */
5992 NextToken?: NextToken;
5993 /**
5994 * The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
5995 */
5996 MaxResults?: MaxResults;
5997 }
5998 export interface ListFlowDefinitionsResponse {
5999 /**
6000 * An array of objects describing the flow definitions.
6001 */
6002 FlowDefinitionSummaries: FlowDefinitionSummaries;
6003 /**
6004 * A token to resume pagination.
6005 */
6006 NextToken?: NextToken;
6007 }
6008 export interface ListHumanTaskUisRequest {
6009 /**
6010 * A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
6011 */
6012 CreationTimeAfter?: Timestamp;
6013 /**
6014 * A filter that returns only human task user interfaces that were created before the specified timestamp.
6015 */
6016 CreationTimeBefore?: Timestamp;
6017 /**
6018 * An optional value that specifies whether you want the results sorted in Ascending or Descending order.
6019 */
6020 SortOrder?: SortOrder;
6021 /**
6022 * A token to resume pagination.
6023 */
6024 NextToken?: NextToken;
6025 /**
6026 * The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
6027 */
6028 MaxResults?: MaxResults;
6029 }
6030 export interface ListHumanTaskUisResponse {
6031 /**
6032 * An array of objects describing the human task user interfaces.
6033 */
6034 HumanTaskUiSummaries: HumanTaskUiSummaries;
6035 /**
6036 * A token to resume pagination.
6037 */
6038 NextToken?: NextToken;
6039 }
6040 export interface ListHyperParameterTuningJobsRequest {
6041 /**
6042 * 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.
6043 */
6044 NextToken?: NextToken;
6045 /**
6046 * The maximum number of tuning jobs to return. The default value is 10.
6047 */
6048 MaxResults?: MaxResults;
6049 /**
6050 * The field to sort results by. The default is Name.
6051 */
6052 SortBy?: HyperParameterTuningJobSortByOptions;
6053 /**
6054 * The sort order for results. The default is Ascending.
6055 */
6056 SortOrder?: SortOrder;
6057 /**
6058 * A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
6059 */
6060 NameContains?: NameContains;
6061 /**
6062 * A filter that returns only tuning jobs that were created after the specified time.
6063 */
6064 CreationTimeAfter?: Timestamp;
6065 /**
6066 * A filter that returns only tuning jobs that were created before the specified time.
6067 */
6068 CreationTimeBefore?: Timestamp;
6069 /**
6070 * A filter that returns only tuning jobs that were modified after the specified time.
6071 */
6072 LastModifiedTimeAfter?: Timestamp;
6073 /**
6074 * A filter that returns only tuning jobs that were modified before the specified time.
6075 */
6076 LastModifiedTimeBefore?: Timestamp;
6077 /**
6078 * A filter that returns only tuning jobs with the specified status.
6079 */
6080 StatusEquals?: HyperParameterTuningJobStatus;
6081 }
6082 export interface ListHyperParameterTuningJobsResponse {
6083 /**
6084 * A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
6085 */
6086 HyperParameterTuningJobSummaries: HyperParameterTuningJobSummaries;
6087 /**
6088 * 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.
6089 */
6090 NextToken?: NextToken;
6091 }
6092 export interface ListLabelingJobsForWorkteamRequest {
6093 /**
6094 * The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
6095 */
6096 WorkteamArn: WorkteamArn;
6097 /**
6098 * The maximum number of labeling jobs to return in each page of the response.
6099 */
6100 MaxResults?: MaxResults;
6101 /**
6102 * 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.
6103 */
6104 NextToken?: NextToken;
6105 /**
6106 * A filter that returns only labeling jobs created after the specified time (timestamp).
6107 */
6108 CreationTimeAfter?: Timestamp;
6109 /**
6110 * A filter that returns only labeling jobs created before the specified time (timestamp).
6111 */
6112 CreationTimeBefore?: Timestamp;
6113 /**
6114 * A filter the limits jobs to only the ones whose job reference code contains the specified string.
6115 */
6116 JobReferenceCodeContains?: JobReferenceCodeContains;
6117 /**
6118 * The field to sort results by. The default is CreationTime.
6119 */
6120 SortBy?: ListLabelingJobsForWorkteamSortByOptions;
6121 /**
6122 * The sort order for results. The default is Ascending.
6123 */
6124 SortOrder?: SortOrder;
6125 }
6126 export interface ListLabelingJobsForWorkteamResponse {
6127 /**
6128 * An array of LabelingJobSummary objects, each describing a labeling job.
6129 */
6130 LabelingJobSummaryList: LabelingJobForWorkteamSummaryList;
6131 /**
6132 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
6133 */
6134 NextToken?: NextToken;
6135 }
6136 export type ListLabelingJobsForWorkteamSortByOptions = "CreationTime"|string;
6137 export interface ListLabelingJobsRequest {
6138 /**
6139 * A filter that returns only labeling jobs created after the specified time (timestamp).
6140 */
6141 CreationTimeAfter?: Timestamp;
6142 /**
6143 * A filter that returns only labeling jobs created before the specified time (timestamp).
6144 */
6145 CreationTimeBefore?: Timestamp;
6146 /**
6147 * A filter that returns only labeling jobs modified after the specified time (timestamp).
6148 */
6149 LastModifiedTimeAfter?: Timestamp;
6150 /**
6151 * A filter that returns only labeling jobs modified before the specified time (timestamp).
6152 */
6153 LastModifiedTimeBefore?: Timestamp;
6154 /**
6155 * The maximum number of labeling jobs to return in each page of the response.
6156 */
6157 MaxResults?: MaxResults;
6158 /**
6159 * 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.
6160 */
6161 NextToken?: NextToken;
6162 /**
6163 * A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
6164 */
6165 NameContains?: NameContains;
6166 /**
6167 * The field to sort results by. The default is CreationTime.
6168 */
6169 SortBy?: SortBy;
6170 /**
6171 * The sort order for results. The default is Ascending.
6172 */
6173 SortOrder?: SortOrder;
6174 /**
6175 * A filter that retrieves only labeling jobs with a specific status.
6176 */
6177 StatusEquals?: LabelingJobStatus;
6178 }
6179 export interface ListLabelingJobsResponse {
6180 /**
6181 * An array of LabelingJobSummary objects, each describing a labeling job.
6182 */
6183 LabelingJobSummaryList?: LabelingJobSummaryList;
6184 /**
6185 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
6186 */
6187 NextToken?: NextToken;
6188 }
6189 export interface ListModelPackagesInput {
6190 /**
6191 * A filter that returns only model packages created after the specified time (timestamp).
6192 */
6193 CreationTimeAfter?: CreationTime;
6194 /**
6195 * A filter that returns only model packages created before the specified time (timestamp).
6196 */
6197 CreationTimeBefore?: CreationTime;
6198 /**
6199 * The maximum number of model packages to return in the response.
6200 */
6201 MaxResults?: MaxResults;
6202 /**
6203 * A string in the model package name. This filter returns only model packages whose name contains the specified string.
6204 */
6205 NameContains?: NameContains;
6206 /**
6207 * 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.
6208 */
6209 NextToken?: NextToken;
6210 /**
6211 * The parameter by which to sort the results. The default is CreationTime.
6212 */
6213 SortBy?: ModelPackageSortBy;
6214 /**
6215 * The sort order for the results. The default is Ascending.
6216 */
6217 SortOrder?: SortOrder;
6218 }
6219 export interface ListModelPackagesOutput {
6220 /**
6221 * An array of ModelPackageSummary objects, each of which lists a model package.
6222 */
6223 ModelPackageSummaryList: ModelPackageSummaryList;
6224 /**
6225 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
6226 */
6227 NextToken?: NextToken;
6228 }
6229 export interface ListModelsInput {
6230 /**
6231 * Sorts the list of results. The default is CreationTime.
6232 */
6233 SortBy?: ModelSortKey;
6234 /**
6235 * The sort order for results. The default is Descending.
6236 */
6237 SortOrder?: OrderKey;
6238 /**
6239 * 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.
6240 */
6241 NextToken?: PaginationToken;
6242 /**
6243 * The maximum number of models to return in the response.
6244 */
6245 MaxResults?: MaxResults;
6246 /**
6247 * A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
6248 */
6249 NameContains?: ModelNameContains;
6250 /**
6251 * A filter that returns only models created before the specified time (timestamp).
6252 */
6253 CreationTimeBefore?: Timestamp;
6254 /**
6255 * A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
6256 */
6257 CreationTimeAfter?: Timestamp;
6258 }
6259 export interface ListModelsOutput {
6260 /**
6261 * An array of ModelSummary objects, each of which lists a model.
6262 */
6263 Models: ModelSummaryList;
6264 /**
6265 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
6266 */
6267 NextToken?: PaginationToken;
6268 }
6269 export interface ListMonitoringExecutionsRequest {
6270 /**
6271 * Name of a specific schedule to fetch jobs for.
6272 */
6273 MonitoringScheduleName?: MonitoringScheduleName;
6274 /**
6275 * Name of a specific endpoint to fetch jobs for.
6276 */
6277 EndpointName?: EndpointName;
6278 /**
6279 * Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
6280 */
6281 SortBy?: MonitoringExecutionSortKey;
6282 /**
6283 * Whether to sort the results in Ascending or Descending order. The default is Descending.
6284 */
6285 SortOrder?: SortOrder;
6286 /**
6287 * The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
6288 */
6289 NextToken?: NextToken;
6290 /**
6291 * The maximum number of jobs to return in the response. The default value is 10.
6292 */
6293 MaxResults?: MaxResults;
6294 /**
6295 * Filter for jobs scheduled before a specified time.
6296 */
6297 ScheduledTimeBefore?: Timestamp;
6298 /**
6299 * Filter for jobs scheduled after a specified time.
6300 */
6301 ScheduledTimeAfter?: Timestamp;
6302 /**
6303 * A filter that returns only jobs created before a specified time.
6304 */
6305 CreationTimeBefore?: Timestamp;
6306 /**
6307 * A filter that returns only jobs created after a specified time.
6308 */
6309 CreationTimeAfter?: Timestamp;
6310 /**
6311 * A filter that returns only jobs modified after a specified time.
6312 */
6313 LastModifiedTimeBefore?: Timestamp;
6314 /**
6315 * A filter that returns only jobs modified before a specified time.
6316 */
6317 LastModifiedTimeAfter?: Timestamp;
6318 /**
6319 * A filter that retrieves only jobs with a specific status.
6320 */
6321 StatusEquals?: ExecutionStatus;
6322 }
6323 export interface ListMonitoringExecutionsResponse {
6324 /**
6325 * A JSON array in which each element is a summary for a monitoring execution.
6326 */
6327 MonitoringExecutionSummaries: MonitoringExecutionSummaryList;
6328 /**
6329 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
6330 */
6331 NextToken?: NextToken;
6332 }
6333 export interface ListMonitoringSchedulesRequest {
6334 /**
6335 * Name of a specific endpoint to fetch schedules for.
6336 */
6337 EndpointName?: EndpointName;
6338 /**
6339 * Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
6340 */
6341 SortBy?: MonitoringScheduleSortKey;
6342 /**
6343 * Whether to sort the results in Ascending or Descending order. The default is Descending.
6344 */
6345 SortOrder?: SortOrder;
6346 /**
6347 * The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
6348 */
6349 NextToken?: NextToken;
6350 /**
6351 * The maximum number of jobs to return in the response. The default value is 10.
6352 */
6353 MaxResults?: MaxResults;
6354 /**
6355 * Filter for monitoring schedules whose name contains a specified string.
6356 */
6357 NameContains?: NameContains;
6358 /**
6359 * A filter that returns only monitoring schedules created before a specified time.
6360 */
6361 CreationTimeBefore?: Timestamp;
6362 /**
6363 * A filter that returns only monitoring schedules created after a specified time.
6364 */
6365 CreationTimeAfter?: Timestamp;
6366 /**
6367 * A filter that returns only monitoring schedules modified before a specified time.
6368 */
6369 LastModifiedTimeBefore?: Timestamp;
6370 /**
6371 * A filter that returns only monitoring schedules modified after a specified time.
6372 */
6373 LastModifiedTimeAfter?: Timestamp;
6374 /**
6375 * A filter that returns only monitoring schedules modified before a specified time.
6376 */
6377 StatusEquals?: ScheduleStatus;
6378 }
6379 export interface ListMonitoringSchedulesResponse {
6380 /**
6381 * A JSON array in which each element is a summary for a monitoring schedule.
6382 */
6383 MonitoringScheduleSummaries: MonitoringScheduleSummaryList;
6384 /**
6385 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
6386 */
6387 NextToken?: NextToken;
6388 }
6389 export interface ListNotebookInstanceLifecycleConfigsInput {
6390 /**
6391 * 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.
6392 */
6393 NextToken?: NextToken;
6394 /**
6395 * The maximum number of lifecycle configurations to return in the response.
6396 */
6397 MaxResults?: MaxResults;
6398 /**
6399 * Sorts the list of results. The default is CreationTime.
6400 */
6401 SortBy?: NotebookInstanceLifecycleConfigSortKey;
6402 /**
6403 * The sort order for results.
6404 */
6405 SortOrder?: NotebookInstanceLifecycleConfigSortOrder;
6406 /**
6407 * A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
6408 */
6409 NameContains?: NotebookInstanceLifecycleConfigNameContains;
6410 /**
6411 * A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
6412 */
6413 CreationTimeBefore?: CreationTime;
6414 /**
6415 * A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
6416 */
6417 CreationTimeAfter?: CreationTime;
6418 /**
6419 * A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
6420 */
6421 LastModifiedTimeBefore?: LastModifiedTime;
6422 /**
6423 * A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
6424 */
6425 LastModifiedTimeAfter?: LastModifiedTime;
6426 }
6427 export interface ListNotebookInstanceLifecycleConfigsOutput {
6428 /**
6429 * If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
6430 */
6431 NextToken?: NextToken;
6432 /**
6433 * An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
6434 */
6435 NotebookInstanceLifecycleConfigs?: NotebookInstanceLifecycleConfigSummaryList;
6436 }
6437 export interface ListNotebookInstancesInput {
6438 /**
6439 * 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.
6440 */
6441 NextToken?: NextToken;
6442 /**
6443 * The maximum number of notebook instances to return.
6444 */
6445 MaxResults?: MaxResults;
6446 /**
6447 * The field to sort results by. The default is Name.
6448 */
6449 SortBy?: NotebookInstanceSortKey;
6450 /**
6451 * The sort order for results.
6452 */
6453 SortOrder?: NotebookInstanceSortOrder;
6454 /**
6455 * A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
6456 */
6457 NameContains?: NotebookInstanceNameContains;
6458 /**
6459 * A filter that returns only notebook instances that were created before the specified time (timestamp).
6460 */
6461 CreationTimeBefore?: CreationTime;
6462 /**
6463 * A filter that returns only notebook instances that were created after the specified time (timestamp).
6464 */
6465 CreationTimeAfter?: CreationTime;
6466 /**
6467 * A filter that returns only notebook instances that were modified before the specified time (timestamp).
6468 */
6469 LastModifiedTimeBefore?: LastModifiedTime;
6470 /**
6471 * A filter that returns only notebook instances that were modified after the specified time (timestamp).
6472 */
6473 LastModifiedTimeAfter?: LastModifiedTime;
6474 /**
6475 * A filter that returns only notebook instances with the specified status.
6476 */
6477 StatusEquals?: NotebookInstanceStatus;
6478 /**
6479 * 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.
6480 */
6481 NotebookInstanceLifecycleConfigNameContains?: NotebookInstanceLifecycleConfigName;
6482 /**
6483 * 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.
6484 */
6485 DefaultCodeRepositoryContains?: CodeRepositoryContains;
6486 /**
6487 * A filter that returns only notebook instances with associated with the specified git repository.
6488 */
6489 AdditionalCodeRepositoryEquals?: CodeRepositoryNameOrUrl;
6490 }
6491 export interface ListNotebookInstancesOutput {
6492 /**
6493 * 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.
6494 */
6495 NextToken?: NextToken;
6496 /**
6497 * An array of NotebookInstanceSummary objects, one for each notebook instance.
6498 */
6499 NotebookInstances?: NotebookInstanceSummaryList;
6500 }
6501 export interface ListProcessingJobsRequest {
6502 /**
6503 * A filter that returns only processing jobs created after the specified time.
6504 */
6505 CreationTimeAfter?: Timestamp;
6506 /**
6507 * A filter that returns only processing jobs created after the specified time.
6508 */
6509 CreationTimeBefore?: Timestamp;
6510 /**
6511 * A filter that returns only processing jobs modified after the specified time.
6512 */
6513 LastModifiedTimeAfter?: Timestamp;
6514 /**
6515 * A filter that returns only processing jobs modified before the specified time.
6516 */
6517 LastModifiedTimeBefore?: Timestamp;
6518 /**
6519 * A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
6520 */
6521 NameContains?: String;
6522 /**
6523 * A filter that retrieves only processing jobs with a specific status.
6524 */
6525 StatusEquals?: ProcessingJobStatus;
6526 /**
6527 * The field to sort results by. The default is CreationTime.
6528 */
6529 SortBy?: SortBy;
6530 /**
6531 * The sort order for results. The default is Ascending.
6532 */
6533 SortOrder?: SortOrder;
6534 /**
6535 * If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.
6536 */
6537 NextToken?: NextToken;
6538 /**
6539 * The maximum number of processing jobs to return in the response.
6540 */
6541 MaxResults?: MaxResults;
6542 }
6543 export interface ListProcessingJobsResponse {
6544 /**
6545 * An array of ProcessingJobSummary objects, each listing a processing job.
6546 */
6547 ProcessingJobSummaries: ProcessingJobSummaries;
6548 /**
6549 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
6550 */
6551 NextToken?: NextToken;
6552 }
6553 export interface ListSubscribedWorkteamsRequest {
6554 /**
6555 * A string in the work team name. This filter returns only work teams whose name contains the specified string.
6556 */
6557 NameContains?: WorkteamName;
6558 /**
6559 * 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.
6560 */
6561 NextToken?: NextToken;
6562 /**
6563 * The maximum number of work teams to return in each page of the response.
6564 */
6565 MaxResults?: MaxResults;
6566 }
6567 export interface ListSubscribedWorkteamsResponse {
6568 /**
6569 * An array of Workteam objects, each describing a work team.
6570 */
6571 SubscribedWorkteams: SubscribedWorkteams;
6572 /**
6573 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
6574 */
6575 NextToken?: NextToken;
6576 }
6577 export interface ListTagsInput {
6578 /**
6579 * The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
6580 */
6581 ResourceArn: ResourceArn;
6582 /**
6583 * 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.
6584 */
6585 NextToken?: NextToken;
6586 /**
6587 * Maximum number of tags to return.
6588 */
6589 MaxResults?: ListTagsMaxResults;
6590 }
6591 export type ListTagsMaxResults = number;
6592 export interface ListTagsOutput {
6593 /**
6594 * An array of Tag objects, each with a tag key and a value.
6595 */
6596 Tags?: TagList;
6597 /**
6598 * 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.
6599 */
6600 NextToken?: NextToken;
6601 }
6602 export interface ListTrainingJobsForHyperParameterTuningJobRequest {
6603 /**
6604 * The name of the tuning job whose training jobs you want to list.
6605 */
6606 HyperParameterTuningJobName: HyperParameterTuningJobName;
6607 /**
6608 * 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.
6609 */
6610 NextToken?: NextToken;
6611 /**
6612 * The maximum number of training jobs to return. The default value is 10.
6613 */
6614 MaxResults?: MaxResults;
6615 /**
6616 * A filter that returns only training jobs with the specified status.
6617 */
6618 StatusEquals?: TrainingJobStatus;
6619 /**
6620 * 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.
6621 */
6622 SortBy?: TrainingJobSortByOptions;
6623 /**
6624 * The sort order for results. The default is Ascending.
6625 */
6626 SortOrder?: SortOrder;
6627 }
6628 export interface ListTrainingJobsForHyperParameterTuningJobResponse {
6629 /**
6630 * A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
6631 */
6632 TrainingJobSummaries: HyperParameterTrainingJobSummaries;
6633 /**
6634 * 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.
6635 */
6636 NextToken?: NextToken;
6637 }
6638 export interface ListTrainingJobsRequest {
6639 /**
6640 * 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.
6641 */
6642 NextToken?: NextToken;
6643 /**
6644 * The maximum number of training jobs to return in the response.
6645 */
6646 MaxResults?: MaxResults;
6647 /**
6648 * A filter that returns only training jobs created after the specified time (timestamp).
6649 */
6650 CreationTimeAfter?: Timestamp;
6651 /**
6652 * A filter that returns only training jobs created before the specified time (timestamp).
6653 */
6654 CreationTimeBefore?: Timestamp;
6655 /**
6656 * A filter that returns only training jobs modified after the specified time (timestamp).
6657 */
6658 LastModifiedTimeAfter?: Timestamp;
6659 /**
6660 * A filter that returns only training jobs modified before the specified time (timestamp).
6661 */
6662 LastModifiedTimeBefore?: Timestamp;
6663 /**
6664 * A string in the training job name. This filter returns only training jobs whose name contains the specified string.
6665 */
6666 NameContains?: NameContains;
6667 /**
6668 * A filter that retrieves only training jobs with a specific status.
6669 */
6670 StatusEquals?: TrainingJobStatus;
6671 /**
6672 * The field to sort results by. The default is CreationTime.
6673 */
6674 SortBy?: SortBy;
6675 /**
6676 * The sort order for results. The default is Ascending.
6677 */
6678 SortOrder?: SortOrder;
6679 }
6680 export interface ListTrainingJobsResponse {
6681 /**
6682 * An array of TrainingJobSummary objects, each listing a training job.
6683 */
6684 TrainingJobSummaries: TrainingJobSummaries;
6685 /**
6686 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
6687 */
6688 NextToken?: NextToken;
6689 }
6690 export interface ListTransformJobsRequest {
6691 /**
6692 * A filter that returns only transform jobs created after the specified time.
6693 */
6694 CreationTimeAfter?: Timestamp;
6695 /**
6696 * A filter that returns only transform jobs created before the specified time.
6697 */
6698 CreationTimeBefore?: Timestamp;
6699 /**
6700 * A filter that returns only transform jobs modified after the specified time.
6701 */
6702 LastModifiedTimeAfter?: Timestamp;
6703 /**
6704 * A filter that returns only transform jobs modified before the specified time.
6705 */
6706 LastModifiedTimeBefore?: Timestamp;
6707 /**
6708 * A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
6709 */
6710 NameContains?: NameContains;
6711 /**
6712 * A filter that retrieves only transform jobs with a specific status.
6713 */
6714 StatusEquals?: TransformJobStatus;
6715 /**
6716 * The field to sort results by. The default is CreationTime.
6717 */
6718 SortBy?: SortBy;
6719 /**
6720 * The sort order for results. The default is Descending.
6721 */
6722 SortOrder?: SortOrder;
6723 /**
6724 * 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.
6725 */
6726 NextToken?: NextToken;
6727 /**
6728 * The maximum number of transform jobs to return in the response. The default value is 10.
6729 */
6730 MaxResults?: MaxResults;
6731 }
6732 export interface ListTransformJobsResponse {
6733 /**
6734 * An array of TransformJobSummary objects.
6735 */
6736 TransformJobSummaries: TransformJobSummaries;
6737 /**
6738 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
6739 */
6740 NextToken?: NextToken;
6741 }
6742 export type ListTrialComponentKey256 = TrialComponentKey256[];
6743 export interface ListTrialComponentsRequest {
6744 /**
6745 * A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.
6746 */
6747 ExperimentName?: ExperimentEntityName;
6748 /**
6749 * A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.
6750 */
6751 TrialName?: ExperimentEntityName;
6752 /**
6753 * A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.
6754 */
6755 SourceArn?: String256;
6756 /**
6757 * A filter that returns only components created after the specified time.
6758 */
6759 CreatedAfter?: Timestamp;
6760 /**
6761 * A filter that returns only components created before the specified time.
6762 */
6763 CreatedBefore?: Timestamp;
6764 /**
6765 * The property used to sort results. The default value is CreationTime.
6766 */
6767 SortBy?: SortTrialComponentsBy;
6768 /**
6769 * The sort order. The default value is Descending.
6770 */
6771 SortOrder?: SortOrder;
6772 /**
6773 * The maximum number of components to return in the response. The default value is 10.
6774 */
6775 MaxResults?: MaxResults;
6776 /**
6777 * If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.
6778 */
6779 NextToken?: NextToken;
6780 }
6781 export interface ListTrialComponentsResponse {
6782 /**
6783 * A list of the summaries of your trial components.
6784 */
6785 TrialComponentSummaries?: TrialComponentSummaries;
6786 /**
6787 * A token for getting the next set of components, if there are any.
6788 */
6789 NextToken?: NextToken;
6790 }
6791 export interface ListTrialsRequest {
6792 /**
6793 * A filter that returns only trials that are part of the specified experiment.
6794 */
6795 ExperimentName?: ExperimentEntityName;
6796 /**
6797 * A filter that returns only trials that are associated with the specified trial component.
6798 */
6799 TrialComponentName?: ExperimentEntityName;
6800 /**
6801 * A filter that returns only trials created after the specified time.
6802 */
6803 CreatedAfter?: Timestamp;
6804 /**
6805 * A filter that returns only trials created before the specified time.
6806 */
6807 CreatedBefore?: Timestamp;
6808 /**
6809 * The property used to sort results. The default value is CreationTime.
6810 */
6811 SortBy?: SortTrialsBy;
6812 /**
6813 * The sort order. The default value is Descending.
6814 */
6815 SortOrder?: SortOrder;
6816 /**
6817 * The maximum number of trials to return in the response. The default value is 10.
6818 */
6819 MaxResults?: MaxResults;
6820 /**
6821 * If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.
6822 */
6823 NextToken?: NextToken;
6824 }
6825 export interface ListTrialsResponse {
6826 /**
6827 * A list of the summaries of your trials.
6828 */
6829 TrialSummaries?: TrialSummaries;
6830 /**
6831 * A token for getting the next set of trials, if there are any.
6832 */
6833 NextToken?: NextToken;
6834 }
6835 export interface ListUserProfilesRequest {
6836 /**
6837 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
6838 */
6839 NextToken?: NextToken;
6840 /**
6841 * Returns a list up to a specified limit.
6842 */
6843 MaxResults?: MaxResults;
6844 /**
6845 * The sort order for the results. The default is Ascending.
6846 */
6847 SortOrder?: SortOrder;
6848 /**
6849 * The parameter by which to sort the results. The default is CreationTime.
6850 */
6851 SortBy?: UserProfileSortKey;
6852 /**
6853 * A parameter by which to filter the results.
6854 */
6855 DomainIdEquals?: DomainId;
6856 /**
6857 * A parameter by which to filter the results.
6858 */
6859 UserProfileNameContains?: UserProfileName;
6860 }
6861 export interface ListUserProfilesResponse {
6862 /**
6863 * The list of user profiles.
6864 */
6865 UserProfiles?: UserProfileList;
6866 /**
6867 * If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
6868 */
6869 NextToken?: NextToken;
6870 }
6871 export interface ListWorkteamsRequest {
6872 /**
6873 * The field to sort results by. The default is CreationTime.
6874 */
6875 SortBy?: ListWorkteamsSortByOptions;
6876 /**
6877 * The sort order for results. The default is Ascending.
6878 */
6879 SortOrder?: SortOrder;
6880 /**
6881 * A string in the work team's name. This filter returns only work teams whose name contains the specified string.
6882 */
6883 NameContains?: WorkteamName;
6884 /**
6885 * 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.
6886 */
6887 NextToken?: NextToken;
6888 /**
6889 * The maximum number of work teams to return in each page of the response.
6890 */
6891 MaxResults?: MaxResults;
6892 }
6893 export interface ListWorkteamsResponse {
6894 /**
6895 * An array of Workteam objects, each describing a work team.
6896 */
6897 Workteams: Workteams;
6898 /**
6899 * If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
6900 */
6901 NextToken?: NextToken;
6902 }
6903 export type ListWorkteamsSortByOptions = "Name"|"CreateDate"|string;
6904 export type MaxAutoMLJobRuntimeInSeconds = number;
6905 export type MaxCandidates = number;
6906 export type MaxConcurrentTaskCount = number;
6907 export type MaxConcurrentTransforms = number;
6908 export type MaxHumanLabeledObjectCount = number;
6909 export type MaxNumberOfTrainingJobs = number;
6910 export type MaxParallelTrainingJobs = number;
6911 export type MaxPayloadInMB = number;
6912 export type MaxPercentageOfInputDatasetLabeled = number;
6913 export type MaxResults = number;
6914 export type MaxRuntimeInSeconds = number;
6915 export type MaxRuntimePerTrainingJobInSeconds = number;
6916 export type MaxWaitTimeInSeconds = number;
6917 export type MediaType = string;
6918 export interface MemberDefinition {
6919 /**
6920 * The Amazon Cognito user group that is part of the work team.
6921 */
6922 CognitoMemberDefinition?: CognitoMemberDefinition;
6923 }
6924 export type MemberDefinitions = MemberDefinition[];
6925 export interface MetricData {
6926 /**
6927 * The name of the metric.
6928 */
6929 MetricName?: MetricName;
6930 /**
6931 * The value of the metric.
6932 */
6933 Value?: Float;
6934 /**
6935 * The date and time that the algorithm emitted the metric.
6936 */
6937 Timestamp?: Timestamp;
6938 }
6939 export interface MetricDefinition {
6940 /**
6941 * The name of the metric.
6942 */
6943 Name: MetricName;
6944 /**
6945 * 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.
6946 */
6947 Regex: MetricRegex;
6948 }
6949 export type MetricDefinitionList = MetricDefinition[];
6950 export type MetricName = string;
6951 export type MetricRegex = string;
6952 export type MetricValue = number;
6953 export type ModelArn = string;
6954 export interface ModelArtifacts {
6955 /**
6956 * The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
6957 */
6958 S3ModelArtifacts: S3Uri;
6959 }
6960 export type ModelName = string;
6961 export type ModelNameContains = string;
6962 export type ModelPackageArn = string;
6963 export interface ModelPackageContainerDefinition {
6964 /**
6965 * The DNS host name for the Docker container.
6966 */
6967 ContainerHostname?: ContainerHostname;
6968 /**
6969 * 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.
6970 */
6971 Image: Image;
6972 /**
6973 * An MD5 hash of the training algorithm that identifies the Docker image used for training.
6974 */
6975 ImageDigest?: ImageDigest;
6976 /**
6977 * 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).
6978 */
6979 ModelDataUrl?: Url;
6980 /**
6981 * The AWS Marketplace product ID of the model package.
6982 */
6983 ProductId?: ProductId;
6984 }
6985 export type ModelPackageContainerDefinitionList = ModelPackageContainerDefinition[];
6986 export type ModelPackageSortBy = "Name"|"CreationTime"|string;
6987 export type ModelPackageStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting"|string;
6988 export interface ModelPackageStatusDetails {
6989 /**
6990 * The validation status of the model package.
6991 */
6992 ValidationStatuses: ModelPackageStatusItemList;
6993 /**
6994 * The status of the scan of the Docker image container for the model package.
6995 */
6996 ImageScanStatuses?: ModelPackageStatusItemList;
6997 }
6998 export interface ModelPackageStatusItem {
6999 /**
7000 * The name of the model package for which the overall status is being reported.
7001 */
7002 Name: EntityName;
7003 /**
7004 * The current status.
7005 */
7006 Status: DetailedModelPackageStatus;
7007 /**
7008 * if the overall status is Failed, the reason for the failure.
7009 */
7010 FailureReason?: String;
7011 }
7012 export type ModelPackageStatusItemList = ModelPackageStatusItem[];
7013 export interface ModelPackageSummary {
7014 /**
7015 * The name of the model package.
7016 */
7017 ModelPackageName: EntityName;
7018 /**
7019 * The Amazon Resource Name (ARN) of the model package.
7020 */
7021 ModelPackageArn: ModelPackageArn;
7022 /**
7023 * A brief description of the model package.
7024 */
7025 ModelPackageDescription?: EntityDescription;
7026 /**
7027 * A timestamp that shows when the model package was created.
7028 */
7029 CreationTime: CreationTime;
7030 /**
7031 * The overall status of the model package.
7032 */
7033 ModelPackageStatus: ModelPackageStatus;
7034 }
7035 export type ModelPackageSummaryList = ModelPackageSummary[];
7036 export interface ModelPackageValidationProfile {
7037 /**
7038 * The name of the profile for the model package.
7039 */
7040 ProfileName: EntityName;
7041 /**
7042 * The TransformJobDefinition object that describes the transform job used for the validation of the model package.
7043 */
7044 TransformJobDefinition: TransformJobDefinition;
7045 }
7046 export type ModelPackageValidationProfiles = ModelPackageValidationProfile[];
7047 export interface ModelPackageValidationSpecification {
7048 /**
7049 * The IAM roles to be used for the validation of the model package.
7050 */
7051 ValidationRole: RoleArn;
7052 /**
7053 * An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.
7054 */
7055 ValidationProfiles: ModelPackageValidationProfiles;
7056 }
7057 export type ModelSortKey = "Name"|"CreationTime"|string;
7058 export interface ModelSummary {
7059 /**
7060 * The name of the model that you want a summary for.
7061 */
7062 ModelName: ModelName;
7063 /**
7064 * The Amazon Resource Name (ARN) of the model.
7065 */
7066 ModelArn: ModelArn;
7067 /**
7068 * A timestamp that indicates when the model was created.
7069 */
7070 CreationTime: Timestamp;
7071 }
7072 export type ModelSummaryList = ModelSummary[];
7073 export interface MonitoringAppSpecification {
7074 /**
7075 * The container image to be run by the monitoring job.
7076 */
7077 ImageUri: ImageUri;
7078 /**
7079 * Specifies the entrypoint for a container used to run the monitoring job.
7080 */
7081 ContainerEntrypoint?: ContainerEntrypoint;
7082 /**
7083 * An array of arguments for the container used to run the monitoring job.
7084 */
7085 ContainerArguments?: MonitoringContainerArguments;
7086 /**
7087 * An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
7088 */
7089 RecordPreprocessorSourceUri?: S3Uri;
7090 /**
7091 * An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
7092 */
7093 PostAnalyticsProcessorSourceUri?: S3Uri;
7094 }
7095 export interface MonitoringBaselineConfig {
7096 /**
7097 * The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
7098 */
7099 ConstraintsResource?: MonitoringConstraintsResource;
7100 /**
7101 * The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
7102 */
7103 StatisticsResource?: MonitoringStatisticsResource;
7104 }
7105 export interface MonitoringClusterConfig {
7106 /**
7107 * The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
7108 */
7109 InstanceCount: ProcessingInstanceCount;
7110 /**
7111 * The ML compute instance type for the processing job.
7112 */
7113 InstanceType: ProcessingInstanceType;
7114 /**
7115 * The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
7116 */
7117 VolumeSizeInGB: ProcessingVolumeSizeInGB;
7118 /**
7119 * 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 model monitoring job.
7120 */
7121 VolumeKmsKeyId?: KmsKeyId;
7122 }
7123 export interface MonitoringConstraintsResource {
7124 /**
7125 * The Amazon S3 URI for the constraints resource.
7126 */
7127 S3Uri?: S3Uri;
7128 }
7129 export type MonitoringContainerArguments = ContainerArgument[];
7130 export type MonitoringEnvironmentMap = {[key: string]: ProcessingEnvironmentValue};
7131 export type MonitoringExecutionSortKey = "CreationTime"|"ScheduledTime"|"Status"|string;
7132 export interface MonitoringExecutionSummary {
7133 /**
7134 * The name of the monitoring schedule.
7135 */
7136 MonitoringScheduleName: MonitoringScheduleName;
7137 /**
7138 * The time the monitoring job was scheduled.
7139 */
7140 ScheduledTime: Timestamp;
7141 /**
7142 * The time at which the monitoring job was created.
7143 */
7144 CreationTime: Timestamp;
7145 /**
7146 * A timestamp that indicates the last time the monitoring job was modified.
7147 */
7148 LastModifiedTime: Timestamp;
7149 /**
7150 * The status of the monitoring job.
7151 */
7152 MonitoringExecutionStatus: ExecutionStatus;
7153 /**
7154 * The Amazon Resource Name (ARN) of the monitoring job.
7155 */
7156 ProcessingJobArn?: ProcessingJobArn;
7157 /**
7158 * The name of teh endpoint used to run the monitoring job.
7159 */
7160 EndpointName?: EndpointName;
7161 /**
7162 * Contains the reason a monitoring job failed, if it failed.
7163 */
7164 FailureReason?: FailureReason;
7165 }
7166 export type MonitoringExecutionSummaryList = MonitoringExecutionSummary[];
7167 export interface MonitoringInput {
7168 /**
7169 * The endpoint for a monitoring job.
7170 */
7171 EndpointInput: EndpointInput;
7172 }
7173 export type MonitoringInputs = MonitoringInput[];
7174 export interface MonitoringJobDefinition {
7175 /**
7176 * Baseline configuration used to validate that the data conforms to the specified constraints and statistics
7177 */
7178 BaselineConfig?: MonitoringBaselineConfig;
7179 /**
7180 * The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
7181 */
7182 MonitoringInputs: MonitoringInputs;
7183 /**
7184 * The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
7185 */
7186 MonitoringOutputConfig: MonitoringOutputConfig;
7187 /**
7188 * Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
7189 */
7190 MonitoringResources: MonitoringResources;
7191 /**
7192 * Configures the monitoring job to run a specified Docker container image.
7193 */
7194 MonitoringAppSpecification: MonitoringAppSpecification;
7195 /**
7196 * Specifies a time limit for how long the monitoring job is allowed to run.
7197 */
7198 StoppingCondition?: MonitoringStoppingCondition;
7199 /**
7200 * Sets the environment variables in the Docker container.
7201 */
7202 Environment?: MonitoringEnvironmentMap;
7203 /**
7204 * Specifies networking options for an monitoring job.
7205 */
7206 NetworkConfig?: NetworkConfig;
7207 /**
7208 * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
7209 */
7210 RoleArn: RoleArn;
7211 }
7212 export type MonitoringMaxRuntimeInSeconds = number;
7213 export interface MonitoringOutput {
7214 /**
7215 * The Amazon S3 storage location where the results of a monitoring job are saved.
7216 */
7217 S3Output: MonitoringS3Output;
7218 }
7219 export interface MonitoringOutputConfig {
7220 /**
7221 * Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
7222 */
7223 MonitoringOutputs: MonitoringOutputs;
7224 /**
7225 * 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.
7226 */
7227 KmsKeyId?: KmsKeyId;
7228 }
7229 export type MonitoringOutputs = MonitoringOutput[];
7230 export interface MonitoringResources {
7231 /**
7232 * The configuration for the cluster resources used to run the processing job.
7233 */
7234 ClusterConfig: MonitoringClusterConfig;
7235 }
7236 export interface MonitoringS3Output {
7237 /**
7238 * A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
7239 */
7240 S3Uri: MonitoringS3Uri;
7241 /**
7242 * The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.
7243 */
7244 LocalPath: ProcessingLocalPath;
7245 /**
7246 * Whether to upload the results of the monitoring job continuously or after the job completes.
7247 */
7248 S3UploadMode?: ProcessingS3UploadMode;
7249 }
7250 export type MonitoringS3Uri = string;
7251 export type MonitoringScheduleArn = string;
7252 export interface MonitoringScheduleConfig {
7253 /**
7254 * Configures the monitoring schedule.
7255 */
7256 ScheduleConfig?: ScheduleConfig;
7257 /**
7258 * Defines the monitoring job.
7259 */
7260 MonitoringJobDefinition: MonitoringJobDefinition;
7261 }
7262 export type MonitoringScheduleName = string;
7263 export type MonitoringScheduleSortKey = "Name"|"CreationTime"|"Status"|string;
7264 export interface MonitoringScheduleSummary {
7265 /**
7266 * The name of the monitoring schedule.
7267 */
7268 MonitoringScheduleName: MonitoringScheduleName;
7269 /**
7270 * The Amazon Resource Name (ARN) of the monitoring schedule.
7271 */
7272 MonitoringScheduleArn: MonitoringScheduleArn;
7273 /**
7274 * The creation time of the monitoring schedule.
7275 */
7276 CreationTime: Timestamp;
7277 /**
7278 * The last time the monitoring schedule was modified.
7279 */
7280 LastModifiedTime: Timestamp;
7281 /**
7282 * The status of the monitoring schedule.
7283 */
7284 MonitoringScheduleStatus: ScheduleStatus;
7285 /**
7286 * The name of the endpoint using the monitoring schedule.
7287 */
7288 EndpointName?: EndpointName;
7289 }
7290 export type MonitoringScheduleSummaryList = MonitoringScheduleSummary[];
7291 export interface MonitoringStatisticsResource {
7292 /**
7293 * The Amazon S3 URI for the statistics resource.
7294 */
7295 S3Uri?: S3Uri;
7296 }
7297 export interface MonitoringStoppingCondition {
7298 /**
7299 * The maximum runtime allowed in seconds.
7300 */
7301 MaxRuntimeInSeconds: MonitoringMaxRuntimeInSeconds;
7302 }
7303 export type NameContains = string;
7304 export interface NestedFilters {
7305 /**
7306 * The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
7307 */
7308 NestedPropertyName: ResourcePropertyName;
7309 /**
7310 * 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.
7311 */
7312 Filters: FilterList;
7313 }
7314 export type NestedFiltersList = NestedFilters[];
7315 export interface NetworkConfig {
7316 /**
7317 * Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
7318 */
7319 EnableNetworkIsolation?: Boolean;
7320 VpcConfig?: VpcConfig;
7321 }
7322 export type NetworkInterfaceId = string;
7323 export type NextToken = string;
7324 export type NotebookInstanceAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|"ml.eia2.medium"|"ml.eia2.large"|"ml.eia2.xlarge"|string;
7325 export type NotebookInstanceAcceleratorTypes = NotebookInstanceAcceleratorType[];
7326 export type NotebookInstanceArn = string;
7327 export type NotebookInstanceLifecycleConfigArn = string;
7328 export type NotebookInstanceLifecycleConfigContent = string;
7329 export type NotebookInstanceLifecycleConfigList = NotebookInstanceLifecycleHook[];
7330 export type NotebookInstanceLifecycleConfigName = string;
7331 export type NotebookInstanceLifecycleConfigNameContains = string;
7332 export type NotebookInstanceLifecycleConfigSortKey = "Name"|"CreationTime"|"LastModifiedTime"|string;
7333 export type NotebookInstanceLifecycleConfigSortOrder = "Ascending"|"Descending"|string;
7334 export interface NotebookInstanceLifecycleConfigSummary {
7335 /**
7336 * The name of the lifecycle configuration.
7337 */
7338 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
7339 /**
7340 * The Amazon Resource Name (ARN) of the lifecycle configuration.
7341 */
7342 NotebookInstanceLifecycleConfigArn: NotebookInstanceLifecycleConfigArn;
7343 /**
7344 * A timestamp that tells when the lifecycle configuration was created.
7345 */
7346 CreationTime?: CreationTime;
7347 /**
7348 * A timestamp that tells when the lifecycle configuration was last modified.
7349 */
7350 LastModifiedTime?: LastModifiedTime;
7351 }
7352 export type NotebookInstanceLifecycleConfigSummaryList = NotebookInstanceLifecycleConfigSummary[];
7353 export interface NotebookInstanceLifecycleHook {
7354 /**
7355 * A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
7356 */
7357 Content?: NotebookInstanceLifecycleConfigContent;
7358 }
7359 export type NotebookInstanceName = string;
7360 export type NotebookInstanceNameContains = string;
7361 export type NotebookInstanceSortKey = "Name"|"CreationTime"|"Status"|string;
7362 export type NotebookInstanceSortOrder = "Ascending"|"Descending"|string;
7363 export type NotebookInstanceStatus = "Pending"|"InService"|"Stopping"|"Stopped"|"Failed"|"Deleting"|"Updating"|string;
7364 export interface NotebookInstanceSummary {
7365 /**
7366 * The name of the notebook instance that you want a summary for.
7367 */
7368 NotebookInstanceName: NotebookInstanceName;
7369 /**
7370 * The Amazon Resource Name (ARN) of the notebook instance.
7371 */
7372 NotebookInstanceArn: NotebookInstanceArn;
7373 /**
7374 * The status of the notebook instance.
7375 */
7376 NotebookInstanceStatus?: NotebookInstanceStatus;
7377 /**
7378 * The URL that you use to connect to the Jupyter instance running in your notebook instance.
7379 */
7380 Url?: NotebookInstanceUrl;
7381 /**
7382 * The type of ML compute instance that the notebook instance is running on.
7383 */
7384 InstanceType?: InstanceType;
7385 /**
7386 * A timestamp that shows when the notebook instance was created.
7387 */
7388 CreationTime?: CreationTime;
7389 /**
7390 * A timestamp that shows when the notebook instance was last modified.
7391 */
7392 LastModifiedTime?: LastModifiedTime;
7393 /**
7394 * 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.
7395 */
7396 NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
7397 /**
7398 * 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.
7399 */
7400 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
7401 /**
7402 * 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.
7403 */
7404 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
7405 }
7406 export type NotebookInstanceSummaryList = NotebookInstanceSummary[];
7407 export type NotebookInstanceUrl = string;
7408 export type NotebookInstanceVolumeSizeInGB = number;
7409 export type NotebookOutputOption = "Allowed"|"Disabled"|string;
7410 export interface NotificationConfiguration {
7411 /**
7412 * The ARN for the SNS topic to which notifications should be published.
7413 */
7414 NotificationTopicArn?: NotificationTopicArn;
7415 }
7416 export type NotificationTopicArn = string;
7417 export type NumberOfHumanWorkersPerDataObject = number;
7418 export type ObjectiveStatus = "Succeeded"|"Pending"|"Failed"|string;
7419 export type ObjectiveStatusCounter = number;
7420 export interface ObjectiveStatusCounters {
7421 /**
7422 * The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
7423 */
7424 Succeeded?: ObjectiveStatusCounter;
7425 /**
7426 * The number of training jobs that are in progress and pending evaluation of their final objective metric.
7427 */
7428 Pending?: ObjectiveStatusCounter;
7429 /**
7430 * 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.
7431 */
7432 Failed?: ObjectiveStatusCounter;
7433 }
7434 export type Operator = "Equals"|"NotEquals"|"GreaterThan"|"GreaterThanOrEqualTo"|"LessThan"|"LessThanOrEqualTo"|"Contains"|"Exists"|"NotExists"|"In"|string;
7435 export type OptionalDouble = number;
7436 export type OptionalInteger = number;
7437 export type OptionalVolumeSizeInGB = number;
7438 export type OrderKey = "Ascending"|"Descending"|string;
7439 export interface OutputConfig {
7440 /**
7441 * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
7442 */
7443 S3OutputLocation: S3Uri;
7444 /**
7445 * Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.
7446 */
7447 TargetDevice: TargetDevice;
7448 }
7449 export interface OutputDataConfig {
7450 /**
7451 * 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.
7452 */
7453 KmsKeyId?: KmsKeyId;
7454 /**
7455 * Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
7456 */
7457 S3OutputPath: S3Uri;
7458 }
7459 export type PaginationToken = string;
7460 export type ParameterKey = string;
7461 export type ParameterName = string;
7462 export interface ParameterRange {
7463 /**
7464 * A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
7465 */
7466 IntegerParameterRangeSpecification?: IntegerParameterRangeSpecification;
7467 /**
7468 * A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
7469 */
7470 ContinuousParameterRangeSpecification?: ContinuousParameterRangeSpecification;
7471 /**
7472 * A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
7473 */
7474 CategoricalParameterRangeSpecification?: CategoricalParameterRangeSpecification;
7475 }
7476 export interface ParameterRanges {
7477 /**
7478 * The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
7479 */
7480 IntegerParameterRanges?: IntegerParameterRanges;
7481 /**
7482 * The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
7483 */
7484 ContinuousParameterRanges?: ContinuousParameterRanges;
7485 /**
7486 * The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
7487 */
7488 CategoricalParameterRanges?: CategoricalParameterRanges;
7489 }
7490 export type ParameterType = "Integer"|"Continuous"|"Categorical"|"FreeText"|string;
7491 export type ParameterValue = string;
7492 export type ParameterValues = ParameterValue[];
7493 export interface Parent {
7494 /**
7495 * The name of the trial.
7496 */
7497 TrialName?: ExperimentEntityName;
7498 /**
7499 * The name of the experiment.
7500 */
7501 ExperimentName?: ExperimentEntityName;
7502 }
7503 export interface ParentHyperParameterTuningJob {
7504 /**
7505 * The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
7506 */
7507 HyperParameterTuningJobName?: HyperParameterTuningJobName;
7508 }
7509 export type ParentHyperParameterTuningJobs = ParentHyperParameterTuningJob[];
7510 export type Parents = Parent[];
7511 export type PresignedDomainUrl = string;
7512 export type ProblemType = "BinaryClassification"|"MulticlassClassification"|"Regression"|string;
7513 export interface ProcessingClusterConfig {
7514 /**
7515 * The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
7516 */
7517 InstanceCount: ProcessingInstanceCount;
7518 /**
7519 * The ML compute instance type for the processing job.
7520 */
7521 InstanceType: ProcessingInstanceType;
7522 /**
7523 * The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
7524 */
7525 VolumeSizeInGB: ProcessingVolumeSizeInGB;
7526 /**
7527 * 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 processing job.
7528 */
7529 VolumeKmsKeyId?: KmsKeyId;
7530 }
7531 export type ProcessingEnvironmentKey = string;
7532 export type ProcessingEnvironmentMap = {[key: string]: ProcessingEnvironmentValue};
7533 export type ProcessingEnvironmentValue = string;
7534 export interface ProcessingInput {
7535 /**
7536 * The name of the inputs for the processing job.
7537 */
7538 InputName: String;
7539 /**
7540 * The S3 inputs for the processing job.
7541 */
7542 S3Input: ProcessingS3Input;
7543 }
7544 export type ProcessingInputs = ProcessingInput[];
7545 export type ProcessingInstanceCount = number;
7546 export type ProcessingInstanceType = "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.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"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|string;
7547 export type ProcessingJobArn = string;
7548 export type ProcessingJobName = string;
7549 export type ProcessingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
7550 export type ProcessingJobSummaries = ProcessingJobSummary[];
7551 export interface ProcessingJobSummary {
7552 /**
7553 * The name of the processing job.
7554 */
7555 ProcessingJobName: ProcessingJobName;
7556 /**
7557 * The Amazon Resource Name (ARN) of the processing job..
7558 */
7559 ProcessingJobArn: ProcessingJobArn;
7560 /**
7561 * The time at which the processing job was created.
7562 */
7563 CreationTime: Timestamp;
7564 /**
7565 * The time at which the processing job completed.
7566 */
7567 ProcessingEndTime?: Timestamp;
7568 /**
7569 * A timestamp that indicates the last time the processing job was modified.
7570 */
7571 LastModifiedTime?: Timestamp;
7572 /**
7573 * The status of the processing job.
7574 */
7575 ProcessingJobStatus: ProcessingJobStatus;
7576 /**
7577 * A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
7578 */
7579 FailureReason?: FailureReason;
7580 /**
7581 * An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
7582 */
7583 ExitMessage?: ExitMessage;
7584 }
7585 export type ProcessingLocalPath = string;
7586 export type ProcessingMaxRuntimeInSeconds = number;
7587 export interface ProcessingOutput {
7588 /**
7589 * The name for the processing job output.
7590 */
7591 OutputName: String;
7592 /**
7593 * Configuration for processing job outputs in Amazon S3.
7594 */
7595 S3Output: ProcessingS3Output;
7596 }
7597 export interface ProcessingOutputConfig {
7598 /**
7599 * Output configuration information for a processing job.
7600 */
7601 Outputs: ProcessingOutputs;
7602 /**
7603 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
7604 */
7605 KmsKeyId?: KmsKeyId;
7606 }
7607 export type ProcessingOutputs = ProcessingOutput[];
7608 export interface ProcessingResources {
7609 /**
7610 * The configuration for the resources in a cluster used to run the processing job.
7611 */
7612 ClusterConfig: ProcessingClusterConfig;
7613 }
7614 export type ProcessingS3CompressionType = "None"|"Gzip"|string;
7615 export type ProcessingS3DataDistributionType = "FullyReplicated"|"ShardedByS3Key"|string;
7616 export type ProcessingS3DataType = "ManifestFile"|"S3Prefix"|string;
7617 export interface ProcessingS3Input {
7618 /**
7619 * The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
7620 */
7621 S3Uri: S3Uri;
7622 /**
7623 * The local path to the Amazon S3 bucket where you want Amazon SageMaker to download the inputs to run a processing job. LocalPath is an absolute path to the input data.
7624 */
7625 LocalPath: ProcessingLocalPath;
7626 /**
7627 * Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. 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 the processing job.
7628 */
7629 S3DataType: ProcessingS3DataType;
7630 /**
7631 * Wether to use File or Pipe input mode. 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.
7632 */
7633 S3InputMode: ProcessingS3InputMode;
7634 /**
7635 * Whether the data stored in Amazon S3 is FullyReplicated or ShardedByS3Key.
7636 */
7637 S3DataDistributionType?: ProcessingS3DataDistributionType;
7638 /**
7639 * Whether to use Gzip compresion for Amazon S3 storage.
7640 */
7641 S3CompressionType?: ProcessingS3CompressionType;
7642 }
7643 export type ProcessingS3InputMode = "Pipe"|"File"|string;
7644 export interface ProcessingS3Output {
7645 /**
7646 * A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
7647 */
7648 S3Uri: S3Uri;
7649 /**
7650 * The local path to the Amazon S3 bucket where you want Amazon SageMaker to save the results of an processing job. LocalPath is an absolute path to the input data.
7651 */
7652 LocalPath: ProcessingLocalPath;
7653 /**
7654 * Whether to upload the results of the processing job continuously or after the job completes.
7655 */
7656 S3UploadMode: ProcessingS3UploadMode;
7657 }
7658 export type ProcessingS3UploadMode = "Continuous"|"EndOfJob"|string;
7659 export interface ProcessingStoppingCondition {
7660 /**
7661 * Specifies the maximum runtime in seconds.
7662 */
7663 MaxRuntimeInSeconds: ProcessingMaxRuntimeInSeconds;
7664 }
7665 export type ProcessingVolumeSizeInGB = number;
7666 export type ProductId = string;
7667 export type ProductListings = String[];
7668 export interface ProductionVariant {
7669 /**
7670 * The name of the production variant.
7671 */
7672 VariantName: VariantName;
7673 /**
7674 * The name of the model that you want to host. This is the name that you specified when creating the model.
7675 */
7676 ModelName: ModelName;
7677 /**
7678 * Number of instances to launch initially.
7679 */
7680 InitialInstanceCount: TaskCount;
7681 /**
7682 * The ML compute instance type.
7683 */
7684 InstanceType: ProductionVariantInstanceType;
7685 /**
7686 * 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.
7687 */
7688 InitialVariantWeight?: VariantWeight;
7689 /**
7690 * 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.
7691 */
7692 AcceleratorType?: ProductionVariantAcceleratorType;
7693 }
7694 export type ProductionVariantAcceleratorType = "ml.eia1.medium"|"ml.eia1.large"|"ml.eia1.xlarge"|"ml.eia2.medium"|"ml.eia2.large"|"ml.eia2.xlarge"|string;
7695 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"|"ml.inf1.xlarge"|"ml.inf1.2xlarge"|"ml.inf1.6xlarge"|"ml.inf1.24xlarge"|string;
7696 export type ProductionVariantList = ProductionVariant[];
7697 export interface ProductionVariantSummary {
7698 /**
7699 * The name of the variant.
7700 */
7701 VariantName: VariantName;
7702 /**
7703 * An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
7704 */
7705 DeployedImages?: DeployedImages;
7706 /**
7707 * The weight associated with the variant.
7708 */
7709 CurrentWeight?: VariantWeight;
7710 /**
7711 * The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
7712 */
7713 DesiredWeight?: VariantWeight;
7714 /**
7715 * The number of instances associated with the variant.
7716 */
7717 CurrentInstanceCount?: TaskCount;
7718 /**
7719 * The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
7720 */
7721 DesiredInstanceCount?: TaskCount;
7722 }
7723 export type ProductionVariantSummaryList = ProductionVariantSummary[];
7724 export type PropertyNameHint = string;
7725 export interface PropertyNameQuery {
7726 /**
7727 * Text that begins a property's name.
7728 */
7729 PropertyNameHint: PropertyNameHint;
7730 }
7731 export interface PropertyNameSuggestion {
7732 /**
7733 * A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.
7734 */
7735 PropertyName?: ResourcePropertyName;
7736 }
7737 export type PropertyNameSuggestionList = PropertyNameSuggestion[];
7738 export interface PublicWorkforceTaskPrice {
7739 /**
7740 * Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
7741 */
7742 AmountInUsd?: USD;
7743 }
7744 export type RealtimeInferenceInstanceTypes = ProductionVariantInstanceType[];
7745 export type RecordWrapper = "None"|"RecordIO"|string;
7746 export interface RenderUiTemplateRequest {
7747 /**
7748 * A Template object containing the worker UI template to render.
7749 */
7750 UiTemplate: UiTemplate;
7751 /**
7752 * A RenderableTask object containing a representative task to render.
7753 */
7754 Task: RenderableTask;
7755 /**
7756 * The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
7757 */
7758 RoleArn: RoleArn;
7759 }
7760 export interface RenderUiTemplateResponse {
7761 /**
7762 * A Liquid template that renders the HTML for the worker UI.
7763 */
7764 RenderedContent: String;
7765 /**
7766 * 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.
7767 */
7768 Errors: RenderingErrorList;
7769 }
7770 export interface RenderableTask {
7771 /**
7772 * 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".
7773 */
7774 Input: TaskInput;
7775 }
7776 export interface RenderingError {
7777 /**
7778 * A unique identifier for a specific class of errors.
7779 */
7780 Code: String;
7781 /**
7782 * A human-readable message describing the error.
7783 */
7784 Message: String;
7785 }
7786 export type RenderingErrorList = RenderingError[];
7787 export interface ResolvedAttributes {
7788 AutoMLJobObjective?: AutoMLJobObjective;
7789 /**
7790 * The problem type.
7791 */
7792 ProblemType?: ProblemType;
7793 CompletionCriteria?: AutoMLJobCompletionCriteria;
7794 }
7795 export type ResourceArn = string;
7796 export interface ResourceConfig {
7797 /**
7798 * The ML compute instance type.
7799 */
7800 InstanceType: TrainingInstanceType;
7801 /**
7802 * The number of ML compute instances to use. For distributed training, provide a value greater than 1.
7803 */
7804 InstanceCount: TrainingInstanceCount;
7805 /**
7806 * 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. Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
7807 */
7808 VolumeSizeInGB: VolumeSizeInGB;
7809 /**
7810 * The 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. Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes. The VolumeKmsKeyId can be in 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"
7811 */
7812 VolumeKmsKeyId?: KmsKeyId;
7813 }
7814 export type ResourceId = string;
7815 export interface ResourceLimits {
7816 /**
7817 * The maximum number of training jobs that a hyperparameter tuning job can launch.
7818 */
7819 MaxNumberOfTrainingJobs: MaxNumberOfTrainingJobs;
7820 /**
7821 * The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
7822 */
7823 MaxParallelTrainingJobs: MaxParallelTrainingJobs;
7824 }
7825 export type ResourcePropertyName = string;
7826 export interface ResourceSpec {
7827 /**
7828 * The Amazon Resource Name (ARN) of the environment.
7829 */
7830 EnvironmentArn?: EnvironmentArn;
7831 /**
7832 * The instance type.
7833 */
7834 InstanceType?: AppInstanceType;
7835 }
7836 export type ResourceType = "TrainingJob"|"Experiment"|"ExperimentTrial"|"ExperimentTrialComponent"|string;
7837 export type ResponseMIMEType = string;
7838 export type ResponseMIMETypes = ResponseMIMEType[];
7839 export interface RetentionPolicy {
7840 /**
7841 * The home Amazon Elastic File System (EFS).
7842 */
7843 HomeEfsFileSystem?: RetentionType;
7844 }
7845 export type RetentionType = "Retain"|"Delete"|string;
7846 export type RoleArn = string;
7847 export type RootAccess = "Enabled"|"Disabled"|string;
7848 export type RuleConfigurationName = string;
7849 export type RuleEvaluationStatus = "InProgress"|"NoIssuesFound"|"IssuesFound"|"Error"|"Stopping"|"Stopped"|string;
7850 export type RuleParameters = {[key: string]: ConfigValue};
7851 export type S3DataDistribution = "FullyReplicated"|"ShardedByS3Key"|string;
7852 export interface S3DataSource {
7853 /**
7854 * 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.
7855 */
7856 S3DataType: S3DataType;
7857 /**
7858 * 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: The preceding JSON matches the following s3Uris: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] 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 ... s3://customer_bucket/some/prefix/relative/path/custdata-N 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.
7859 */
7860 S3Uri: S3Uri;
7861 /**
7862 * 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.
7863 */
7864 S3DataDistributionType?: S3DataDistribution;
7865 /**
7866 * A list of one or more attribute names to use that are found in a specified augmented manifest file.
7867 */
7868 AttributeNames?: AttributeNames;
7869 }
7870 export type S3DataType = "ManifestFile"|"S3Prefix"|"AugmentedManifestFile"|string;
7871 export type S3Uri = string;
7872 export type SamplingPercentage = number;
7873 export interface ScheduleConfig {
7874 /**
7875 * A cron expression that describes details about the monitoring schedule. Currently the only supported cron expressions are: If you want to set the job to start every hour, please use the following: Hourly: cron(0 * ? * * *) If you want to start the job daily: cron(0 [00-23] ? * * *) For example, the following are valid cron expressions: Daily at noon UTC: cron(0 12 ? * * *) Daily at midnight UTC: cron(0 0 ? * * *) To support running every 6, 12 hours, the following are also supported: cron(0 [00-23]/[01-24] ? * * *) For example, the following are valid cron expressions: Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *) Every two hours starting at midnight: cron(0 0/2 ? * * *) Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution. We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.
7876 */
7877 ScheduleExpression: ScheduleExpression;
7878 }
7879 export type ScheduleExpression = string;
7880 export type ScheduleStatus = "Pending"|"Failed"|"Scheduled"|"Stopped"|string;
7881 export interface SearchExpression {
7882 /**
7883 * A list of filter objects.
7884 */
7885 Filters?: FilterList;
7886 /**
7887 * A list of nested filter objects.
7888 */
7889 NestedFilters?: NestedFiltersList;
7890 /**
7891 * A list of search expression objects.
7892 */
7893 SubExpressions?: SearchExpressionList;
7894 /**
7895 * 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.
7896 */
7897 Operator?: BooleanOperator;
7898 }
7899 export type SearchExpressionList = SearchExpression[];
7900 export interface SearchRecord {
7901 /**
7902 * A TrainingJob object that is returned as part of a Search request.
7903 */
7904 TrainingJob?: TrainingJob;
7905 /**
7906 * A summary of the properties of an experiment.
7907 */
7908 Experiment?: Experiment;
7909 /**
7910 * A summary of the properties of a trial.
7911 */
7912 Trial?: Trial;
7913 /**
7914 * A summary of the properties of a trial component.
7915 */
7916 TrialComponent?: TrialComponent;
7917 }
7918 export interface SearchRequest {
7919 /**
7920 * The name of the Amazon SageMaker resource to search for.
7921 */
7922 Resource: ResourceType;
7923 /**
7924 * 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.
7925 */
7926 SearchExpression?: SearchExpression;
7927 /**
7928 * The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
7929 */
7930 SortBy?: ResourcePropertyName;
7931 /**
7932 * How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
7933 */
7934 SortOrder?: SearchSortOrder;
7935 /**
7936 * 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.
7937 */
7938 NextToken?: NextToken;
7939 /**
7940 * The maximum number of results to return in a SearchResponse.
7941 */
7942 MaxResults?: MaxResults;
7943 }
7944 export interface SearchResponse {
7945 /**
7946 * A list of SearchResult objects.
7947 */
7948 Results?: SearchResultsList;
7949 /**
7950 * 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.
7951 */
7952 NextToken?: NextToken;
7953 }
7954 export type SearchResultsList = SearchRecord[];
7955 export type SearchSortOrder = "Ascending"|"Descending"|string;
7956 export type SecondaryStatus = "Starting"|"LaunchingMLInstances"|"PreparingTrainingStack"|"Downloading"|"DownloadingTrainingImage"|"Training"|"Uploading"|"Stopping"|"Stopped"|"MaxRuntimeExceeded"|"Completed"|"Failed"|"Interrupted"|"MaxWaitTimeExceeded"|string;
7957 export interface SecondaryStatusTransition {
7958 /**
7959 * 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
7960 */
7961 Status: SecondaryStatus;
7962 /**
7963 * A timestamp that shows when the training job transitioned to the current secondary status state.
7964 */
7965 StartTime: Timestamp;
7966 /**
7967 * 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.
7968 */
7969 EndTime?: Timestamp;
7970 /**
7971 * 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
7972 */
7973 StatusMessage?: StatusMessage;
7974 }
7975 export type SecondaryStatusTransitions = SecondaryStatusTransition[];
7976 export type SecretArn = string;
7977 export type SecurityGroupId = string;
7978 export type SecurityGroupIds = SecurityGroupId[];
7979 export type Seed = number;
7980 export type SessionExpirationDurationInSeconds = number;
7981 export interface SharingSettings {
7982 /**
7983 * The notebook output option.
7984 */
7985 NotebookOutputOption?: NotebookOutputOption;
7986 /**
7987 * The Amazon S3 output path.
7988 */
7989 S3OutputPath?: S3Uri;
7990 /**
7991 * The AWS Key Management Service encryption key ID.
7992 */
7993 S3KmsKeyId?: KmsKeyId;
7994 }
7995 export interface ShuffleConfig {
7996 /**
7997 * Determines the shuffling order in ShuffleConfig value.
7998 */
7999 Seed: Seed;
8000 }
8001 export type SingleSignOnUserIdentifier = string;
8002 export type SortBy = "Name"|"CreationTime"|"Status"|string;
8003 export type SortExperimentsBy = "Name"|"CreationTime"|string;
8004 export type SortOrder = "Ascending"|"Descending"|string;
8005 export type SortTrialComponentsBy = "Name"|"CreationTime"|string;
8006 export type SortTrialsBy = "Name"|"CreationTime"|string;
8007 export interface SourceAlgorithm {
8008 /**
8009 * 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).
8010 */
8011 ModelDataUrl?: Url;
8012 /**
8013 * 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.
8014 */
8015 AlgorithmName: ArnOrName;
8016 }
8017 export type SourceAlgorithmList = SourceAlgorithm[];
8018 export interface SourceAlgorithmSpecification {
8019 /**
8020 * A list of the algorithms that were used to create a model package.
8021 */
8022 SourceAlgorithms: SourceAlgorithmList;
8023 }
8024 export interface SourceIpConfig {
8025 /**
8026 * A list of one to four Classless Inter-Domain Routing (CIDR) values. Maximum: Four CIDR values The following Length Constraints apply to individual CIDR values in the CIDR value list.
8027 */
8028 Cidrs: Cidrs;
8029 }
8030 export type SourceType = string;
8031 export type SplitType = "None"|"Line"|"RecordIO"|"TFRecord"|string;
8032 export interface StartMonitoringScheduleRequest {
8033 /**
8034 * The name of the schedule to start.
8035 */
8036 MonitoringScheduleName: MonitoringScheduleName;
8037 }
8038 export interface StartNotebookInstanceInput {
8039 /**
8040 * The name of the notebook instance to start.
8041 */
8042 NotebookInstanceName: NotebookInstanceName;
8043 }
8044 export type StatusDetails = string;
8045 export type StatusMessage = string;
8046 export interface StopAutoMLJobRequest {
8047 /**
8048 * The name of the object you are requesting.
8049 */
8050 AutoMLJobName: AutoMLJobName;
8051 }
8052 export interface StopCompilationJobRequest {
8053 /**
8054 * The name of the model compilation job to stop.
8055 */
8056 CompilationJobName: EntityName;
8057 }
8058 export interface StopHyperParameterTuningJobRequest {
8059 /**
8060 * The name of the tuning job to stop.
8061 */
8062 HyperParameterTuningJobName: HyperParameterTuningJobName;
8063 }
8064 export interface StopLabelingJobRequest {
8065 /**
8066 * The name of the labeling job to stop.
8067 */
8068 LabelingJobName: LabelingJobName;
8069 }
8070 export interface StopMonitoringScheduleRequest {
8071 /**
8072 * The name of the schedule to stop.
8073 */
8074 MonitoringScheduleName: MonitoringScheduleName;
8075 }
8076 export interface StopNotebookInstanceInput {
8077 /**
8078 * The name of the notebook instance to terminate.
8079 */
8080 NotebookInstanceName: NotebookInstanceName;
8081 }
8082 export interface StopProcessingJobRequest {
8083 /**
8084 * The name of the processing job to stop.
8085 */
8086 ProcessingJobName: ProcessingJobName;
8087 }
8088 export interface StopTrainingJobRequest {
8089 /**
8090 * The name of the training job to stop.
8091 */
8092 TrainingJobName: TrainingJobName;
8093 }
8094 export interface StopTransformJobRequest {
8095 /**
8096 * The name of the transform job to stop.
8097 */
8098 TransformJobName: TransformJobName;
8099 }
8100 export interface StoppingCondition {
8101 /**
8102 * 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.
8103 */
8104 MaxRuntimeInSeconds?: MaxRuntimeInSeconds;
8105 /**
8106 * 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.
8107 */
8108 MaxWaitTimeInSeconds?: MaxWaitTimeInSeconds;
8109 }
8110 export type String = string;
8111 export type String1024 = string;
8112 export type String200 = string;
8113 export type String256 = string;
8114 export type StringParameterValue = string;
8115 export type SubnetId = string;
8116 export type Subnets = SubnetId[];
8117 export interface SubscribedWorkteam {
8118 /**
8119 * The Amazon Resource Name (ARN) of the vendor that you have subscribed.
8120 */
8121 WorkteamArn: WorkteamArn;
8122 /**
8123 * The title of the service provided by the vendor in the Amazon Marketplace.
8124 */
8125 MarketplaceTitle?: String200;
8126 /**
8127 * The name of the vendor in the Amazon Marketplace.
8128 */
8129 SellerName?: String;
8130 /**
8131 * The description of the vendor from the Amazon Marketplace.
8132 */
8133 MarketplaceDescription?: String200;
8134 /**
8135 *
8136 */
8137 ListingId?: String;
8138 }
8139 export type SubscribedWorkteams = SubscribedWorkteam[];
8140 export type Success = boolean;
8141 export interface SuggestionQuery {
8142 /**
8143 * Defines a property name hint. Only property names that begin with the specified hint are included in the response.
8144 */
8145 PropertyNameQuery?: PropertyNameQuery;
8146 }
8147 export interface Tag {
8148 /**
8149 * The tag key.
8150 */
8151 Key: TagKey;
8152 /**
8153 * The tag value.
8154 */
8155 Value: TagValue;
8156 }
8157 export type TagKey = string;
8158 export type TagKeyList = TagKey[];
8159 export type TagList = Tag[];
8160 export type TagValue = string;
8161 export type TargetAttributeName = string;
8162 export type TargetDevice = "lambda"|"ml_m4"|"ml_m5"|"ml_c4"|"ml_c5"|"ml_p2"|"ml_p3"|"ml_inf1"|"jetson_tx1"|"jetson_tx2"|"jetson_nano"|"jetson_xavier"|"rasp3b"|"imx8qm"|"deeplens"|"rk3399"|"rk3288"|"aisage"|"sbe_c"|"qcs605"|"qcs603"|"sitara_am57x"|"amba_cv22"|string;
8163 export type TargetObjectiveMetricValue = number;
8164 export type TaskAvailabilityLifetimeInSeconds = number;
8165 export type TaskCount = number;
8166 export type TaskDescription = string;
8167 export type TaskInput = string;
8168 export type TaskKeyword = string;
8169 export type TaskKeywords = TaskKeyword[];
8170 export type TaskTimeLimitInSeconds = number;
8171 export type TaskTitle = string;
8172 export type TemplateContent = string;
8173 export type TemplateContentSha256 = string;
8174 export type TemplateUrl = string;
8175 export interface TensorBoardAppSettings {
8176 /**
8177 * The instance type and quantity.
8178 */
8179 DefaultResourceSpec?: ResourceSpec;
8180 }
8181 export interface TensorBoardOutputConfig {
8182 /**
8183 * Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
8184 */
8185 LocalPath?: DirectoryPath;
8186 /**
8187 * Path to Amazon S3 storage location for TensorBoard output.
8188 */
8189 S3OutputPath: S3Uri;
8190 }
8191 export type TenthFractionsOfACent = number;
8192 export type Timestamp = Date;
8193 export type TrainingInputMode = "Pipe"|"File"|string;
8194 export type TrainingInstanceCount = number;
8195 export type TrainingInstanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.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;
8196 export type TrainingInstanceTypes = TrainingInstanceType[];
8197 export interface TrainingJob {
8198 /**
8199 * The name of the training job.
8200 */
8201 TrainingJobName?: TrainingJobName;
8202 /**
8203 * The Amazon Resource Name (ARN) of the training job.
8204 */
8205 TrainingJobArn?: TrainingJobArn;
8206 /**
8207 * The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
8208 */
8209 TuningJobArn?: HyperParameterTuningJobArn;
8210 /**
8211 * The Amazon Resource Name (ARN) of the labeling job.
8212 */
8213 LabelingJobArn?: LabelingJobArn;
8214 /**
8215 * The Amazon Resource Name (ARN) of the job.
8216 */
8217 AutoMLJobArn?: AutoMLJobArn;
8218 /**
8219 * Information about the Amazon S3 location that is configured for storing model artifacts.
8220 */
8221 ModelArtifacts?: ModelArtifacts;
8222 /**
8223 * 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.
8224 */
8225 TrainingJobStatus?: TrainingJobStatus;
8226 /**
8227 * 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
8228 */
8229 SecondaryStatus?: SecondaryStatus;
8230 /**
8231 * If the training job failed, the reason it failed.
8232 */
8233 FailureReason?: FailureReason;
8234 /**
8235 * Algorithm-specific parameters.
8236 */
8237 HyperParameters?: HyperParameters;
8238 /**
8239 * Information about the algorithm used for training, and algorithm metadata.
8240 */
8241 AlgorithmSpecification?: AlgorithmSpecification;
8242 /**
8243 * The AWS Identity and Access Management (IAM) role configured for the training job.
8244 */
8245 RoleArn?: RoleArn;
8246 /**
8247 * An array of Channel objects that describes each data input channel.
8248 */
8249 InputDataConfig?: InputDataConfig;
8250 /**
8251 * The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
8252 */
8253 OutputDataConfig?: OutputDataConfig;
8254 /**
8255 * Resources, including ML compute instances and ML storage volumes, that are configured for model training.
8256 */
8257 ResourceConfig?: ResourceConfig;
8258 /**
8259 * 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.
8260 */
8261 VpcConfig?: VpcConfig;
8262 /**
8263 * 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.
8264 */
8265 StoppingCondition?: StoppingCondition;
8266 /**
8267 * A timestamp that indicates when the training job was created.
8268 */
8269 CreationTime?: Timestamp;
8270 /**
8271 * 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.
8272 */
8273 TrainingStartTime?: Timestamp;
8274 /**
8275 * 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.
8276 */
8277 TrainingEndTime?: Timestamp;
8278 /**
8279 * A timestamp that indicates when the status of the training job was last modified.
8280 */
8281 LastModifiedTime?: Timestamp;
8282 /**
8283 * A history of all of the secondary statuses that the training job has transitioned through.
8284 */
8285 SecondaryStatusTransitions?: SecondaryStatusTransitions;
8286 /**
8287 * 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.
8288 */
8289 FinalMetricDataList?: FinalMetricDataList;
8290 /**
8291 * 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.
8292 */
8293 EnableNetworkIsolation?: Boolean;
8294 /**
8295 * 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.
8296 */
8297 EnableInterContainerTrafficEncryption?: Boolean;
8298 /**
8299 * When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
8300 */
8301 EnableManagedSpotTraining?: Boolean;
8302 CheckpointConfig?: CheckpointConfig;
8303 /**
8304 * The training time in seconds.
8305 */
8306 TrainingTimeInSeconds?: TrainingTimeInSeconds;
8307 /**
8308 * The billable time in seconds.
8309 */
8310 BillableTimeInSeconds?: BillableTimeInSeconds;
8311 DebugHookConfig?: DebugHookConfig;
8312 ExperimentConfig?: ExperimentConfig;
8313 /**
8314 * Information about the debug rule configuration.
8315 */
8316 DebugRuleConfigurations?: DebugRuleConfigurations;
8317 TensorBoardOutputConfig?: TensorBoardOutputConfig;
8318 /**
8319 * Information about the evaluation status of the rules for the training job.
8320 */
8321 DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatuses;
8322 /**
8323 * An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
8324 */
8325 Tags?: TagList;
8326 }
8327 export type TrainingJobArn = string;
8328 export interface TrainingJobDefinition {
8329 /**
8330 * 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.
8331 */
8332 TrainingInputMode: TrainingInputMode;
8333 /**
8334 * The hyperparameters used for the training job.
8335 */
8336 HyperParameters?: HyperParameters;
8337 /**
8338 * An array of Channel objects, each of which specifies an input source.
8339 */
8340 InputDataConfig: InputDataConfig;
8341 /**
8342 * the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
8343 */
8344 OutputDataConfig: OutputDataConfig;
8345 /**
8346 * The resources, including the ML compute instances and ML storage volumes, to use for model training.
8347 */
8348 ResourceConfig: ResourceConfig;
8349 /**
8350 * 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.
8351 */
8352 StoppingCondition: StoppingCondition;
8353 }
8354 export type TrainingJobEarlyStoppingType = "Off"|"Auto"|string;
8355 export type TrainingJobName = string;
8356 export type TrainingJobSortByOptions = "Name"|"CreationTime"|"Status"|"FinalObjectiveMetricValue"|string;
8357 export type TrainingJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
8358 export type TrainingJobStatusCounter = number;
8359 export interface TrainingJobStatusCounters {
8360 /**
8361 * The number of completed training jobs launched by the hyperparameter tuning job.
8362 */
8363 Completed?: TrainingJobStatusCounter;
8364 /**
8365 * The number of in-progress training jobs launched by a hyperparameter tuning job.
8366 */
8367 InProgress?: TrainingJobStatusCounter;
8368 /**
8369 * 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.
8370 */
8371 RetryableError?: TrainingJobStatusCounter;
8372 /**
8373 * 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.
8374 */
8375 NonRetryableError?: TrainingJobStatusCounter;
8376 /**
8377 * The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
8378 */
8379 Stopped?: TrainingJobStatusCounter;
8380 }
8381 export type TrainingJobSummaries = TrainingJobSummary[];
8382 export interface TrainingJobSummary {
8383 /**
8384 * The name of the training job that you want a summary for.
8385 */
8386 TrainingJobName: TrainingJobName;
8387 /**
8388 * The Amazon Resource Name (ARN) of the training job.
8389 */
8390 TrainingJobArn: TrainingJobArn;
8391 /**
8392 * A timestamp that shows when the training job was created.
8393 */
8394 CreationTime: Timestamp;
8395 /**
8396 * 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).
8397 */
8398 TrainingEndTime?: Timestamp;
8399 /**
8400 * Timestamp when the training job was last modified.
8401 */
8402 LastModifiedTime?: Timestamp;
8403 /**
8404 * The status of the training job.
8405 */
8406 TrainingJobStatus: TrainingJobStatus;
8407 }
8408 export interface TrainingSpecification {
8409 /**
8410 * The Amazon ECR registry path of the Docker image that contains the training algorithm.
8411 */
8412 TrainingImage: Image;
8413 /**
8414 * An MD5 hash of the training algorithm that identifies the Docker image used for training.
8415 */
8416 TrainingImageDigest?: ImageDigest;
8417 /**
8418 * A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.&gt;
8419 */
8420 SupportedHyperParameters?: HyperParameterSpecifications;
8421 /**
8422 * A list of the instance types that this algorithm can use for training.
8423 */
8424 SupportedTrainingInstanceTypes: TrainingInstanceTypes;
8425 /**
8426 * Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
8427 */
8428 SupportsDistributedTraining?: Boolean;
8429 /**
8430 * A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
8431 */
8432 MetricDefinitions?: MetricDefinitionList;
8433 /**
8434 * A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
8435 */
8436 TrainingChannels: ChannelSpecifications;
8437 /**
8438 * A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
8439 */
8440 SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjectives;
8441 }
8442 export type TrainingTimeInSeconds = number;
8443 export interface TransformDataSource {
8444 /**
8445 * The S3 location of the data source that is associated with a channel.
8446 */
8447 S3DataSource: TransformS3DataSource;
8448 }
8449 export type TransformEnvironmentKey = string;
8450 export type TransformEnvironmentMap = {[key: string]: TransformEnvironmentValue};
8451 export type TransformEnvironmentValue = string;
8452 export interface TransformInput {
8453 /**
8454 * Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
8455 */
8456 DataSource: TransformDataSource;
8457 /**
8458 * 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.
8459 */
8460 ContentType?: ContentType;
8461 /**
8462 * 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.
8463 */
8464 CompressionType?: CompressionType;
8465 /**
8466 * 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 RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
8467 */
8468 SplitType?: SplitType;
8469 }
8470 export type TransformInstanceCount = number;
8471 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;
8472 export type TransformInstanceTypes = TransformInstanceType[];
8473 export type TransformJobArn = string;
8474 export interface TransformJobDefinition {
8475 /**
8476 * The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
8477 */
8478 MaxConcurrentTransforms?: MaxConcurrentTransforms;
8479 /**
8480 * The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
8481 */
8482 MaxPayloadInMB?: MaxPayloadInMB;
8483 /**
8484 * 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.
8485 */
8486 BatchStrategy?: BatchStrategy;
8487 /**
8488 * The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
8489 */
8490 Environment?: TransformEnvironmentMap;
8491 /**
8492 * A description of the input source and the way the transform job consumes it.
8493 */
8494 TransformInput: TransformInput;
8495 /**
8496 * Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
8497 */
8498 TransformOutput: TransformOutput;
8499 /**
8500 * Identifies the ML compute instances for the transform job.
8501 */
8502 TransformResources: TransformResources;
8503 }
8504 export type TransformJobName = string;
8505 export type TransformJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|string;
8506 export type TransformJobSummaries = TransformJobSummary[];
8507 export interface TransformJobSummary {
8508 /**
8509 * The name of the transform job.
8510 */
8511 TransformJobName: TransformJobName;
8512 /**
8513 * The Amazon Resource Name (ARN) of the transform job.
8514 */
8515 TransformJobArn: TransformJobArn;
8516 /**
8517 * A timestamp that shows when the transform Job was created.
8518 */
8519 CreationTime: Timestamp;
8520 /**
8521 * 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.
8522 */
8523 TransformEndTime?: Timestamp;
8524 /**
8525 * Indicates when the transform job was last modified.
8526 */
8527 LastModifiedTime?: Timestamp;
8528 /**
8529 * The status of the transform job.
8530 */
8531 TransformJobStatus: TransformJobStatus;
8532 /**
8533 * If the transform job failed, the reason it failed.
8534 */
8535 FailureReason?: FailureReason;
8536 }
8537 export interface TransformOutput {
8538 /**
8539 * 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.
8540 */
8541 S3OutputPath: S3Uri;
8542 /**
8543 * 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.
8544 */
8545 Accept?: Accept;
8546 /**
8547 * 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.
8548 */
8549 AssembleWith?: AssemblyType;
8550 /**
8551 * 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: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: 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 CreateModel request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
8552 */
8553 KmsKeyId?: KmsKeyId;
8554 }
8555 export interface TransformResources {
8556 /**
8557 * 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.
8558 */
8559 InstanceType: TransformInstanceType;
8560 /**
8561 * 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.
8562 */
8563 InstanceCount: TransformInstanceCount;
8564 /**
8565 * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model 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: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
8566 */
8567 VolumeKmsKeyId?: KmsKeyId;
8568 }
8569 export interface TransformS3DataSource {
8570 /**
8571 * 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
8572 */
8573 S3DataType: S3DataType;
8574 /**
8575 * 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", ... "relative/path/custdata-N" ] 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 ... s3://customer_bucket/some/prefix/relative/path/custdata-N 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.
8576 */
8577 S3Uri: S3Uri;
8578 }
8579 export interface Trial {
8580 /**
8581 * The name of the trial.
8582 */
8583 TrialName?: ExperimentEntityName;
8584 /**
8585 * The Amazon Resource Name (ARN) of the trial.
8586 */
8587 TrialArn?: TrialArn;
8588 /**
8589 * The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
8590 */
8591 DisplayName?: ExperimentEntityName;
8592 /**
8593 * The name of the experiment the trial is part of.
8594 */
8595 ExperimentName?: ExperimentEntityName;
8596 Source?: TrialSource;
8597 /**
8598 * When the trial was created.
8599 */
8600 CreationTime?: Timestamp;
8601 CreatedBy?: UserContext;
8602 /**
8603 * Who last modified the trial.
8604 */
8605 LastModifiedTime?: Timestamp;
8606 LastModifiedBy?: UserContext;
8607 /**
8608 * The list of tags that are associated with the trial. You can use Search API to search on the tags.
8609 */
8610 Tags?: TagList;
8611 /**
8612 * A list of the components associated with the trial. For each component, a summary of the component's properties is included.
8613 */
8614 TrialComponentSummaries?: TrialComponentSimpleSummaries;
8615 }
8616 export type TrialArn = string;
8617 export interface TrialComponent {
8618 /**
8619 * The name of the trial component.
8620 */
8621 TrialComponentName?: ExperimentEntityName;
8622 /**
8623 * The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
8624 */
8625 DisplayName?: ExperimentEntityName;
8626 /**
8627 * The Amazon Resource Name (ARN) of the trial component.
8628 */
8629 TrialComponentArn?: TrialComponentArn;
8630 Source?: TrialComponentSource;
8631 Status?: TrialComponentStatus;
8632 /**
8633 * When the component started.
8634 */
8635 StartTime?: Timestamp;
8636 /**
8637 * When the component ended.
8638 */
8639 EndTime?: Timestamp;
8640 /**
8641 * When the component was created.
8642 */
8643 CreationTime?: Timestamp;
8644 CreatedBy?: UserContext;
8645 /**
8646 * When the component was last modified.
8647 */
8648 LastModifiedTime?: Timestamp;
8649 LastModifiedBy?: UserContext;
8650 /**
8651 * The hyperparameters of the component.
8652 */
8653 Parameters?: TrialComponentParameters;
8654 /**
8655 * The input artifacts of the component.
8656 */
8657 InputArtifacts?: TrialComponentArtifacts;
8658 /**
8659 * The output artifacts of the component.
8660 */
8661 OutputArtifacts?: TrialComponentArtifacts;
8662 /**
8663 * The metrics for the component.
8664 */
8665 Metrics?: TrialComponentMetricSummaries;
8666 /**
8667 * The source of the trial component.&gt;
8668 */
8669 SourceDetail?: TrialComponentSourceDetail;
8670 /**
8671 * The list of tags that are associated with the component. You can use Search API to search on the tags.
8672 */
8673 Tags?: TagList;
8674 /**
8675 * An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
8676 */
8677 Parents?: Parents;
8678 }
8679 export type TrialComponentArn = string;
8680 export interface TrialComponentArtifact {
8681 /**
8682 * The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.
8683 */
8684 MediaType?: MediaType;
8685 /**
8686 * The location of the artifact.
8687 */
8688 Value: TrialComponentArtifactValue;
8689 }
8690 export type TrialComponentArtifactValue = string;
8691 export type TrialComponentArtifacts = {[key: string]: TrialComponentArtifact};
8692 export type TrialComponentKey256 = string;
8693 export type TrialComponentKey64 = string;
8694 export type TrialComponentMetricSummaries = TrialComponentMetricSummary[];
8695 export interface TrialComponentMetricSummary {
8696 /**
8697 * The name of the metric.
8698 */
8699 MetricName?: MetricName;
8700 /**
8701 * The Amazon Resource Name (ARN) of the source.
8702 */
8703 SourceArn?: TrialComponentSourceArn;
8704 /**
8705 * When the metric was last updated.
8706 */
8707 TimeStamp?: Timestamp;
8708 /**
8709 * The maximum value of the metric.
8710 */
8711 Max?: OptionalDouble;
8712 /**
8713 * The minimum value of the metric.
8714 */
8715 Min?: OptionalDouble;
8716 /**
8717 * The most recent value of the metric.
8718 */
8719 Last?: OptionalDouble;
8720 /**
8721 * The number of samples used to generate the metric.
8722 */
8723 Count?: OptionalInteger;
8724 /**
8725 * The average value of the metric.
8726 */
8727 Avg?: OptionalDouble;
8728 /**
8729 * The standard deviation of the metric.
8730 */
8731 StdDev?: OptionalDouble;
8732 }
8733 export interface TrialComponentParameterValue {
8734 /**
8735 * The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.
8736 */
8737 StringValue?: StringParameterValue;
8738 /**
8739 * The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
8740 */
8741 NumberValue?: DoubleParameterValue;
8742 }
8743 export type TrialComponentParameters = {[key: string]: TrialComponentParameterValue};
8744 export type TrialComponentPrimaryStatus = "InProgress"|"Completed"|"Failed"|string;
8745 export type TrialComponentSimpleSummaries = TrialComponentSimpleSummary[];
8746 export interface TrialComponentSimpleSummary {
8747 /**
8748 * The name of the trial component.
8749 */
8750 TrialComponentName?: ExperimentEntityName;
8751 /**
8752 * The Amazon Resource Name (ARN) of the trial component.
8753 */
8754 TrialComponentArn?: TrialComponentArn;
8755 TrialComponentSource?: TrialComponentSource;
8756 /**
8757 * When the component was created.
8758 */
8759 CreationTime?: Timestamp;
8760 CreatedBy?: UserContext;
8761 }
8762 export interface TrialComponentSource {
8763 /**
8764 * The Amazon Resource Name (ARN) of the source.
8765 */
8766 SourceArn: TrialComponentSourceArn;
8767 /**
8768 * The source job type.
8769 */
8770 SourceType?: SourceType;
8771 }
8772 export type TrialComponentSourceArn = string;
8773 export interface TrialComponentSourceDetail {
8774 /**
8775 * The Amazon Resource Name (ARN) of the source.
8776 */
8777 SourceArn?: TrialComponentSourceArn;
8778 TrainingJob?: TrainingJob;
8779 }
8780 export interface TrialComponentStatus {
8781 /**
8782 * The status of the trial component.
8783 */
8784 PrimaryStatus?: TrialComponentPrimaryStatus;
8785 /**
8786 * If the component failed, a message describing why.
8787 */
8788 Message?: TrialComponentStatusMessage;
8789 }
8790 export type TrialComponentStatusMessage = string;
8791 export type TrialComponentSummaries = TrialComponentSummary[];
8792 export interface TrialComponentSummary {
8793 /**
8794 * The name of the trial component.
8795 */
8796 TrialComponentName?: ExperimentEntityName;
8797 /**
8798 * The ARN of the trial component.
8799 */
8800 TrialComponentArn?: TrialComponentArn;
8801 /**
8802 * The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
8803 */
8804 DisplayName?: ExperimentEntityName;
8805 TrialComponentSource?: TrialComponentSource;
8806 /**
8807 * The status of the component. States include: InProgress Completed Failed
8808 */
8809 Status?: TrialComponentStatus;
8810 /**
8811 * When the component started.
8812 */
8813 StartTime?: Timestamp;
8814 /**
8815 * When the component ended.
8816 */
8817 EndTime?: Timestamp;
8818 /**
8819 * When the component was created.
8820 */
8821 CreationTime?: Timestamp;
8822 /**
8823 * Who created the component.
8824 */
8825 CreatedBy?: UserContext;
8826 /**
8827 * When the component was last modified.
8828 */
8829 LastModifiedTime?: Timestamp;
8830 /**
8831 * Who last modified the component.
8832 */
8833 LastModifiedBy?: UserContext;
8834 }
8835 export interface TrialSource {
8836 /**
8837 * The Amazon Resource Name (ARN) of the source.
8838 */
8839 SourceArn: TrialSourceArn;
8840 /**
8841 * The source job type.
8842 */
8843 SourceType?: SourceType;
8844 }
8845 export type TrialSourceArn = string;
8846 export type TrialSummaries = TrialSummary[];
8847 export interface TrialSummary {
8848 /**
8849 * The Amazon Resource Name (ARN) of the trial.
8850 */
8851 TrialArn?: TrialArn;
8852 /**
8853 * The name of the trial.
8854 */
8855 TrialName?: ExperimentEntityName;
8856 /**
8857 * The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
8858 */
8859 DisplayName?: ExperimentEntityName;
8860 TrialSource?: TrialSource;
8861 /**
8862 * When the trial was created.
8863 */
8864 CreationTime?: Timestamp;
8865 /**
8866 * When the trial was last modified.
8867 */
8868 LastModifiedTime?: Timestamp;
8869 }
8870 export interface TuningJobCompletionCriteria {
8871 /**
8872 * The objective metric's value.
8873 */
8874 TargetObjectiveMetricValue: TargetObjectiveMetricValue;
8875 }
8876 export interface USD {
8877 /**
8878 * The whole number of dollars in the amount.
8879 */
8880 Dollars?: Dollars;
8881 /**
8882 * The fractional portion, in cents, of the amount.
8883 */
8884 Cents?: Cents;
8885 /**
8886 * Fractions of a cent, in tenths.
8887 */
8888 TenthFractionsOfACent?: TenthFractionsOfACent;
8889 }
8890 export interface UiConfig {
8891 /**
8892 * 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.
8893 */
8894 UiTemplateS3Uri: S3Uri;
8895 }
8896 export interface UiTemplate {
8897 /**
8898 * The content of the Liquid template for the worker user interface.
8899 */
8900 Content: TemplateContent;
8901 }
8902 export interface UiTemplateInfo {
8903 /**
8904 * The URL for the user interface template.
8905 */
8906 Url?: TemplateUrl;
8907 /**
8908 * The SHA-256 digest of the contents of the template.
8909 */
8910 ContentSha256?: TemplateContentSha256;
8911 }
8912 export interface UpdateCodeRepositoryInput {
8913 /**
8914 * The name of the Git repository to update.
8915 */
8916 CodeRepositoryName: EntityName;
8917 /**
8918 * 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}
8919 */
8920 GitConfig?: GitConfigForUpdate;
8921 }
8922 export interface UpdateCodeRepositoryOutput {
8923 /**
8924 * The ARN of the Git repository.
8925 */
8926 CodeRepositoryArn: CodeRepositoryArn;
8927 }
8928 export interface UpdateDomainRequest {
8929 /**
8930 * The domain ID.
8931 */
8932 DomainId: DomainId;
8933 /**
8934 * A collection of settings.
8935 */
8936 DefaultUserSettings?: UserSettings;
8937 }
8938 export interface UpdateDomainResponse {
8939 /**
8940 * The domain Amazon Resource Name (ARN).
8941 */
8942 DomainArn?: DomainArn;
8943 }
8944 export interface UpdateEndpointInput {
8945 /**
8946 * The name of the endpoint whose configuration you want to update.
8947 */
8948 EndpointName: EndpointName;
8949 /**
8950 * The name of the new endpoint configuration.
8951 */
8952 EndpointConfigName: EndpointConfigName;
8953 /**
8954 * When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false.
8955 */
8956 RetainAllVariantProperties?: Boolean;
8957 /**
8958 * When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
8959 */
8960 ExcludeRetainedVariantProperties?: VariantPropertyList;
8961 }
8962 export interface UpdateEndpointOutput {
8963 /**
8964 * The Amazon Resource Name (ARN) of the endpoint.
8965 */
8966 EndpointArn: EndpointArn;
8967 }
8968 export interface UpdateEndpointWeightsAndCapacitiesInput {
8969 /**
8970 * The name of an existing Amazon SageMaker endpoint.
8971 */
8972 EndpointName: EndpointName;
8973 /**
8974 * An object that provides new capacity and weight values for a variant.
8975 */
8976 DesiredWeightsAndCapacities: DesiredWeightAndCapacityList;
8977 }
8978 export interface UpdateEndpointWeightsAndCapacitiesOutput {
8979 /**
8980 * The Amazon Resource Name (ARN) of the updated endpoint.
8981 */
8982 EndpointArn: EndpointArn;
8983 }
8984 export interface UpdateExperimentRequest {
8985 /**
8986 * The name of the experiment to update.
8987 */
8988 ExperimentName: ExperimentEntityName;
8989 /**
8990 * The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.
8991 */
8992 DisplayName?: ExperimentEntityName;
8993 /**
8994 * The description of the experiment.
8995 */
8996 Description?: ExperimentDescription;
8997 }
8998 export interface UpdateExperimentResponse {
8999 /**
9000 * The Amazon Resource Name (ARN) of the experiment.
9001 */
9002 ExperimentArn?: ExperimentArn;
9003 }
9004 export interface UpdateMonitoringScheduleRequest {
9005 /**
9006 * The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.
9007 */
9008 MonitoringScheduleName: MonitoringScheduleName;
9009 /**
9010 * The configuration object that specifies the monitoring schedule and defines the monitoring job.
9011 */
9012 MonitoringScheduleConfig: MonitoringScheduleConfig;
9013 }
9014 export interface UpdateMonitoringScheduleResponse {
9015 /**
9016 * The Amazon Resource Name (ARN) of the monitoring schedule.
9017 */
9018 MonitoringScheduleArn: MonitoringScheduleArn;
9019 }
9020 export interface UpdateNotebookInstanceInput {
9021 /**
9022 * The name of the notebook instance to update.
9023 */
9024 NotebookInstanceName: NotebookInstanceName;
9025 /**
9026 * The Amazon ML compute instance type.
9027 */
9028 InstanceType?: InstanceType;
9029 /**
9030 * 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.
9031 */
9032 RoleArn?: RoleArn;
9033 /**
9034 * 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.
9035 */
9036 LifecycleConfigName?: NotebookInstanceLifecycleConfigName;
9037 /**
9038 * 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.
9039 */
9040 DisassociateLifecycleConfig?: DisassociateNotebookInstanceLifecycleConfig;
9041 /**
9042 * 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.
9043 */
9044 VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
9045 /**
9046 * 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.
9047 */
9048 DefaultCodeRepository?: CodeRepositoryNameOrUrl;
9049 /**
9050 * 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.
9051 */
9052 AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
9053 /**
9054 * 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.
9055 */
9056 AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
9057 /**
9058 * 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.
9059 */
9060 DisassociateAcceleratorTypes?: DisassociateNotebookInstanceAcceleratorTypes;
9061 /**
9062 * 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.
9063 */
9064 DisassociateDefaultCodeRepository?: DisassociateDefaultCodeRepository;
9065 /**
9066 * 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.
9067 */
9068 DisassociateAdditionalCodeRepositories?: DisassociateAdditionalCodeRepositories;
9069 /**
9070 * 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.
9071 */
9072 RootAccess?: RootAccess;
9073 }
9074 export interface UpdateNotebookInstanceLifecycleConfigInput {
9075 /**
9076 * The name of the lifecycle configuration.
9077 */
9078 NotebookInstanceLifecycleConfigName: NotebookInstanceLifecycleConfigName;
9079 /**
9080 * The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
9081 */
9082 OnCreate?: NotebookInstanceLifecycleConfigList;
9083 /**
9084 * 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.
9085 */
9086 OnStart?: NotebookInstanceLifecycleConfigList;
9087 }
9088 export interface UpdateNotebookInstanceLifecycleConfigOutput {
9089 }
9090 export interface UpdateNotebookInstanceOutput {
9091 }
9092 export interface UpdateTrialComponentRequest {
9093 /**
9094 * The name of the component to update.
9095 */
9096 TrialComponentName: ExperimentEntityName;
9097 /**
9098 * The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
9099 */
9100 DisplayName?: ExperimentEntityName;
9101 /**
9102 * The new status of the component.
9103 */
9104 Status?: TrialComponentStatus;
9105 /**
9106 * When the component started.
9107 */
9108 StartTime?: Timestamp;
9109 /**
9110 * When the component ended.
9111 */
9112 EndTime?: Timestamp;
9113 /**
9114 * Replaces all of the component's hyperparameters with the specified hyperparameters.
9115 */
9116 Parameters?: TrialComponentParameters;
9117 /**
9118 * The hyperparameters to remove from the component.
9119 */
9120 ParametersToRemove?: ListTrialComponentKey256;
9121 /**
9122 * Replaces all of the component's input artifacts with the specified artifacts.
9123 */
9124 InputArtifacts?: TrialComponentArtifacts;
9125 /**
9126 * The input artifacts to remove from the component.
9127 */
9128 InputArtifactsToRemove?: ListTrialComponentKey256;
9129 /**
9130 * Replaces all of the component's output artifacts with the specified artifacts.
9131 */
9132 OutputArtifacts?: TrialComponentArtifacts;
9133 /**
9134 * The output artifacts to remove from the component.
9135 */
9136 OutputArtifactsToRemove?: ListTrialComponentKey256;
9137 }
9138 export interface UpdateTrialComponentResponse {
9139 /**
9140 * The Amazon Resource Name (ARN) of the trial component.
9141 */
9142 TrialComponentArn?: TrialComponentArn;
9143 }
9144 export interface UpdateTrialRequest {
9145 /**
9146 * The name of the trial to update.
9147 */
9148 TrialName: ExperimentEntityName;
9149 /**
9150 * The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
9151 */
9152 DisplayName?: ExperimentEntityName;
9153 }
9154 export interface UpdateTrialResponse {
9155 /**
9156 * The Amazon Resource Name (ARN) of the trial.
9157 */
9158 TrialArn?: TrialArn;
9159 }
9160 export interface UpdateUserProfileRequest {
9161 /**
9162 * The domain ID.
9163 */
9164 DomainId: DomainId;
9165 /**
9166 * The user profile name.
9167 */
9168 UserProfileName: UserProfileName;
9169 /**
9170 * A collection of settings.
9171 */
9172 UserSettings?: UserSettings;
9173 }
9174 export interface UpdateUserProfileResponse {
9175 /**
9176 * The user profile Amazon Resource Name (ARN).
9177 */
9178 UserProfileArn?: UserProfileArn;
9179 }
9180 export interface UpdateWorkforceRequest {
9181 /**
9182 * The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.
9183 */
9184 WorkforceName: WorkforceName;
9185 /**
9186 * A list of one to four worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce. Maximum: Four CIDR values
9187 */
9188 SourceIpConfig?: SourceIpConfig;
9189 }
9190 export interface UpdateWorkforceResponse {
9191 /**
9192 * A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
9193 */
9194 Workforce: Workforce;
9195 }
9196 export interface UpdateWorkteamRequest {
9197 /**
9198 * The name of the work team to update.
9199 */
9200 WorkteamName: WorkteamName;
9201 /**
9202 * A list of MemberDefinition objects that contain the updated work team members.
9203 */
9204 MemberDefinitions?: MemberDefinitions;
9205 /**
9206 * An updated description for the work team.
9207 */
9208 Description?: String200;
9209 /**
9210 * Configures SNS topic notifications for available or expiring work items
9211 */
9212 NotificationConfiguration?: NotificationConfiguration;
9213 }
9214 export interface UpdateWorkteamResponse {
9215 /**
9216 * A Workteam object that describes the updated work team.
9217 */
9218 Workteam: Workteam;
9219 }
9220 export type Url = string;
9221 export interface UserContext {
9222 /**
9223 * The Amazon Resource Name (ARN) of the user's profile.
9224 */
9225 UserProfileArn?: String;
9226 /**
9227 * The name of the user's profile.
9228 */
9229 UserProfileName?: String;
9230 /**
9231 * The domain associated with the user.
9232 */
9233 DomainId?: String;
9234 }
9235 export type UserProfileArn = string;
9236 export interface UserProfileDetails {
9237 /**
9238 * The domain ID.
9239 */
9240 DomainId?: DomainId;
9241 /**
9242 * The user profile name.
9243 */
9244 UserProfileName?: UserProfileName;
9245 /**
9246 * The status.
9247 */
9248 Status?: UserProfileStatus;
9249 /**
9250 * The creation time.
9251 */
9252 CreationTime?: CreationTime;
9253 /**
9254 * The last modified time.
9255 */
9256 LastModifiedTime?: LastModifiedTime;
9257 }
9258 export type UserProfileList = UserProfileDetails[];
9259 export type UserProfileName = string;
9260 export type UserProfileSortKey = "CreationTime"|"LastModifiedTime"|string;
9261 export type UserProfileStatus = "Deleting"|"Failed"|"InService"|"Pending"|string;
9262 export interface UserSettings {
9263 /**
9264 * The execution role for the user.
9265 */
9266 ExecutionRole?: RoleArn;
9267 /**
9268 * The security groups.
9269 */
9270 SecurityGroups?: SecurityGroupIds;
9271 /**
9272 * The sharing settings.
9273 */
9274 SharingSettings?: SharingSettings;
9275 /**
9276 * The Jupyter server's app settings.
9277 */
9278 JupyterServerAppSettings?: JupyterServerAppSettings;
9279 /**
9280 * The kernel gateway app settings.
9281 */
9282 KernelGatewayAppSettings?: KernelGatewayAppSettings;
9283 /**
9284 * The TensorBoard app settings.
9285 */
9286 TensorBoardAppSettings?: TensorBoardAppSettings;
9287 }
9288 export type VariantName = string;
9289 export interface VariantProperty {
9290 /**
9291 * The type of variant property. The supported values are: DesiredInstanceCount: Overrides the existing variant instance counts using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants. DesiredWeight: Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight values in the CreateEndpointConfigInput$ProductionVariants. DataCaptureConfig: (Not currently supported.)
9292 */
9293 VariantPropertyType: VariantPropertyType;
9294 }
9295 export type VariantPropertyList = VariantProperty[];
9296 export type VariantPropertyType = "DesiredInstanceCount"|"DesiredWeight"|"DataCaptureConfig"|string;
9297 export type VariantWeight = number;
9298 export type VolumeSizeInGB = number;
9299 export interface VpcConfig {
9300 /**
9301 * The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
9302 */
9303 SecurityGroupIds: VpcSecurityGroupIds;
9304 /**
9305 * The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
9306 */
9307 Subnets: Subnets;
9308 }
9309 export type VpcId = string;
9310 export type VpcSecurityGroupIds = SecurityGroupId[];
9311 export interface Workforce {
9312 /**
9313 * The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.
9314 */
9315 WorkforceName: WorkforceName;
9316 /**
9317 * The Amazon Resource Name (ARN) of the private workforce.
9318 */
9319 WorkforceArn: WorkforceArn;
9320 /**
9321 * The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
9322 */
9323 LastUpdatedDate?: Timestamp;
9324 /**
9325 * A list of one to four IP address ranges (CIDRs) to be added to the workforce allow list.
9326 */
9327 SourceIpConfig?: SourceIpConfig;
9328 }
9329 export type WorkforceArn = string;
9330 export type WorkforceName = string;
9331 export interface Workteam {
9332 /**
9333 * The name of the work team.
9334 */
9335 WorkteamName: WorkteamName;
9336 /**
9337 * The Amazon Cognito user groups that make up the work team.
9338 */
9339 MemberDefinitions: MemberDefinitions;
9340 /**
9341 * The Amazon Resource Name (ARN) that identifies the work team.
9342 */
9343 WorkteamArn: WorkteamArn;
9344 /**
9345 * The Amazon Marketplace identifier for a vendor's work team.
9346 */
9347 ProductListingIds?: ProductListings;
9348 /**
9349 * A description of the work team.
9350 */
9351 Description: String200;
9352 /**
9353 * The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
9354 */
9355 SubDomain?: String;
9356 /**
9357 * The date and time that the work team was created (timestamp).
9358 */
9359 CreateDate?: Timestamp;
9360 /**
9361 * The date and time that the work team was last updated (timestamp).
9362 */
9363 LastUpdatedDate?: Timestamp;
9364 /**
9365 * Configures SNS notifications of available or expiring work items for work teams.
9366 */
9367 NotificationConfiguration?: NotificationConfiguration;
9368 }
9369 export type WorkteamArn = string;
9370 export type WorkteamName = string;
9371 export type Workteams = Workteam[];
9372 /**
9373 * 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.
9374 */
9375 export type apiVersion = "2017-07-24"|"latest"|string;
9376 export interface ClientApiVersions {
9377 /**
9378 * 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.
9379 */
9380 apiVersion?: apiVersion;
9381 }
9382 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
9383 /**
9384 * Contains interfaces for use with the SageMaker client.
9385 */
9386 export import Types = SageMaker;
9387}
9388export = SageMaker;