Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.
" }, "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsInput"}, "output":{"shape":"AddTagsOutput"}, "documentation":"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
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.
" }, "CreateAction":{ "name":"CreateAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateActionRequest"}, "output":{"shape":"CreateActionResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
" }, "CreateAlgorithm":{ "name":"CreateAlgorithm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAlgorithmInput"}, "output":{"shape":"CreateAlgorithmOutput"}, "documentation":"Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
" }, "CreateApp":{ "name":"CreateApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAppRequest"}, "output":{"shape":"CreateAppResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
" }, "CreateAppImageConfig":{ "name":"CreateAppImageConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAppImageConfigRequest"}, "output":{"shape":"CreateAppImageConfigResponse"}, "errors":[ {"shape":"ResourceInUse"} ], "documentation":"Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.
" }, "CreateArtifact":{ "name":"CreateArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateArtifactRequest"}, "output":{"shape":"CreateArtifactResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
" }, "CreateAutoMLJob":{ "name":"CreateAutoMLJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAutoMLJobRequest"}, "output":{"shape":"CreateAutoMLJobResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an Autopilot job.
Find the best performing model after you run an Autopilot job by calling . 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 Automate Model Development with Amazon SageMaker Autopilot.
" }, "CreateCodeRepository":{ "name":"CreateCodeRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCodeRepositoryInput"}, "output":{"shape":"CreateCodeRepositoryOutput"}, "documentation":"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.
" }, "CreateCompilationJob":{ "name":"CreateCompilationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCompilationJobRequest"}, "output":{"shape":"CreateCompilationJobResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "CreateContext":{ "name":"CreateContext", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateContextRequest"}, "output":{"shape":"CreateContextResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
" }, "CreateDataQualityJobDefinition":{ "name":"CreateDataQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
" }, "CreateDeviceFleet":{ "name":"CreateDeviceFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeviceFleetRequest"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a device fleet.
" }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) 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.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the AWS Key Management Service (AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
" }, "CreateEdgePackagingJob":{ "name":"CreateEdgePackagingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEdgePackagingJobRequest"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
" }, "CreateEndpoint":{ "name":"CreateEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEndpointInput"}, "output":{"shape":"CreateEndpointOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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 you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When 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.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full Amazon SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference.
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)).
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates an 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.
" }, "CreateFeatureGroup":{ "name":"CreateFeatureGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFeatureGroupRequest"}, "output":{"shape":"CreateFeatureGroupResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.
The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check AWS service quotas to see the FeatureGroups quota for your AWS account.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
Creates a flow definition.
" }, "CreateHumanTaskUi":{ "name":"CreateHumanTaskUi", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHumanTaskUiRequest"}, "output":{"shape":"CreateHumanTaskUiResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"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.
" }, "CreateHyperParameterTuningJob":{ "name":"CreateHyperParameterTuningJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHyperParameterTuningJobRequest"}, "output":{"shape":"CreateHyperParameterTuningJobResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.
" }, "CreateImageVersion":{ "name":"CreateImageVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageVersionRequest"}, "output":{"shape":"CreateImageVersionResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"} ], "documentation":"Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.
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.
You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.
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.
" }, "CreateModelBiasJobDefinition":{ "name":"CreateModelBiasJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateModelBiasJobDefinitionRequest"}, "output":{"shape":"CreateModelBiasJobDefinitionResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates the definition for a model bias job.
" }, "CreateModelExplainabilityJobDefinition":{ "name":"CreateModelExplainabilityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates the definition for a model explainability job.
" }, "CreateModelPackage":{ "name":"CreateModelPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateModelPackageInput"}, "output":{"shape":"CreateModelPackageOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace, or a versioned model that is part of a model group. 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.
There are two types of model packages:
Versioned - a model that is part of a model group in the model registry.
Unversioned - a model package that is not part of a model group.
Creates a model group. A model group contains a group of model versions.
" }, "CreateModelQualityJobDefinition":{ "name":"CreateModelQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
" }, "CreateMonitoringSchedule":{ "name":"CreateMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMonitoringScheduleRequest"}, "output":{"shape":"CreateMonitoringScheduleResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], "documentation":"Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.
" }, "CreateNotebookInstance":{ "name":"CreateNotebookInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNotebookInstanceInput"}, "output":{"shape":"CreateNotebookInstanceOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "CreateNotebookInstanceLifecycleConfig":{ "name":"CreateNotebookInstanceLifecycleConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNotebookInstanceLifecycleConfigInput"}, "output":{"shape":"CreateNotebookInstanceLifecycleConfigOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "CreatePipeline":{ "name":"CreatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ {"shape":"ResourceNotFound"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a pipeline using a JSON pipeline definition.
" }, "CreatePresignedDomainUrl":{ "name":"CreatePresignedDomainUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePresignedDomainUrlRequest"}, "output":{"shape":"CreatePresignedDomainUrlResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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 Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.
The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the AWS console sign-in page.
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.
The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
Creates a processing job.
" }, "CreateProject":{ "name":"CreateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProjectInput"}, "output":{"shape":"CreateProjectOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
" }, "CreateTrainingJob":{ "name":"CreateTrainingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTrainingJobRequest"}, "output":{"shape":"CreateTrainingJobResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"} ], "documentation":"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 inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by 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 Name (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.
" }, "CreateTransformJob":{ "name":"CreateTransformJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTransformJobRequest"}, "output":{"shape":"CreateTransformJobResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"} ], "documentation":"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.
" }, "CreateTrial":{ "name":"CreateTrial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTrialRequest"}, "output":{"shape":"CreateTrialResponse"}, "errors":[ {"shape":"ResourceNotFound"}, {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "CreateTrialComponent":{ "name":"CreateTrialComponent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTrialComponentRequest"}, "output":{"shape":"CreateTrialComponentResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
" }, "CreateWorkforce":{ "name":"CreateWorkforce", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkforceRequest"}, "output":{"shape":"CreateWorkforceResponse"}, "documentation":"Use this operation to create a workforce. This operation will return an error if a workforce already exists in the AWS Region that you specify. You can only create one workforce in each AWS Region per AWS account.
If you want to create a new workforce in an AWS Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
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.
" }, "DeleteAction":{ "name":"DeleteAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteActionRequest"}, "output":{"shape":"DeleteActionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes an action.
" }, "DeleteAlgorithm":{ "name":"DeleteAlgorithm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAlgorithmInput"}, "documentation":"Removes the specified algorithm from your account.
" }, "DeleteApp":{ "name":"DeleteApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAppRequest"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Used to stop and delete an app.
" }, "DeleteAppImageConfig":{ "name":"DeleteAppImageConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAppImageConfigRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes an AppImageConfig.
" }, "DeleteArtifact":{ "name":"DeleteArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteArtifactRequest"}, "output":{"shape":"DeleteArtifactResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes an artifact. Either ArtifactArn or Source must be specified.
Deletes an association.
" }, "DeleteCodeRepository":{ "name":"DeleteCodeRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCodeRepositoryInput"}, "documentation":"Deletes the specified Git repository from your account.
" }, "DeleteContext":{ "name":"DeleteContext", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteContextRequest"}, "output":{"shape":"DeleteContextResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes an context.
" }, "DeleteDataQualityJobDefinition":{ "name":"DeleteDataQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDataQualityJobDefinitionRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes a data quality monitoring job definition.
" }, "DeleteDeviceFleet":{ "name":"DeleteDeviceFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeviceFleetRequest"}, "errors":[ {"shape":"ResourceInUse"} ], "documentation":"Deletes a fleet.
" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDomainRequest"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard 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.
" }, "DeleteEndpoint":{ "name":"DeleteEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointInput"}, "documentation":"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.
" }, "DeleteEndpointConfig":{ "name":"DeleteEndpointConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointConfigInput"}, "documentation":"Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
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.
" }, "DeleteFeatureGroup":{ "name":"DeleteFeatureGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFeatureGroupRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The AWS Glue database and tables that are automatically created for your OfflineStore are not deleted.
Deletes the specified flow definition.
" }, "DeleteHumanTaskUi":{ "name":"DeleteHumanTaskUi", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteHumanTaskUiRequest"}, "output":{"shape":"DeleteHumanTaskUiResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
" }, "DeleteImageVersion":{ "name":"DeleteImageVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteImageVersionRequest"}, "output":{"shape":"DeleteImageVersionResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
" }, "DeleteModel":{ "name":"DeleteModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelInput"}, "documentation":"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.
Deletes an Amazon SageMaker model bias job definition.
" }, "DeleteModelExplainabilityJobDefinition":{ "name":"DeleteModelExplainabilityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelExplainabilityJobDefinitionRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes an Amazon SageMaker model explainability job definition.
" }, "DeleteModelPackage":{ "name":"DeleteModelPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelPackageInput"}, "errors":[ {"shape":"ConflictException"} ], "documentation":"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.
" }, "DeleteModelPackageGroup":{ "name":"DeleteModelPackageGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelPackageGroupInput"}, "documentation":"Deletes the specified model group.
" }, "DeleteModelPackageGroupPolicy":{ "name":"DeleteModelPackageGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelPackageGroupPolicyInput"}, "documentation":"Deletes a model group resource policy.
" }, "DeleteModelQualityJobDefinition":{ "name":"DeleteModelQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteModelQualityJobDefinitionRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes the secified model quality monitoring job definition.
" }, "DeleteMonitoringSchedule":{ "name":"DeleteMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMonitoringScheduleRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
" }, "DeleteNotebookInstance":{ "name":"DeleteNotebookInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNotebookInstanceInput"}, "documentation":" 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.
Deletes a notebook instance lifecycle configuration.
" }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Deletes a pipeline if there are no in-progress executions.
" }, "DeleteProject":{ "name":"DeleteProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProjectInput"}, "documentation":"Delete the specified project.
" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsInput"}, "output":{"shape":"DeleteTagsOutput"}, "documentation":"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.
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.
" }, "DeleteTrialComponent":{ "name":"DeleteTrialComponent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTrialComponentRequest"}, "output":{"shape":"DeleteTrialComponentResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
" }, "DeleteUserProfile":{ "name":"DeleteUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserProfileRequest"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
" }, "DeleteWorkforce":{ "name":"DeleteWorkforce", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWorkforceRequest"}, "output":{"shape":"DeleteWorkforceResponse"}, "documentation":"Use this operation to delete a workforce.
If you want to create a new workforce in an AWS Region where a workforce already exists, use this operation to delete the existing workforce and then use to create a new workforce.
If a private workforce contains one or more work teams, you must use the operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.
Deletes an existing work team. This operation can't be undone.
" }, "DeregisterDevices":{ "name":"DeregisterDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterDevicesRequest"}, "documentation":"Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
" }, "DescribeAction":{ "name":"DescribeAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActionRequest"}, "output":{"shape":"DescribeActionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes an action.
" }, "DescribeAlgorithm":{ "name":"DescribeAlgorithm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAlgorithmInput"}, "output":{"shape":"DescribeAlgorithmOutput"}, "documentation":"Returns a description of the specified algorithm that is in your account.
" }, "DescribeApp":{ "name":"DescribeApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAppRequest"}, "output":{"shape":"DescribeAppResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the app.
" }, "DescribeAppImageConfig":{ "name":"DescribeAppImageConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAppImageConfigRequest"}, "output":{"shape":"DescribeAppImageConfigResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes an AppImageConfig.
" }, "DescribeArtifact":{ "name":"DescribeArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeArtifactRequest"}, "output":{"shape":"DescribeArtifactResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes an artifact.
" }, "DescribeAutoMLJob":{ "name":"DescribeAutoMLJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutoMLJobRequest"}, "output":{"shape":"DescribeAutoMLJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns information about an Amazon SageMaker job.
" }, "DescribeCodeRepository":{ "name":"DescribeCodeRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCodeRepositoryInput"}, "output":{"shape":"DescribeCodeRepositoryOutput"}, "documentation":"Gets details about the specified Git repository.
" }, "DescribeCompilationJob":{ "name":"DescribeCompilationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCompilationJobRequest"}, "output":{"shape":"DescribeCompilationJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
" }, "DescribeContext":{ "name":"DescribeContext", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeContextRequest"}, "output":{"shape":"DescribeContextResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes a context.
" }, "DescribeDataQualityJobDefinition":{ "name":"DescribeDataQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDataQualityJobDefinitionRequest"}, "output":{"shape":"DescribeDataQualityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets the details of a data quality monitoring job definition.
" }, "DescribeDevice":{ "name":"DescribeDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeviceRequest"}, "output":{"shape":"DescribeDeviceResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the device.
" }, "DescribeDeviceFleet":{ "name":"DescribeDeviceFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeviceFleetRequest"}, "output":{"shape":"DescribeDeviceFleetResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"A description of the fleet the device belongs to.
" }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDomainRequest"}, "output":{"shape":"DescribeDomainResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"The description of the domain.
" }, "DescribeEdgePackagingJob":{ "name":"DescribeEdgePackagingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEdgePackagingJobRequest"}, "output":{"shape":"DescribeEdgePackagingJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"A description of edge packaging jobs.
" }, "DescribeEndpoint":{ "name":"DescribeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndpointInput"}, "output":{"shape":"DescribeEndpointOutput"}, "documentation":"Returns the description of an endpoint.
" }, "DescribeEndpointConfig":{ "name":"DescribeEndpointConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndpointConfigInput"}, "output":{"shape":"DescribeEndpointConfigOutput"}, "documentation":"Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Provides a list of an experiment's properties.
" }, "DescribeFeatureGroup":{ "name":"DescribeFeatureGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFeatureGroupRequest"}, "output":{"shape":"DescribeFeatureGroupResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.
Returns information about the specified flow definition.
" }, "DescribeHumanTaskUi":{ "name":"DescribeHumanTaskUi", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHumanTaskUiRequest"}, "output":{"shape":"DescribeHumanTaskUiResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns information about the requested human task user interface (worker task template).
" }, "DescribeHyperParameterTuningJob":{ "name":"DescribeHyperParameterTuningJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHyperParameterTuningJobRequest"}, "output":{"shape":"DescribeHyperParameterTuningJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets a description of a hyperparameter tuning job.
" }, "DescribeImage":{ "name":"DescribeImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageRequest"}, "output":{"shape":"DescribeImageResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes a SageMaker image.
" }, "DescribeImageVersion":{ "name":"DescribeImageVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageVersionRequest"}, "output":{"shape":"DescribeImageVersionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes a version of a SageMaker image.
" }, "DescribeLabelingJob":{ "name":"DescribeLabelingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLabelingJobRequest"}, "output":{"shape":"DescribeLabelingJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets information about a labeling job.
" }, "DescribeModel":{ "name":"DescribeModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeModelInput"}, "output":{"shape":"DescribeModelOutput"}, "documentation":"Describes a model that you created using the CreateModel API.
Returns a description of a model bias job definition.
" }, "DescribeModelExplainabilityJobDefinition":{ "name":"DescribeModelExplainabilityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeModelExplainabilityJobDefinitionRequest"}, "output":{"shape":"DescribeModelExplainabilityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns a description of a model explainability job definition.
" }, "DescribeModelPackage":{ "name":"DescribeModelPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeModelPackageInput"}, "output":{"shape":"DescribeModelPackageOutput"}, "documentation":"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.
" }, "DescribeModelPackageGroup":{ "name":"DescribeModelPackageGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeModelPackageGroupInput"}, "output":{"shape":"DescribeModelPackageGroupOutput"}, "documentation":"Gets a description for the specified model group.
" }, "DescribeModelQualityJobDefinition":{ "name":"DescribeModelQualityJobDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeModelQualityJobDefinitionRequest"}, "output":{"shape":"DescribeModelQualityJobDefinitionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns a description of a model quality job definition.
" }, "DescribeMonitoringSchedule":{ "name":"DescribeMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMonitoringScheduleRequest"}, "output":{"shape":"DescribeMonitoringScheduleResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the schedule for a monitoring job.
" }, "DescribeNotebookInstance":{ "name":"DescribeNotebookInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNotebookInstanceInput"}, "output":{"shape":"DescribeNotebookInstanceOutput"}, "documentation":"Returns information about a notebook instance.
" }, "DescribeNotebookInstanceLifecycleConfig":{ "name":"DescribeNotebookInstanceLifecycleConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNotebookInstanceLifecycleConfigInput"}, "output":{"shape":"DescribeNotebookInstanceLifecycleConfigOutput"}, "documentation":"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.
" }, "DescribePipeline":{ "name":"DescribePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePipelineRequest"}, "output":{"shape":"DescribePipelineResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the details of a pipeline.
" }, "DescribePipelineDefinitionForExecution":{ "name":"DescribePipelineDefinitionForExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePipelineDefinitionForExecutionRequest"}, "output":{"shape":"DescribePipelineDefinitionForExecutionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the details of an execution's pipeline definition.
" }, "DescribePipelineExecution":{ "name":"DescribePipelineExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePipelineExecutionRequest"}, "output":{"shape":"DescribePipelineExecutionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes the details of a pipeline execution.
" }, "DescribeProcessingJob":{ "name":"DescribeProcessingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProcessingJobRequest"}, "output":{"shape":"DescribeProcessingJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns a description of a processing job.
" }, "DescribeProject":{ "name":"DescribeProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProjectInput"}, "output":{"shape":"DescribeProjectOutput"}, "documentation":"Describes the details of a project.
" }, "DescribeSubscribedWorkteam":{ "name":"DescribeSubscribedWorkteam", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubscribedWorkteamRequest"}, "output":{"shape":"DescribeSubscribedWorkteamResponse"}, "documentation":"Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.
" }, "DescribeTrainingJob":{ "name":"DescribeTrainingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrainingJobRequest"}, "output":{"shape":"DescribeTrainingJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Returns information about a training job.
Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason, attributes like TrainingStartTime, TrainingTimeInSeconds, TrainingEndTime, and BillableTimeInSeconds may not be present in the response.
Returns information about a transform job.
" }, "DescribeTrial":{ "name":"DescribeTrial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrialRequest"}, "output":{"shape":"DescribeTrialResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Provides a list of a trial's properties.
" }, "DescribeTrialComponent":{ "name":"DescribeTrialComponent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrialComponentRequest"}, "output":{"shape":"DescribeTrialComponentResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Provides a list of a trials component's properties.
" }, "DescribeUserProfile":{ "name":"DescribeUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserProfileRequest"}, "output":{"shape":"DescribeUserProfileResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Describes a user profile. For more information, see CreateUserProfile.
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.
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).
" }, "DisableSagemakerServicecatalogPortfolio":{ "name":"DisableSagemakerServicecatalogPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableSagemakerServicecatalogPortfolioInput"}, "output":{"shape":"DisableSagemakerServicecatalogPortfolioOutput"}, "documentation":"Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" }, "DisassociateTrialComponent":{ "name":"DisassociateTrialComponent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateTrialComponentRequest"}, "output":{"shape":"DisassociateTrialComponentResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" }, "GetDeviceFleetReport":{ "name":"GetDeviceFleetReport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeviceFleetReportRequest"}, "output":{"shape":"GetDeviceFleetReportResponse"}, "documentation":"Describes a fleet.
" }, "GetModelPackageGroupPolicy":{ "name":"GetModelPackageGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetModelPackageGroupPolicyInput"}, "output":{"shape":"GetModelPackageGroupPolicyOutput"}, "documentation":"Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide..
" }, "GetSagemakerServicecatalogPortfolioStatus":{ "name":"GetSagemakerServicecatalogPortfolioStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSagemakerServicecatalogPortfolioStatusInput"}, "output":{"shape":"GetSagemakerServicecatalogPortfolioStatusOutput"}, "documentation":"Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
" }, "GetSearchSuggestions":{ "name":"GetSearchSuggestions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSearchSuggestionsRequest"}, "output":{"shape":"GetSearchSuggestionsResponse"}, "documentation":"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.
Lists the actions in your account and their properties.
" }, "ListAlgorithms":{ "name":"ListAlgorithms", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAlgorithmsInput"}, "output":{"shape":"ListAlgorithmsOutput"}, "documentation":"Lists the machine learning algorithms that have been created.
" }, "ListAppImageConfigs":{ "name":"ListAppImageConfigs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAppImageConfigsRequest"}, "output":{"shape":"ListAppImageConfigsResponse"}, "documentation":"Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.
" }, "ListApps":{ "name":"ListApps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAppsRequest"}, "output":{"shape":"ListAppsResponse"}, "documentation":"Lists apps.
" }, "ListArtifacts":{ "name":"ListArtifacts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListArtifactsRequest"}, "output":{"shape":"ListArtifactsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Lists the artifacts in your account and their properties.
" }, "ListAssociations":{ "name":"ListAssociations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociationsRequest"}, "output":{"shape":"ListAssociationsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Lists the associations in your account and their properties.
" }, "ListAutoMLJobs":{ "name":"ListAutoMLJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAutoMLJobsRequest"}, "output":{"shape":"ListAutoMLJobsResponse"}, "documentation":"Request a list of jobs.
" }, "ListCandidatesForAutoMLJob":{ "name":"ListCandidatesForAutoMLJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCandidatesForAutoMLJobRequest"}, "output":{"shape":"ListCandidatesForAutoMLJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"List the Candidates created for the job.
" }, "ListCodeRepositories":{ "name":"ListCodeRepositories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCodeRepositoriesInput"}, "output":{"shape":"ListCodeRepositoriesOutput"}, "documentation":"Gets a list of the Git repositories in your account.
" }, "ListCompilationJobs":{ "name":"ListCompilationJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCompilationJobsRequest"}, "output":{"shape":"ListCompilationJobsResponse"}, "documentation":"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.
" }, "ListContexts":{ "name":"ListContexts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListContextsRequest"}, "output":{"shape":"ListContextsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Lists the contexts in your account and their properties.
" }, "ListDataQualityJobDefinitions":{ "name":"ListDataQualityJobDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDataQualityJobDefinitionsRequest"}, "output":{"shape":"ListDataQualityJobDefinitionsResponse"}, "documentation":"Lists the data quality job definitions in your account.
" }, "ListDeviceFleets":{ "name":"ListDeviceFleets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeviceFleetsRequest"}, "output":{"shape":"ListDeviceFleetsResponse"}, "documentation":"Returns a list of devices in the fleet.
" }, "ListDevices":{ "name":"ListDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDevicesRequest"}, "output":{"shape":"ListDevicesResponse"}, "documentation":"A list of devices.
" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDomainsRequest"}, "output":{"shape":"ListDomainsResponse"}, "documentation":"Lists the domains.
" }, "ListEdgePackagingJobs":{ "name":"ListEdgePackagingJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEdgePackagingJobsRequest"}, "output":{"shape":"ListEdgePackagingJobsResponse"}, "documentation":"Returns a list of edge packaging jobs.
" }, "ListEndpointConfigs":{ "name":"ListEndpointConfigs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEndpointConfigsInput"}, "output":{"shape":"ListEndpointConfigsOutput"}, "documentation":"Lists endpoint configurations.
" }, "ListEndpoints":{ "name":"ListEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEndpointsInput"}, "output":{"shape":"ListEndpointsOutput"}, "documentation":"Lists endpoints.
" }, "ListExperiments":{ "name":"ListExperiments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExperimentsRequest"}, "output":{"shape":"ListExperimentsResponse"}, "documentation":"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.
" }, "ListFeatureGroups":{ "name":"ListFeatureGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFeatureGroupsRequest"}, "output":{"shape":"ListFeatureGroupsResponse"}, "documentation":"List FeatureGroups based on given filter and order.
Returns information about the flow definitions in your account.
" }, "ListHumanTaskUis":{ "name":"ListHumanTaskUis", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHumanTaskUisRequest"}, "output":{"shape":"ListHumanTaskUisResponse"}, "documentation":"Returns information about the human task user interfaces in your account.
" }, "ListHyperParameterTuningJobs":{ "name":"ListHyperParameterTuningJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHyperParameterTuningJobsRequest"}, "output":{"shape":"ListHyperParameterTuningJobsResponse"}, "documentation":"Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
" }, "ListImageVersions":{ "name":"ListImageVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListImageVersionsRequest"}, "output":{"shape":"ListImageVersionsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
" }, "ListImages":{ "name":"ListImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListImagesRequest"}, "output":{"shape":"ListImagesResponse"}, "documentation":"Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
" }, "ListLabelingJobs":{ "name":"ListLabelingJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLabelingJobsRequest"}, "output":{"shape":"ListLabelingJobsResponse"}, "documentation":"Gets a list of labeling jobs.
" }, "ListLabelingJobsForWorkteam":{ "name":"ListLabelingJobsForWorkteam", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLabelingJobsForWorkteamRequest"}, "output":{"shape":"ListLabelingJobsForWorkteamResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets a list of labeling jobs assigned to a specified work team.
" }, "ListModelBiasJobDefinitions":{ "name":"ListModelBiasJobDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelBiasJobDefinitionsRequest"}, "output":{"shape":"ListModelBiasJobDefinitionsResponse"}, "documentation":"Lists model bias jobs definitions that satisfy various filters.
" }, "ListModelExplainabilityJobDefinitions":{ "name":"ListModelExplainabilityJobDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelExplainabilityJobDefinitionsRequest"}, "output":{"shape":"ListModelExplainabilityJobDefinitionsResponse"}, "documentation":"Lists model explainability job definitions that satisfy various filters.
" }, "ListModelPackageGroups":{ "name":"ListModelPackageGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelPackageGroupsInput"}, "output":{"shape":"ListModelPackageGroupsOutput"}, "documentation":"Gets a list of the model groups in your AWS account.
" }, "ListModelPackages":{ "name":"ListModelPackages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelPackagesInput"}, "output":{"shape":"ListModelPackagesOutput"}, "documentation":"Lists the model packages that have been created.
" }, "ListModelQualityJobDefinitions":{ "name":"ListModelQualityJobDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelQualityJobDefinitionsRequest"}, "output":{"shape":"ListModelQualityJobDefinitionsResponse"}, "documentation":"Gets a list of model quality monitoring job definitions in your account.
" }, "ListModels":{ "name":"ListModels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListModelsInput"}, "output":{"shape":"ListModelsOutput"}, "documentation":"Lists models created with the CreateModel API.
" }, "ListMonitoringExecutions":{ "name":"ListMonitoringExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMonitoringExecutionsRequest"}, "output":{"shape":"ListMonitoringExecutionsResponse"}, "documentation":"Returns list of all monitoring job executions.
" }, "ListMonitoringSchedules":{ "name":"ListMonitoringSchedules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMonitoringSchedulesRequest"}, "output":{"shape":"ListMonitoringSchedulesResponse"}, "documentation":"Returns list of all monitoring schedules.
" }, "ListNotebookInstanceLifecycleConfigs":{ "name":"ListNotebookInstanceLifecycleConfigs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNotebookInstanceLifecycleConfigsInput"}, "output":{"shape":"ListNotebookInstanceLifecycleConfigsOutput"}, "documentation":"Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.
" }, "ListNotebookInstances":{ "name":"ListNotebookInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListNotebookInstancesInput"}, "output":{"shape":"ListNotebookInstancesOutput"}, "documentation":"Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.
" }, "ListPipelineExecutionSteps":{ "name":"ListPipelineExecutionSteps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPipelineExecutionStepsRequest"}, "output":{"shape":"ListPipelineExecutionStepsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets a list of PipeLineExecutionStep objects.
Gets a list of the pipeline executions.
" }, "ListPipelineParametersForExecution":{ "name":"ListPipelineParametersForExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPipelineParametersForExecutionRequest"}, "output":{"shape":"ListPipelineParametersForExecutionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Gets a list of parameters for a pipeline execution.
" }, "ListPipelines":{ "name":"ListPipelines", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPipelinesRequest"}, "output":{"shape":"ListPipelinesResponse"}, "documentation":"Gets a list of pipelines.
" }, "ListProcessingJobs":{ "name":"ListProcessingJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProcessingJobsRequest"}, "output":{"shape":"ListProcessingJobsResponse"}, "documentation":"Lists processing jobs that satisfy various filters.
" }, "ListProjects":{ "name":"ListProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProjectsInput"}, "output":{"shape":"ListProjectsOutput"}, "documentation":"Gets a list of the projects in an AWS account.
" }, "ListSubscribedWorkteams":{ "name":"ListSubscribedWorkteams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscribedWorkteamsRequest"}, "output":{"shape":"ListSubscribedWorkteamsResponse"}, "documentation":"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.
Returns the tags for the specified Amazon SageMaker resource.
" }, "ListTrainingJobs":{ "name":"ListTrainingJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTrainingJobsRequest"}, "output":{"shape":"ListTrainingJobsResponse"}, "documentation":"Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response. For example, if ListTrainingJobs is invoked with the following parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }
Then, 100 trainings jobs with any status including those other than InProgress are selected first (sorted according the creation time, from the latest to the oldest) and those with status InProgress are returned.
You can quickly test the API using the following AWS CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
" }, "ListTransformJobs":{ "name":"ListTransformJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTransformJobsRequest"}, "output":{"shape":"ListTransformJobsResponse"}, "documentation":"Lists transform jobs.
" }, "ListTrialComponents":{ "name":"ListTrialComponents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTrialComponentsRequest"}, "output":{"shape":"ListTrialComponentsResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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
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.
" }, "ListUserProfiles":{ "name":"ListUserProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUserProfilesRequest"}, "output":{"shape":"ListUserProfilesResponse"}, "documentation":"Lists user profiles.
" }, "ListWorkforces":{ "name":"ListWorkforces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWorkforcesRequest"}, "output":{"shape":"ListWorkforcesResponse"}, "documentation":"Use this operation to list all private and vendor workforces in an AWS Region. Note that you can only have one private workforce per AWS Region.
" }, "ListWorkteams":{ "name":"ListWorkteams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWorkteamsRequest"}, "output":{"shape":"ListWorkteamsResponse"}, "documentation":"Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide..
" }, "RegisterDevices":{ "name":"RegisterDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDevicesRequest"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Register devices.
" }, "RenderUiTemplate":{ "name":"RenderUiTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RenderUiTemplateRequest"}, "output":{"shape":"RenderUiTemplateResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Renders the UI template so that you can preview the worker's experience.
" }, "Search":{ "name":"Search", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchRequest"}, "output":{"shape":"SearchResponse"}, "documentation":"Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
" }, "StartMonitoringSchedule":{ "name":"StartMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartMonitoringScheduleRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Starts a previously stopped monitoring schedule.
By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.
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.
Starts a pipeline execution.
" }, "StopAutoMLJob":{ "name":"StopAutoMLJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopAutoMLJobRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"A method for forcing the termination of a running job.
" }, "StopCompilationJob":{ "name":"StopCompilationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopCompilationJobRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
Request to stop an edge packaging job.
" }, "StopHyperParameterTuningJob":{ "name":"StopHyperParameterTuningJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopHyperParameterTuningJobRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
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.
" }, "StopMonitoringSchedule":{ "name":"StopMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopMonitoringScheduleRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Stops a previously started monitoring schedule.
" }, "StopNotebookInstance":{ "name":"StopNotebookInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopNotebookInstanceInput"}, "documentation":"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.
Stops a pipeline execution.
" }, "StopProcessingJob":{ "name":"StopProcessingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopProcessingJobRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Stops a processing job.
" }, "StopTrainingJob":{ "name":"StopTrainingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopTrainingJobRequest"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"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.
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.
Updates an action.
" }, "UpdateAppImageConfig":{ "name":"UpdateAppImageConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAppImageConfigRequest"}, "output":{"shape":"UpdateAppImageConfigResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Updates the properties of an AppImageConfig.
" }, "UpdateArtifact":{ "name":"UpdateArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateArtifactRequest"}, "output":{"shape":"UpdateArtifactResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates an artifact.
" }, "UpdateCodeRepository":{ "name":"UpdateCodeRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCodeRepositoryInput"}, "output":{"shape":"UpdateCodeRepositoryOutput"}, "documentation":"Updates the specified Git repository with the specified values.
" }, "UpdateContext":{ "name":"UpdateContext", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateContextRequest"}, "output":{"shape":"UpdateContextResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates a context.
" }, "UpdateDeviceFleet":{ "name":"UpdateDeviceFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDeviceFleetRequest"}, "errors":[ {"shape":"ResourceInUse"} ], "documentation":"Updates a fleet of devices.
" }, "UpdateDevices":{ "name":"UpdateDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDevicesRequest"}, "documentation":"Updates one or more devices in a fleet.
" }, "UpdateDomain":{ "name":"UpdateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDomainRequest"}, "output":{"shape":"UpdateDomainResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates the default settings for new user profiles in the domain.
" }, "UpdateEndpoint":{ "name":"UpdateEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateEndpointInput"}, "output":{"shape":"UpdateEndpointOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
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.
Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
" }, "UpdateImage":{ "name":"UpdateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateImageRequest"}, "output":{"shape":"UpdateImageResponse"}, "errors":[ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.
" }, "UpdateModelPackage":{ "name":"UpdateModelPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateModelPackageInput"}, "output":{"shape":"UpdateModelPackageOutput"}, "documentation":"Updates a versioned model.
" }, "UpdateMonitoringSchedule":{ "name":"UpdateMonitoringSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMonitoringScheduleRequest"}, "output":{"shape":"UpdateMonitoringScheduleResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates a previously created schedule.
" }, "UpdateNotebookInstance":{ "name":"UpdateNotebookInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNotebookInstanceInput"}, "output":{"shape":"UpdateNotebookInstanceOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"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.
" }, "UpdateNotebookInstanceLifecycleConfig":{ "name":"UpdateNotebookInstanceLifecycleConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNotebookInstanceLifecycleConfigInput"}, "output":{"shape":"UpdateNotebookInstanceLifecycleConfigOutput"}, "errors":[ {"shape":"ResourceLimitExceeded"} ], "documentation":"Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
" }, "UpdatePipeline":{ "name":"UpdatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Updates a pipeline.
" }, "UpdatePipelineExecution":{ "name":"UpdatePipelineExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePipelineExecutionRequest"}, "output":{"shape":"UpdatePipelineExecutionResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Updates a pipeline execution.
" }, "UpdateTrainingJob":{ "name":"UpdateTrainingJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTrainingJobRequest"}, "output":{"shape":"UpdateTrainingJobResponse"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"Update a model training job to request a new Debugger profiling configuration.
" }, "UpdateTrial":{ "name":"UpdateTrial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTrialRequest"}, "output":{"shape":"UpdateTrialResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates the display name of a trial.
" }, "UpdateTrialComponent":{ "name":"UpdateTrialComponent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTrialComponentRequest"}, "output":{"shape":"UpdateTrialComponentResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates one or more properties of a trial component.
" }, "UpdateUserProfile":{ "name":"UpdateUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserProfileRequest"}, "output":{"shape":"UpdateUserProfileResponse"}, "errors":[ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], "documentation":"Updates a user profile.
" }, "UpdateWorkforce":{ "name":"UpdateWorkforce", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateWorkforceRequest"}, "output":{"shape":"UpdateWorkforceResponse"}, "documentation":"Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.
Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.
Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.
You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the operation.
After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the operation.
This operation only applies to private workforces.
Updates an existing work team with new member definitions or description.
" } }, "shapes":{ "Accept":{ "type":"string", "max":256, "pattern":".*" }, "AccountId":{ "type":"string", "pattern":"^\\d+$" }, "ActionArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*" }, "ActionSource":{ "type":"structure", "required":["SourceUri"], "members":{ "SourceUri":{ "shape":"String2048", "documentation":"The URI of the source.
" }, "SourceType":{ "shape":"String256", "documentation":"The type of the source.
" }, "SourceId":{ "shape":"String256", "documentation":"The ID of the source.
" } }, "documentation":"A structure describing the source of an action.
" }, "ActionStatus":{ "type":"string", "enum":[ "Unknown", "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "ActionSummaries":{ "type":"list", "member":{"shape":"ActionSummary"} }, "ActionSummary":{ "type":"structure", "members":{ "ActionArn":{ "shape":"ActionArn", "documentation":"The Amazon Resource Name (ARN) of the action.
" }, "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action.
" }, "Source":{ "shape":"ActionSource", "documentation":"The source of the action.
" }, "ActionType":{ "shape":"String64", "documentation":"The type of the action.
" }, "Status":{ "shape":"ActionStatus", "documentation":"The status of the action.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the action was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the action was last modified.
" } }, "documentation":"Lists the properties of an action. An action represents an action or activity. Some examples are a workflow step and a model deployment. Generally, an action involves at least one input artifact or output artifact.
" }, "AddAssociationRequest":{ "type":"structure", "required":[ "SourceArn", "DestinationArn" ], "members":{ "SourceArn":{ "shape":"AssociationEntityArn", "documentation":"The ARN of the source.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"The Amazon Resource Name (ARN) of the destination.
" }, "AssociationType":{ "shape":"AssociationEdgeType", "documentation":"The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.
ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.
AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.
DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.
Produced - The source generated the destination. For example, a training job produced a model artifact.
The ARN of the source.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"The Amazon Resource Name (ARN) of the destination.
" } } }, "AddTagsInput":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } } }, "AddTagsOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"A list of tags associated with the Amazon SageMaker resource.
" } } }, "AdditionalCodeRepositoryNamesOrUrls":{ "type":"list", "member":{"shape":"CodeRepositoryNameOrUrl"}, "max":3 }, "AgentVersion":{ "type":"structure", "required":[ "Version", "AgentCount" ], "members":{ "Version":{ "shape":"EdgeVersion", "documentation":"Version of the agent.
" }, "AgentCount":{ "shape":"Long", "documentation":"The number of Edge Manager agents.
" } }, "documentation":"Edge Manager agent version.
" }, "AgentVersions":{ "type":"list", "member":{"shape":"AgentVersion"} }, "Alarm":{ "type":"structure", "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"" } }, "documentation":"This API is not supported.
" }, "AlarmList":{ "type":"list", "member":{"shape":"Alarm"}, "max":10, "min":1 }, "AlarmName":{ "type":"string", "max":255, "min":1, "pattern":"^(?!\\s*$).+" }, "AlgorithmArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:algorithm/.*" }, "AlgorithmImage":{ "type":"string", "max":255, "pattern":".*" }, "AlgorithmSortBy":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "AlgorithmSpecification":{ "type":"structure", "required":["TrainingInputMode"], "members":{ "TrainingImage":{ "shape":"AlgorithmImage", "documentation":"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.
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.
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.
" }, "MetricDefinitions":{ "shape":"MetricDefinitionList", "documentation":"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.
" }, "EnableSageMakerMetricsTimeSeries":{ "shape":"Boolean", "documentation":"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 >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
Specifies the training algorithm to use in a CreateTrainingJob request.
For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
" }, "AlgorithmStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Completed", "Failed", "Deleting" ] }, "AlgorithmStatusDetails":{ "type":"structure", "members":{ "ValidationStatuses":{ "shape":"AlgorithmStatusItemList", "documentation":"The status of algorithm validation.
" }, "ImageScanStatuses":{ "shape":"AlgorithmStatusItemList", "documentation":"The status of the scan of the algorithm's Docker image container.
" } }, "documentation":"Specifies the validation and image scan statuses of the algorithm.
" }, "AlgorithmStatusItem":{ "type":"structure", "required":[ "Name", "Status" ], "members":{ "Name":{ "shape":"EntityName", "documentation":"The name of the algorithm for which the overall status is being reported.
" }, "Status":{ "shape":"DetailedAlgorithmStatus", "documentation":"The current status.
" }, "FailureReason":{ "shape":"String", "documentation":"if the overall status is Failed, the reason for the failure.
Represents the overall status of an algorithm.
" }, "AlgorithmStatusItemList":{ "type":"list", "member":{"shape":"AlgorithmStatusItem"} }, "AlgorithmSummary":{ "type":"structure", "required":[ "AlgorithmName", "AlgorithmArn", "CreationTime", "AlgorithmStatus" ], "members":{ "AlgorithmName":{ "shape":"EntityName", "documentation":"The name of the algorithm that is described by the summary.
" }, "AlgorithmArn":{ "shape":"AlgorithmArn", "documentation":"The Amazon Resource Name (ARN) of the algorithm.
" }, "AlgorithmDescription":{ "shape":"EntityDescription", "documentation":"A brief description of the algorithm.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp that shows when the algorithm was created.
" }, "AlgorithmStatus":{ "shape":"AlgorithmStatus", "documentation":"The overall status of the algorithm.
" } }, "documentation":"Provides summary information about an algorithm.
" }, "AlgorithmSummaryList":{ "type":"list", "member":{"shape":"AlgorithmSummary"} }, "AlgorithmValidationProfile":{ "type":"structure", "required":[ "ProfileName", "TrainingJobDefinition" ], "members":{ "ProfileName":{ "shape":"EntityName", "documentation":"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).
" }, "TrainingJobDefinition":{ "shape":"TrainingJobDefinition", "documentation":"The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.
The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.
Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
" }, "AlgorithmValidationProfiles":{ "type":"list", "member":{"shape":"AlgorithmValidationProfile"}, "max":1, "min":1 }, "AlgorithmValidationSpecification":{ "type":"structure", "required":[ "ValidationRole", "ValidationProfiles" ], "members":{ "ValidationRole":{ "shape":"RoleArn", "documentation":"The IAM roles that Amazon SageMaker uses to run the training jobs.
" }, "ValidationProfiles":{ "shape":"AlgorithmValidationProfiles", "documentation":"An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.
Specifies configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
" }, "AnnotationConsolidationConfig":{ "type":"structure", "required":["AnnotationConsolidationLambdaArn"], "members":{ "AnnotationConsolidationLambdaArn":{ "shape":"LambdaFunctionArn", "documentation":"The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.
This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.
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.
rn: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
Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass
Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection
Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking
3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection
3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation
Use the following ARNs for Label Verification and Adjustment Jobs
Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .
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
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
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
Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection
Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking
3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection
3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.
arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation
Configures how labels are consolidated across human workers and processes output data.
" }, "AppArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*" }, "AppDetails":{ "type":"structure", "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "AppType":{ "shape":"AppType", "documentation":"The type of app.
" }, "AppName":{ "shape":"AppName", "documentation":"The name of the app.
" }, "Status":{ "shape":"AppStatus", "documentation":"The status.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" } }, "documentation":"Details about an Amazon SageMaker app.
" }, "AppImageConfigArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*" }, "AppImageConfigDetails":{ "type":"structure", "members":{ "AppImageConfigArn":{ "shape":"AppImageConfigArn", "documentation":"The Amazon Resource Name (ARN) of the AppImageConfig.
" }, "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig. Must be unique to your account.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the AppImageConfig was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the AppImageConfig was last modified.
" }, "KernelGatewayImageConfig":{ "shape":"KernelGatewayImageConfig", "documentation":"The configuration for the file system and kernels in the SageMaker image.
" } }, "documentation":"The configuration for running a SageMaker image as a KernelGateway app.
" }, "AppImageConfigList":{ "type":"list", "member":{"shape":"AppImageConfigDetails"} }, "AppImageConfigName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "AppImageConfigSortKey":{ "type":"string", "enum":[ "CreationTime", "LastModifiedTime", "Name" ] }, "AppInstanceType":{ "type":"string", "enum":[ "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" ] }, "AppList":{ "type":"list", "member":{"shape":"AppDetails"} }, "AppManaged":{"type":"boolean"}, "AppName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "AppNetworkAccessType":{ "type":"string", "enum":[ "PublicInternetOnly", "VpcOnly" ] }, "AppSortKey":{ "type":"string", "enum":["CreationTime"] }, "AppSpecification":{ "type":"structure", "required":["ImageUri"], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The container image to be run by the processing job.
" }, "ContainerEntrypoint":{ "shape":"ContainerEntrypoint", "documentation":"The entrypoint for a container used to run a processing job.
" }, "ContainerArguments":{ "shape":"ContainerArguments", "documentation":"The arguments for a container used to run a processing job.
" } }, "documentation":"Configuration to run a processing job in a specified container image.
" }, "AppStatus":{ "type":"string", "enum":[ "Deleted", "Deleting", "Failed", "InService", "Pending" ] }, "AppType":{ "type":"string", "enum":[ "JupyterServer", "KernelGateway", "TensorBoard" ] }, "ApprovalDescription":{ "type":"string", "max":1024, "pattern":".*" }, "ArnOrName":{ "type":"string", "max":170, "min":1, "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The URI of the source." }, "SourceTypes":{ "shape":"ArtifactSourceTypes", "documentation":"A list of source types.
" } }, "documentation":"A structure describing the source of an artifact.
" }, "ArtifactSourceIdType":{ "type":"string", "enum":[ "MD5Hash", "S3ETag", "S3Version", "Custom" ] }, "ArtifactSourceType":{ "type":"structure", "required":[ "SourceIdType", "Value" ], "members":{ "SourceIdType":{ "shape":"ArtifactSourceIdType", "documentation":"The type of ID.
" }, "Value":{ "shape":"String256", "documentation":"The ID.
" } }, "documentation":"The ID and ID type of an artifact source.
" }, "ArtifactSourceTypes":{ "type":"list", "member":{"shape":"ArtifactSourceType"} }, "ArtifactSummaries":{ "type":"list", "member":{"shape":"ArtifactSummary"} }, "ArtifactSummary":{ "type":"structure", "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact.
" }, "ArtifactName":{ "shape":"ExperimentEntityName", "documentation":"The name of the artifact.
" }, "Source":{ "shape":"ArtifactSource", "documentation":"The source of the artifact.
" }, "ArtifactType":{ "shape":"String256", "documentation":"The type of the artifact.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the artifact was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the artifact was last modified.
" } }, "documentation":"Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.
" }, "AssemblyType":{ "type":"string", "enum":[ "None", "Line" ] }, "AssociateTrialComponentRequest":{ "type":"structure", "required":[ "TrialComponentName", "TrialName" ], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component to associated with the trial.
" }, "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial to associate with.
" } } }, "AssociateTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The ARN of the trial component.
" }, "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" } } }, "AssociationEdgeType":{ "type":"string", "enum":[ "ContributedTo", "AssociatedWith", "DerivedFrom", "Produced" ] }, "AssociationEntityArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*" }, "AssociationSummaries":{ "type":"list", "member":{"shape":"AssociationSummary"} }, "AssociationSummary":{ "type":"structure", "members":{ "SourceArn":{ "shape":"AssociationEntityArn", "documentation":"The ARN of the source.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"The Amazon Resource Name (ARN) of the destination.
" }, "SourceType":{ "shape":"String256", "documentation":"The source type.
" }, "DestinationType":{ "shape":"String256", "documentation":"The destination type.
" }, "AssociationType":{ "shape":"AssociationEdgeType", "documentation":"The type of the association.
" }, "SourceName":{ "shape":"ExperimentEntityName", "documentation":"The name of the source.
" }, "DestinationName":{ "shape":"ExperimentEntityName", "documentation":"The name of the destination.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the association was created.
" }, "CreatedBy":{"shape":"UserContext"} }, "documentation":"Lists a summary of the properties of an association. An association is an entity that links other lineage or experiment entities. An example would be an association between a training job and a model.
" }, "AthenaCatalog":{ "type":"string", "documentation":"The name of the data catalog used in Athena query execution.
", "max":256, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "AthenaDatabase":{ "type":"string", "documentation":"The name of the database used in the Athena query execution.
", "max":255, "min":1, "pattern":".*" }, "AthenaDatasetDefinition":{ "type":"structure", "required":[ "Catalog", "Database", "QueryString", "OutputS3Uri", "OutputFormat" ], "members":{ "Catalog":{"shape":"AthenaCatalog"}, "Database":{"shape":"AthenaDatabase"}, "QueryString":{"shape":"AthenaQueryString"}, "WorkGroup":{"shape":"AthenaWorkGroup"}, "OutputS3Uri":{ "shape":"S3Uri", "documentation":"The location in Amazon S3 where Athena query results are stored.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
" }, "OutputFormat":{"shape":"AthenaResultFormat"}, "OutputCompression":{"shape":"AthenaResultCompressionType"} }, "documentation":"Configuration for Athena Dataset Definition input.
" }, "AthenaQueryString":{ "type":"string", "documentation":"The SQL query statements, to be executed.
", "max":4096, "min":1, "pattern":"[\\s\\S]+" }, "AthenaResultCompressionType":{ "type":"string", "documentation":"The compression used for Athena query results.
", "enum":[ "GZIP", "SNAPPY", "ZLIB" ] }, "AthenaResultFormat":{ "type":"string", "documentation":"The data storage format for Athena query results.
", "enum":[ "PARQUET", "ORC", "AVRO", "JSON", "TEXTFILE" ] }, "AthenaWorkGroup":{ "type":"string", "documentation":"The name of the workgroup in which the Athena query is being started.
", "max":128, "min":1, "pattern":"[a-zA-Z0-9._-]+" }, "AttributeName":{ "type":"string", "max":256, "min":1, "pattern":".+" }, "AttributeNames":{ "type":"list", "member":{"shape":"AttributeName"}, "max":16 }, "AuthMode":{ "type":"string", "enum":[ "SSO", "IAM" ] }, "AutoMLCandidate":{ "type":"structure", "required":[ "CandidateName", "ObjectiveStatus", "CandidateSteps", "CandidateStatus", "CreationTime", "LastModifiedTime" ], "members":{ "CandidateName":{ "shape":"CandidateName", "documentation":"The candidate name.
" }, "FinalAutoMLJobObjectiveMetric":{"shape":"FinalAutoMLJobObjectiveMetric"}, "ObjectiveStatus":{ "shape":"ObjectiveStatus", "documentation":"The objective status.
" }, "CandidateSteps":{ "shape":"CandidateSteps", "documentation":"The candidate's steps.
" }, "CandidateStatus":{ "shape":"CandidateStatus", "documentation":"The candidate's status.
" }, "InferenceContainers":{ "shape":"AutoMLContainerDefinitions", "documentation":"The inference containers.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The creation time.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"The end time.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last modified time.
" }, "FailureReason":{ "shape":"AutoMLFailureReason", "documentation":"The failure reason.
" } }, "documentation":"An Autopilot job returns recommendations, or candidates. Each candidate has futher details about the steps involed, and the status.
" }, "AutoMLCandidateStep":{ "type":"structure", "required":[ "CandidateStepType", "CandidateStepArn", "CandidateStepName" ], "members":{ "CandidateStepType":{ "shape":"CandidateStepType", "documentation":"Whether the Candidate is at the transform, training, or processing step.
" }, "CandidateStepArn":{ "shape":"CandidateStepArn", "documentation":"The ARN for the Candidate's step.
" }, "CandidateStepName":{ "shape":"CandidateStepName", "documentation":"The name for the Candidate's step.
" } }, "documentation":"Information about the steps for a Candidate, and what step it is working on.
" }, "AutoMLCandidates":{ "type":"list", "member":{"shape":"AutoMLCandidate"} }, "AutoMLChannel":{ "type":"structure", "required":[ "DataSource", "TargetAttributeName" ], "members":{ "DataSource":{ "shape":"AutoMLDataSource", "documentation":"The data source.
" }, "CompressionType":{ "shape":"CompressionType", "documentation":"You can use Gzip or None. The default value is None.
" }, "TargetAttributeName":{ "shape":"TargetAttributeName", "documentation":"The name of the target variable in supervised learning, a.k.a. 'y'.
" } }, "documentation":"Similar to Channel. A channel is a named input source that training algorithms can consume. Refer to Channel for detailed descriptions.
" }, "AutoMLContainerDefinition":{ "type":"structure", "required":[ "Image", "ModelDataUrl" ], "members":{ "Image":{ "shape":"ContainerImage", "documentation":"The ECR path of the container. Refer to ContainerDefinition for more details.
" }, "ModelDataUrl":{ "shape":"Url", "documentation":"The location of the model artifacts. Refer to ContainerDefinition for more details.
" }, "Environment":{ "shape":"EnvironmentMap", "documentation":"Environment variables to set in the container. Refer to ContainerDefinition for more details.
" } }, "documentation":"A list of container definitions that describe the different containers that make up one AutoML candidate. Refer to ContainerDefinition for more details.
" }, "AutoMLContainerDefinitions":{ "type":"list", "member":{"shape":"AutoMLContainerDefinition"}, "max":5 }, "AutoMLDataSource":{ "type":"structure", "required":["S3DataSource"], "members":{ "S3DataSource":{ "shape":"AutoMLS3DataSource", "documentation":"The Amazon S3 location of the input data.
The input data must be in CSV format and contain at least 500 rows.
The data source for the Autopilot job.
" }, "AutoMLFailureReason":{ "type":"string", "max":1024 }, "AutoMLInputDataConfig":{ "type":"list", "member":{"shape":"AutoMLChannel"}, "max":20, "min":1 }, "AutoMLJobArn":{ "type":"string", "max":256, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:automl-job/.*" }, "AutoMLJobArtifacts":{ "type":"structure", "members":{ "CandidateDefinitionNotebookLocation":{ "shape":"CandidateDefinitionNotebookLocation", "documentation":"The URL to the notebook location.
" }, "DataExplorationNotebookLocation":{ "shape":"DataExplorationNotebookLocation", "documentation":"The URL to the notebook location.
" } }, "documentation":"Artifacts that are generation during a job.
" }, "AutoMLJobCompletionCriteria":{ "type":"structure", "members":{ "MaxCandidates":{ "shape":"MaxCandidates", "documentation":"The maximum number of times a training job is allowed to run.
" }, "MaxRuntimePerTrainingJobInSeconds":{ "shape":"MaxRuntimePerTrainingJobInSeconds", "documentation":"The maximum time, in seconds, a job is allowed to run.
" }, "MaxAutoMLJobRuntimeInSeconds":{ "shape":"MaxAutoMLJobRuntimeInSeconds", "documentation":"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.
" } }, "documentation":"How long a job is allowed to run, or how many candidates a job is allowed to generate.
" }, "AutoMLJobConfig":{ "type":"structure", "members":{ "CompletionCriteria":{ "shape":"AutoMLJobCompletionCriteria", "documentation":"How long a job is allowed to run, or how many candidates a job is allowed to generate.
" }, "SecurityConfig":{ "shape":"AutoMLSecurityConfig", "documentation":"Security configuration for traffic encryption or Amazon VPC settings.
" } }, "documentation":"A collection of settings used for a job.
" }, "AutoMLJobName":{ "type":"string", "max":32, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" }, "AutoMLJobObjective":{ "type":"structure", "required":["MetricName"], "members":{ "MetricName":{ "shape":"AutoMLMetricEnum", "documentation":"The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.
Here are the options:
MSE: The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive, the better a model is at predicting the actual values the smaller the MSE value. When the data contains outliers, they tend to dominate the MSE which might cause subpar prediction performance.
Accuracy: The ratio of the number correctly classified items to the total number (correctly and incorrectly) classified. It is used for binary and multiclass classification. Measures how close the predicted class values are to the actual values. Accuracy values vary between zero and one, one being perfect accuracy and zero perfect inaccuracy.
F1: The F1 score is the harmonic mean of the precision and recall. It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class; false when they do not. Precision is the ratio of the true positive predictions to all positive predictions (including the false positives) in a data set and measures the quality of the prediction when it predicts the positive class. Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances and measures how completely a model predicts the actual class members in a data set. The standard F1 score weighs precision and recall equally. But which metric is paramount typically depends on specific aspects of a problem. F1 scores vary between zero and one, one being the best possible performance and zero the worst.
AUC: The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms such as logistic regression that return probabilities. A threshold is needed to map the probabilities into classifications. The relevant curve is the receiver operating characteristic curve that plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives but more false negatives. AUC is the area under this receiver operating characteristic curve and so provides an aggregated measure of the model performance across all possible classification thresholds. The AUC score can also be interpreted as the probability that a randomly selected positive data point is more likely to be predicted positive than a randomly selected negative example. AUC scores vary between zero and one, one being perfect accuracy and one half not better than a random classifier. Values less that one half predict worse than a random predictor and such consistently bad predictors can be inverted to obtain better than random predictors.
F1macro: The F1macro score applies F1 scoring to multiclass classification. In this context, you have multiple classes to predict. You just calculate the precision and recall for each class as you did for the positive class in binary classification. Then used these values to calculate the F1 score for each class and average them to obtain the F1macro score. F1macro scores vary between zero and one, one being the best possible performance and zero the worst.
If you do not specify a metric explicitly, the default behavior is to automatically use:
MSE: for regression.
F1: for binary classification
Accuracy: for multiclass classification.
Specifies a metric to minimize or maximize as the objective of a job.
" }, "AutoMLJobObjectiveType":{ "type":"string", "enum":[ "Maximize", "Minimize" ] }, "AutoMLJobSecondaryStatus":{ "type":"string", "enum":[ "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated" ] }, "AutoMLJobStatus":{ "type":"string", "enum":[ "Completed", "InProgress", "Failed", "Stopped", "Stopping" ] }, "AutoMLJobSummaries":{ "type":"list", "member":{"shape":"AutoMLJobSummary"} }, "AutoMLJobSummary":{ "type":"structure", "required":[ "AutoMLJobName", "AutoMLJobArn", "AutoMLJobStatus", "AutoMLJobSecondaryStatus", "CreationTime", "LastModifiedTime" ], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"The name of the object you are requesting.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The ARN of the job.
" }, "AutoMLJobStatus":{ "shape":"AutoMLJobStatus", "documentation":"The job's status.
" }, "AutoMLJobSecondaryStatus":{ "shape":"AutoMLJobSecondaryStatus", "documentation":"The job's secondary status.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the job was created.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"The end time of an AutoML job.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the job was last modified.
" }, "FailureReason":{ "shape":"AutoMLFailureReason", "documentation":"The failure reason of a job.
" } }, "documentation":"Provides a summary about a job.
" }, "AutoMLMaxResults":{ "type":"integer", "max":100, "min":1 }, "AutoMLMetricEnum":{ "type":"string", "enum":[ "Accuracy", "MSE", "F1", "F1macro", "AUC" ] }, "AutoMLNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9\\-]+" }, "AutoMLOutputDataConfig":{ "type":"structure", "required":["S3OutputPath"], "members":{ "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS KMS encryption key ID.
" }, "S3OutputPath":{ "shape":"S3Uri", "documentation":"The Amazon S3 output path. Must be 128 characters or less.
" } }, "documentation":"The output data configuration.
" }, "AutoMLS3DataSource":{ "type":"structure", "required":[ "S3DataType", "S3Uri" ], "members":{ "S3DataType":{ "shape":"AutoMLS3DataType", "documentation":"The data type.
" }, "S3Uri":{ "shape":"S3Uri", "documentation":"The URL to the Amazon S3 data source.
" } }, "documentation":"The Amazon S3 data source.
" }, "AutoMLS3DataType":{ "type":"string", "enum":[ "ManifestFile", "S3Prefix" ] }, "AutoMLSecurityConfig":{ "type":"structure", "members":{ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"The key used to encrypt stored data.
" }, "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", "documentation":"Whether to use traffic encryption between the container layers.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"VPC configuration.
" } }, "documentation":"Security options.
" }, "AutoMLSortBy":{ "type":"string", "enum":[ "Name", "CreationTime", "Status" ] }, "AutoMLSortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "AutoRollbackConfig":{ "type":"structure", "members":{ "Alarms":{ "shape":"AlarmList", "documentation":"" } }, "documentation":"Currently, the AutoRollbackConfig API is not supported.
The bias report for a model
" } }, "documentation":"Contains bias metrics for a model.
" }, "BillableTimeInSeconds":{ "type":"integer", "min":1 }, "BlockedReason":{ "type":"string", "max":1024 }, "BlueGreenUpdatePolicy":{ "type":"structure", "required":["TrafficRoutingConfiguration"], "members":{ "TrafficRoutingConfiguration":{ "shape":"TrafficRoutingConfig", "documentation":"" }, "TerminationWaitInSeconds":{ "shape":"TerminationWaitInSeconds", "documentation":"" }, "MaximumExecutionTimeoutInSeconds":{ "shape":"MaximumExecutionTimeoutInSeconds", "documentation":"" } }, "documentation":"Currently, the BlueGreenUpdatePolicy API is not supported.
The Amazon Resource Name (ARN) of the pipeline execution.
" } }, "documentation":"Details on the cache hit of a pipeline execution step.
" }, "CandidateDefinitionNotebookLocation":{ "type":"string", "min":1 }, "CandidateName":{ "type":"string", "max":64, "min":1 }, "CandidateSortBy":{ "type":"string", "enum":[ "CreationTime", "Status", "FinalObjectiveMetricValue" ] }, "CandidateStatus":{ "type":"string", "enum":[ "Completed", "InProgress", "Failed", "Stopped", "Stopping" ] }, "CandidateStepArn":{ "type":"string", "max":256, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*/.*" }, "CandidateStepName":{ "type":"string", "max":64, "min":1 }, "CandidateStepType":{ "type":"string", "enum":[ "AWS::SageMaker::TrainingJob", "AWS::SageMaker::TransformJob", "AWS::SageMaker::ProcessingJob" ] }, "CandidateSteps":{ "type":"list", "member":{"shape":"AutoMLCandidateStep"} }, "CapacitySize":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"CapacitySizeType", "documentation":"This API is not supported.
" }, "Value":{ "shape":"CapacitySizeValue", "documentation":"" } }, "documentation":"Currently, the CapacitySize API is not supported.
The name of the categorical hyperparameter to tune.
" }, "Values":{ "shape":"ParameterValues", "documentation":"A list of the categories for the hyperparameter.
" } }, "documentation":"A list of categorical hyperparameters to tune.
" }, "CategoricalParameterRangeSpecification":{ "type":"structure", "required":["Values"], "members":{ "Values":{ "shape":"ParameterValues", "documentation":"The allowed categories for the hyperparameter.
" } }, "documentation":"Defines the possible values for a categorical hyperparameter.
" }, "CategoricalParameterRanges":{ "type":"list", "member":{"shape":"CategoricalParameterRange"}, "max":20, "min":0 }, "Cents":{ "type":"integer", "max":99, "min":0 }, "CertifyForMarketplace":{"type":"boolean"}, "Channel":{ "type":"structure", "required":[ "ChannelName", "DataSource" ], "members":{ "ChannelName":{ "shape":"ChannelName", "documentation":"The name of the channel.
" }, "DataSource":{ "shape":"DataSource", "documentation":"The location of the channel data.
" }, "ContentType":{ "shape":"ContentType", "documentation":"The MIME type of the data.
" }, "CompressionType":{ "shape":"CompressionType", "documentation":"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.
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.
" }, "InputMode":{ "shape":"TrainingInputMode", "documentation":"(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.
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.
A channel is a named input source that training algorithms can consume.
" }, "ChannelName":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9\\.\\-_]+" }, "ChannelSpecification":{ "type":"structure", "required":[ "Name", "SupportedContentTypes", "SupportedInputModes" ], "members":{ "Name":{ "shape":"ChannelName", "documentation":"The name of the channel.
" }, "Description":{ "shape":"EntityDescription", "documentation":"A brief description of the channel.
" }, "IsRequired":{ "shape":"Boolean", "documentation":"Indicates whether the channel is required by the algorithm.
" }, "SupportedContentTypes":{ "shape":"ContentTypes", "documentation":"The supported MIME types for the data.
" }, "SupportedCompressionTypes":{ "shape":"CompressionTypes", "documentation":"The allowed compression types, if data compression is used.
" }, "SupportedInputModes":{ "shape":"InputModes", "documentation":"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.
" } }, "documentation":"Defines a named input source, called a channel, to be used by an algorithm.
" }, "ChannelSpecifications":{ "type":"list", "member":{"shape":"ChannelSpecification"}, "max":8, "min":1 }, "CheckpointConfig":{ "type":"structure", "required":["S3Uri"], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
Contains information about the output location for managed spot training checkpoint data.
" }, "Cidr":{ "type":"string", "max":64, "min":4, "pattern":"(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)" }, "Cidrs":{ "type":"list", "member":{"shape":"Cidr"} }, "ClientId":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+-]+" }, "ClientSecret":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+=/-]+", "sensitive":true }, "ClientToken":{ "type":"string", "max":36, "min":1, "pattern":"^[a-zA-Z0-9-]+$" }, "CodeRepositoryArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:code-repository/.*" }, "CodeRepositoryContains":{ "type":"string", "max":1024, "pattern":"[a-zA-Z0-9-]+" }, "CodeRepositoryNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "CodeRepositoryNameOrUrl":{ "type":"string", "max":1024, "min":1, "pattern":"^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "CodeRepositorySortBy":{ "type":"string", "enum":[ "Name", "CreationTime", "LastModifiedTime" ] }, "CodeRepositorySortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "CodeRepositorySummary":{ "type":"structure", "required":[ "CodeRepositoryName", "CodeRepositoryArn", "CreationTime", "LastModifiedTime" ], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"The name of the Git repository.
" }, "CodeRepositoryArn":{ "shape":"CodeRepositoryArn", "documentation":"The Amazon Resource Name (ARN) of the Git repository.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The date and time that the Git repository was created.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The date and time that the Git repository was last modified.
" }, "GitConfig":{ "shape":"GitConfig", "documentation":"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.
" } }, "documentation":"Specifies summary information about a Git repository.
" }, "CodeRepositorySummaryList":{ "type":"list", "member":{"shape":"CodeRepositorySummary"} }, "CognitoConfig":{ "type":"structure", "required":[ "UserPool", "ClientId" ], "members":{ "UserPool":{ "shape":"CognitoUserPool", "documentation":"A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.
" }, "ClientId":{ "shape":"ClientId", "documentation":"The client ID for your Amazon Cognito user pool.
" } }, "documentation":"Use this parameter to configure your Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
" }, "CognitoMemberDefinition":{ "type":"structure", "required":[ "UserPool", "UserGroup", "ClientId" ], "members":{ "UserPool":{ "shape":"CognitoUserPool", "documentation":"An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
" }, "UserGroup":{ "shape":"CognitoUserGroup", "documentation":"An identifier for a user group.
" }, "ClientId":{ "shape":"ClientId", "documentation":"An identifier for an application client. You must create the app client ID using Amazon Cognito.
" } }, "documentation":"Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.
" }, "CognitoUserGroup":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "CognitoUserPool":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+_[0-9a-zA-Z]+" }, "CollectionConfiguration":{ "type":"structure", "members":{ "CollectionName":{ "shape":"CollectionName", "documentation":"The name of the tensor collection. The name must be unique relative to other rule configuration names.
" }, "CollectionParameters":{ "shape":"CollectionParameters", "documentation":"Parameter values for the tensor collection. The allowed parameters are \"name\", \"include_regex\", \"reduction_config\", \"save_config\", \"tensor_names\", and \"save_histogram\".
Configuration information for the Debugger output tensor collections.
" }, "CollectionConfigurations":{ "type":"list", "member":{"shape":"CollectionConfiguration"}, "max":20, "min":0 }, "CollectionName":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "CollectionParameters":{ "type":"map", "key":{"shape":"ConfigKey"}, "value":{"shape":"ConfigValue"}, "max":20, "min":0 }, "CompilationJobArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*" }, "CompilationJobStatus":{ "type":"string", "enum":[ "INPROGRESS", "COMPLETED", "FAILED", "STARTING", "STOPPING", "STOPPED" ] }, "CompilationJobSummaries":{ "type":"list", "member":{"shape":"CompilationJobSummary"} }, "CompilationJobSummary":{ "type":"structure", "required":[ "CompilationJobName", "CompilationJobArn", "CreationTime", "CompilationJobStatus" ], "members":{ "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the model compilation job that you want a summary for.
" }, "CompilationJobArn":{ "shape":"CompilationJobArn", "documentation":"The Amazon Resource Name (ARN) of the model compilation job.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time when the model compilation job was created.
" }, "CompilationStartTime":{ "shape":"Timestamp", "documentation":"The time when the model compilation job started.
" }, "CompilationEndTime":{ "shape":"Timestamp", "documentation":"The time when the model compilation job completed.
" }, "CompilationTargetDevice":{ "shape":"TargetDevice", "documentation":"The type of device that the model will run on after the compilation job has completed.
" }, "CompilationTargetPlatformOs":{ "shape":"TargetPlatformOs", "documentation":"The type of OS that the model will run on after the compilation job has completed.
" }, "CompilationTargetPlatformArch":{ "shape":"TargetPlatformArch", "documentation":"The type of architecture that the model will run on after the compilation job has completed.
" }, "CompilationTargetPlatformAccelerator":{ "shape":"TargetPlatformAccelerator", "documentation":"The type of accelerator that the model will run on after the compilation job has completed.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The time when the model compilation job was last modified.
" }, "CompilationJobStatus":{ "shape":"CompilationJobStatus", "documentation":"The status of the model compilation job.
" } }, "documentation":"A summary of a model compilation job.
" }, "CompilerOptions":{ "type":"string", "max":1024, "min":3, "pattern":".*" }, "CompressionType":{ "type":"string", "enum":[ "None", "Gzip" ] }, "CompressionTypes":{ "type":"list", "member":{"shape":"CompressionType"} }, "ConditionOutcome":{ "type":"string", "enum":[ "True", "False" ] }, "ConditionStepMetadata":{ "type":"structure", "members":{ "Outcome":{ "shape":"ConditionOutcome", "documentation":"The outcome of the Condition step evaluation.
" } }, "documentation":"Metadata for a Condition step.
" }, "ConfigKey":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "ConfigValue":{ "type":"string", "max":256, "pattern":".*" }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"FailureReason"} }, "documentation":"There was a conflict when you attempted to modify an experiment, trial, or trial component.
", "exception":true }, "ContainerArgument":{ "type":"string", "max":256, "pattern":".*" }, "ContainerArguments":{ "type":"list", "member":{"shape":"ContainerArgument"}, "max":100, "min":1 }, "ContainerDefinition":{ "type":"structure", "members":{ "ContainerHostname":{ "shape":"ContainerHostname", "documentation":"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.
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. 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
Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers
" }, "Mode":{ "shape":"ContainerMode", "documentation":"Whether the container hosts a single model or multiple models.
" }, "ModelDataUrl":{ "shape":"Url", "documentation":"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.
The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.
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.
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.
The name or Amazon Resource Name (ARN) of the model package to use to create the model.
" }, "MultiModelConfig":{ "shape":"MultiModelConfig", "documentation":"Specifies additional configuration for multi-model endpoints.
" } }, "documentation":"Describes the container, as part of model definition.
" }, "ContainerDefinitionList":{ "type":"list", "member":{"shape":"ContainerDefinition"}, "max":5 }, "ContainerEntrypoint":{ "type":"list", "member":{"shape":"ContainerEntrypointString"}, "max":100, "min":1 }, "ContainerEntrypointString":{ "type":"string", "max":256, "pattern":".*" }, "ContainerHostname":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "ContainerImage":{ "type":"string", "max":255, "pattern":"[\\S]+" }, "ContainerMode":{ "type":"string", "enum":[ "SingleModel", "MultiModel" ] }, "ContentClassifier":{ "type":"string", "enum":[ "FreeOfPersonallyIdentifiableInformation", "FreeOfAdultContent" ] }, "ContentClassifiers":{ "type":"list", "member":{"shape":"ContentClassifier"}, "max":256 }, "ContentDigest":{ "type":"string", "max":72, "pattern":"^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" }, "ContentType":{ "type":"string", "max":256, "pattern":".*" }, "ContentTypes":{ "type":"list", "member":{"shape":"ContentType"} }, "ContextArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*" }, "ContextSource":{ "type":"structure", "required":["SourceUri"], "members":{ "SourceUri":{ "shape":"String2048", "documentation":"The URI of the source.
" }, "SourceType":{ "shape":"String256", "documentation":"The type of the source.
" }, "SourceId":{ "shape":"String256", "documentation":"The ID of the source.
" } }, "documentation":"A structure describing the source of a context.
" }, "ContextSummaries":{ "type":"list", "member":{"shape":"ContextSummary"} }, "ContextSummary":{ "type":"structure", "members":{ "ContextArn":{ "shape":"ContextArn", "documentation":"The Amazon Resource Name (ARN) of the context.
" }, "ContextName":{ "shape":"ExperimentEntityName", "documentation":"The name of the context.
" }, "Source":{ "shape":"ContextSource", "documentation":"The source of the context.
" }, "ContextType":{ "shape":"String256", "documentation":"The type of the context.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the context was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the context was last modified.
" } }, "documentation":"Lists a summary of the properties of a context. A context provides a logical grouping of other entities.
" }, "ContinuousParameterRange":{ "type":"structure", "required":[ "Name", "MinValue", "MaxValue" ], "members":{ "Name":{ "shape":"ParameterKey", "documentation":"The name of the continuous hyperparameter to tune.
" }, "MinValue":{ "shape":"ParameterValue", "documentation":"The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.
The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.
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:
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
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.
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<=x<1.0.
A list of continuous hyperparameters to tune.
" }, "ContinuousParameterRangeSpecification":{ "type":"structure", "required":[ "MinValue", "MaxValue" ], "members":{ "MinValue":{ "shape":"ParameterValue", "documentation":"The minimum floating-point value allowed.
" }, "MaxValue":{ "shape":"ParameterValue", "documentation":"The maximum floating-point value allowed.
" } }, "documentation":"Defines the possible values for a continuous hyperparameter.
" }, "ContinuousParameterRanges":{ "type":"list", "member":{"shape":"ContinuousParameterRange"}, "max":20, "min":0 }, "CreateActionRequest":{ "type":"structure", "required":[ "ActionName", "Source", "ActionType" ], "members":{ "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action. Must be unique to your account in an AWS Region.
" }, "Source":{ "shape":"ActionSource", "documentation":"The source type, ID, and URI.
" }, "ActionType":{ "shape":"String256", "documentation":"The action type.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The description of the action.
" }, "Status":{ "shape":"ActionStatus", "documentation":"The status of the action.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of properties to add to the action.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the action.
" } } }, "CreateActionResponse":{ "type":"structure", "members":{ "ActionArn":{ "shape":"ActionArn", "documentation":"The Amazon Resource Name (ARN) of the action.
" } } }, "CreateAlgorithmInput":{ "type":"structure", "required":[ "AlgorithmName", "TrainingSpecification" ], "members":{ "AlgorithmName":{ "shape":"EntityName", "documentation":"The name of the algorithm.
" }, "AlgorithmDescription":{ "shape":"EntityDescription", "documentation":"A description of the algorithm.
" }, "TrainingSpecification":{ "shape":"TrainingSpecification", "documentation":"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.
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.
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.
" }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", "documentation":"Whether to certify the algorithm so that it can be listed in AWS Marketplace.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } } }, "CreateAlgorithmOutput":{ "type":"structure", "required":["AlgorithmArn"], "members":{ "AlgorithmArn":{ "shape":"AlgorithmArn", "documentation":"The Amazon Resource Name (ARN) of the new algorithm.
" } } }, "CreateAppImageConfigRequest":{ "type":"structure", "required":["AppImageConfigName"], "members":{ "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig. Must be unique to your account.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the AppImageConfig.
" }, "KernelGatewayImageConfig":{ "shape":"KernelGatewayImageConfig", "documentation":"The KernelGatewayImageConfig.
" } } }, "CreateAppImageConfigResponse":{ "type":"structure", "members":{ "AppImageConfigArn":{ "shape":"AppImageConfigArn", "documentation":"The Amazon Resource Name (ARN) of the AppImageConfig.
" } } }, "CreateAppRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName", "AppType", "AppName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "AppType":{ "shape":"AppType", "documentation":"The type of app.
" }, "AppName":{ "shape":"AppName", "documentation":"The name of the app.
" }, "Tags":{ "shape":"TagList", "documentation":"Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" }, "ResourceSpec":{ "shape":"ResourceSpec", "documentation":"The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" } } }, "CreateAppResponse":{ "type":"structure", "members":{ "AppArn":{ "shape":"AppArn", "documentation":"The Amazon Resource Name (ARN) of the app.
" } } }, "CreateArtifactRequest":{ "type":"structure", "required":[ "Source", "ArtifactType" ], "members":{ "ArtifactName":{ "shape":"ExperimentEntityName", "documentation":"The name of the artifact. Must be unique to your account in an AWS Region.
" }, "Source":{ "shape":"ArtifactSource", "documentation":"The ID, ID type, and URI of the source.
" }, "ArtifactType":{ "shape":"String256", "documentation":"The artifact type.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of properties to add to the artifact.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the artifact.
" } } }, "CreateArtifactResponse":{ "type":"structure", "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact.
" } } }, "CreateAutoMLJobRequest":{ "type":"structure", "required":[ "AutoMLJobName", "InputDataConfig", "OutputDataConfig", "RoleArn" ], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"Identifies an Autopilot job. Must be unique to your account and is case-insensitive.
" }, "InputDataConfig":{ "shape":"AutoMLInputDataConfig", "documentation":"Similar to InputDataConfig supported by Tuning. Format(s) supported: CSV. Minimum of 500 rows.
" }, "OutputDataConfig":{ "shape":"AutoMLOutputDataConfig", "documentation":"Similar to OutputDataConfig supported by Tuning. Format(s) supported: CSV.
" }, "ProblemType":{ "shape":"ProblemType", "documentation":"Defines the kind of preprocessing and algorithms intended for the candidates. Options include: BinaryClassification, MulticlassClassification, and Regression.
" }, "AutoMLJobObjective":{ "shape":"AutoMLJobObjective", "documentation":"Defines the objective of a an AutoML job. You provide a AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it. If a metric is not specified, the most commonly used ObjectiveMetric for problem type is automaically selected.
" }, "AutoMLJobConfig":{ "shape":"AutoMLJobConfig", "documentation":"Contains CompletionCriteria and SecurityConfig.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the role that is used to access the data.
" }, "GenerateCandidateDefinitionsOnly":{ "shape":"GenerateCandidateDefinitionsOnly", "documentation":"Generates possible candidates without training a model. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
" }, "Tags":{ "shape":"TagList", "documentation":"Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" } } }, "CreateAutoMLJobResponse":{ "type":"structure", "required":["AutoMLJobArn"], "members":{ "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"When a job is created, it is assigned a unique ARN.
" } } }, "CreateCodeRepositoryInput":{ "type":"structure", "required":[ "CodeRepositoryName", "GitConfig" ], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"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).
" }, "GitConfig":{ "shape":"GitConfig", "documentation":"Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } } }, "CreateCodeRepositoryOutput":{ "type":"structure", "required":["CodeRepositoryArn"], "members":{ "CodeRepositoryArn":{ "shape":"CodeRepositoryArn", "documentation":"The Amazon Resource Name (ARN) of the new repository.
" } } }, "CreateCompilationJobRequest":{ "type":"structure", "required":[ "CompilationJobName", "RoleArn", "InputConfig", "OutputConfig", "StoppingCondition" ], "members":{ "CompilationJobName":{ "shape":"EntityName", "documentation":"A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
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.
" }, "OutputConfig":{ "shape":"OutputConfig", "documentation":"Provides information about the output location for the compiled model and the target device the model runs on.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } } }, "CreateCompilationJobResponse":{ "type":"structure", "required":["CompilationJobArn"], "members":{ "CompilationJobArn":{ "shape":"CompilationJobArn", "documentation":"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.
The name of the context. Must be unique to your account in an AWS Region.
" }, "Source":{ "shape":"ContextSource", "documentation":"The source type, ID, and URI.
" }, "ContextType":{ "shape":"String256", "documentation":"The context type.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The description of the context.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of properties to add to the context.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the context.
" } } }, "CreateContextResponse":{ "type":"structure", "members":{ "ContextArn":{ "shape":"ContextArn", "documentation":"The Amazon Resource Name (ARN) of the context.
" } } }, "CreateDataQualityJobDefinitionRequest":{ "type":"structure", "required":[ "JobDefinitionName", "DataQualityAppSpecification", "DataQualityJobInput", "DataQualityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name for the monitoring job definition.
" }, "DataQualityBaselineConfig":{ "shape":"DataQualityBaselineConfig", "documentation":"Configures the constraints and baselines for the monitoring job.
" }, "DataQualityAppSpecification":{ "shape":"DataQualityAppSpecification", "documentation":"Specifies the container that runs the monitoring job.
" }, "DataQualityJobInput":{ "shape":"DataQualityJobInput", "documentation":"A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
" }, "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Specifies networking configuration for the monitoring job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateDataQualityJobDefinitionResponse":{ "type":"structure", "required":["JobDefinitionArn"], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the job definition.
" } } }, "CreateDeviceFleetRequest":{ "type":"structure", "required":[ "DeviceFleetName", "OutputConfig" ], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet that the device belongs to.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
" }, "Description":{ "shape":"DeviceFleetDescription", "documentation":"A description of the fleet.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"The output configuration for storing sample data collected by the fleet.
" }, "Tags":{ "shape":"TagList", "documentation":"Creates tags for the specified fleet.
" } } }, "CreateDomainRequest":{ "type":"structure", "required":[ "DomainName", "AuthMode", "DefaultUserSettings", "SubnetIds", "VpcId" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"A name for the domain.
" }, "AuthMode":{ "shape":"AuthMode", "documentation":"The mode of authentication that members use to access the domain.
" }, "DefaultUserSettings":{ "shape":"UserSettings", "documentation":"The default user settings.
" }, "SubnetIds":{ "shape":"Subnets", "documentation":"The VPC subnets that Studio uses for communication.
" }, "VpcId":{ "shape":"VpcId", "documentation":"The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
" }, "Tags":{ "shape":"TagList", "documentation":"Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
" }, "AppNetworkAccessType":{ "shape":"AppNetworkAccessType", "documentation":"Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
This member is deprecated and replaced with KmsKeyId.
SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK.
" } } }, "CreateDomainResponse":{ "type":"structure", "members":{ "DomainArn":{ "shape":"DomainArn", "documentation":"The Amazon Resource Name (ARN) of the created domain.
" }, "Url":{ "shape":"String1024", "documentation":"The URL to the created domain.
" } } }, "CreateEdgePackagingJobRequest":{ "type":"structure", "required":[ "EdgePackagingJobName", "CompilationJobName", "ModelName", "ModelVersion", "RoleArn", "OutputConfig" ], "members":{ "EdgePackagingJobName":{ "shape":"EntityName", "documentation":"The name of the edge packaging job.
" }, "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
" }, "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The version of the model.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"Provides information about the output location for the packaged model.
" }, "ResourceKey":{ "shape":"KmsKeyId", "documentation":"The CMK to use when encrypting the EBS volume the edge packaging job runs on.
" }, "Tags":{ "shape":"TagList", "documentation":"Creates tags for the packaging job.
" } } }, "CreateEndpointConfigInput":{ "type":"structure", "required":[ "EndpointConfigName", "ProductionVariants" ], "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
" }, "ProductionVariants":{ "shape":"ProductionVariantList", "documentation":"An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
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 Tagging AWS Resources.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
The Amazon Resource Name (ARN) of the endpoint configuration.
" } } }, "CreateEndpointInput":{ "type":"structure", "required":[ "EndpointName", "EndpointConfigName" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in .
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } } }, "CreateEndpointOutput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint.
" } } }, "CreateExperimentRequest":{ "type":"structure", "required":["ExperimentName"], "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"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.
The description of the experiment.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of tags to associate with the experiment. You can use Search API to search on the tags.
" } } }, "CreateExperimentResponse":{ "type":"structure", "members":{ "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment.
" } } }, "CreateFeatureGroupRequest":{ "type":"structure", "required":[ "FeatureGroupName", "RecordIdentifierFeatureName", "EventTimeFeatureName", "FeatureDefinitions" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupName", "documentation":"The name of the FeatureGroup. The name must be unique within an AWS Region in an AWS account. The name:
Must start and end with an alphanumeric character.
Can only contain alphanumeric character and hyphens. Spaces are not allowed.
The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.
You use the RecordIdentifierFeatureName to access data in a FeatureStore.
This name:
Must start and end with an alphanumeric character.
Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.
An EventTime can be a String or Fractional.
Fractional: EventTime feature values must be a Unix timestamp in seconds.
String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.
A list of Feature names and types. Name and Type is compulsory per Feature.
Valid feature FeatureTypes are Integral, Fractional and String.
FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time
You can create up to 2,500 FeatureDefinitions per FeatureGroup.
You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig; the default value is False.
You can also include an AWS KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.
Use this to configure an OfflineFeatureStore. This parameter allows you to specify:
The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.
A configuration for an AWS Glue or AWS Hive data cataolgue.
An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore.
To learn more about this parameter, see OfflineStoreConfig.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
A free-form description of a FeatureGroup.
Tags used to identify Features in each FeatureGroup.
The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.
The name of your flow definition.
" }, "HumanLoopRequestSource":{ "shape":"HumanLoopRequestSource", "documentation":"Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" }, "HumanLoopActivationConfig":{ "shape":"HumanLoopActivationConfig", "documentation":"An object containing information about the events that trigger a human workflow.
" }, "HumanLoopConfig":{ "shape":"HumanLoopConfig", "documentation":"An object containing information about the tasks the human reviewers will perform.
" }, "OutputConfig":{ "shape":"FlowDefinitionOutputConfig", "documentation":"An object containing information about where the human review results will be uploaded.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
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.
" } } }, "CreateFlowDefinitionResponse":{ "type":"structure", "required":["FlowDefinitionArn"], "members":{ "FlowDefinitionArn":{ "shape":"FlowDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the flow definition you create.
" } } }, "CreateHumanTaskUiRequest":{ "type":"structure", "required":[ "HumanTaskUiName", "UiTemplate" ], "members":{ "HumanTaskUiName":{ "shape":"HumanTaskUiName", "documentation":"The name of the user interface you are creating.
" }, "UiTemplate":{"shape":"UiTemplate"}, "Tags":{ "shape":"TagList", "documentation":"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.
" } } }, "CreateHumanTaskUiResponse":{ "type":"structure", "required":["HumanTaskUiArn"], "members":{ "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The Amazon Resource Name (ARN) of the human review workflow user interface you create.
" } } }, "CreateHyperParameterTuningJobRequest":{ "type":"structure", "required":[ "HyperParameterTuningJobName", "HyperParameterTuningJobConfig" ], "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"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 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.
" }, "HyperParameterTuningJobConfig":{ "shape":"HyperParameterTuningJobConfig", "documentation":"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.
" }, "TrainingJobDefinition":{ "shape":"HyperParameterTrainingJobDefinition", "documentation":"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.
" }, "TrainingJobDefinitions":{ "shape":"HyperParameterTrainingJobDefinitions", "documentation":"A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
" }, "WarmStartConfig":{ "shape":"HyperParameterTuningJobWarmStartConfig", "documentation":"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.
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 Tagging AWS Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
" } } }, "CreateHyperParameterTuningJobResponse":{ "type":"structure", "required":["HyperParameterTuningJobArn"], "members":{ "HyperParameterTuningJobArn":{ "shape":"HyperParameterTuningJobArn", "documentation":"The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
" } } }, "CreateImageRequest":{ "type":"structure", "required":[ "ImageName", "RoleArn" ], "members":{ "Description":{ "shape":"ImageDescription", "documentation":"The description of the image.
" }, "DisplayName":{ "shape":"ImageDisplayName", "documentation":"The display name of the image. If not provided, ImageName is displayed.
The name of the image. Must be unique to your account.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the image.
" } } }, "CreateImageResponse":{ "type":"structure", "members":{ "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image.
" } } }, "CreateImageVersionRequest":{ "type":"structure", "required":[ "BaseImage", "ClientToken", "ImageName" ], "members":{ "BaseImage":{ "shape":"ImageBaseImage", "documentation":"The registry path of the container image to use as the starting point for this version. The path is an Amazon Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
A unique ID. If not specified, the AWS CLI and AWS SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
", "idempotencyToken":true }, "ImageName":{ "shape":"ImageName", "documentation":"The ImageName of the Image to create a version of.
The Amazon Resource Name (ARN) of the image version.
" } } }, "CreateLabelingJobRequest":{ "type":"structure", "required":[ "LabelingJobName", "LabelAttributeName", "InputConfig", "OutputConfig", "RoleArn", "HumanTaskConfig" ], "members":{ "LabelingJobName":{ "shape":"LabelingJobName", "documentation":"The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an AWS account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.
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 LabelAttributeName must meet the following requirements.
The name can't end with \"-metadata\".
If you are using one of the following built-in task types, the attribute name must end with \"-ref\". If the task type you are using is not listed below, the attribute name must not end with \"-ref\".
Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.
Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.
Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.
3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.
3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.
If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.
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.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.
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.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
" }, "LabelCategoryConfigS3Uri":{ "shape":"S3Uri", "documentation":"The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.
For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
{
\"document-version\": \"2018-11-28\",
\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]
}
Note the following about the label category configuration file:
For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.
Each label category must be unique, you cannot specify duplicate label categories.
If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.
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.
" }, "LabelingJobAlgorithmsConfig":{ "shape":"LabelingJobAlgorithmsConfig", "documentation":"Configures the information required to perform automated data labeling.
" }, "HumanTaskConfig":{ "shape":"HumanTaskConfig", "documentation":"Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
" }, "Tags":{ "shape":"TagList", "documentation":"An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateLabelingJobResponse":{ "type":"structure", "required":["LabelingJobArn"], "members":{ "LabelingJobArn":{ "shape":"LabelingJobArn", "documentation":"The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.
" } } }, "CreateModelBiasJobDefinitionRequest":{ "type":"structure", "required":[ "JobDefinitionName", "ModelBiasAppSpecification", "ModelBiasJobInput", "ModelBiasJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the bias job definition. The name must be unique within an AWS Region in the AWS account.
" }, "ModelBiasBaselineConfig":{ "shape":"ModelBiasBaselineConfig", "documentation":"The baseline configuration for a model bias job.
" }, "ModelBiasAppSpecification":{ "shape":"ModelBiasAppSpecification", "documentation":"Configures the model bias job to run a specified Docker container image.
" }, "ModelBiasJobInput":{ "shape":"ModelBiasJobInput", "documentation":"Inputs for the model bias job.
" }, "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Networking options for a model bias job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateModelBiasJobDefinitionResponse":{ "type":"structure", "required":["JobDefinitionArn"], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model bias job.
" } } }, "CreateModelExplainabilityJobDefinitionRequest":{ "type":"structure", "required":[ "JobDefinitionName", "ModelExplainabilityAppSpecification", "ModelExplainabilityJobInput", "ModelExplainabilityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account.
" }, "ModelExplainabilityBaselineConfig":{ "shape":"ModelExplainabilityBaselineConfig", "documentation":"The baseline configuration for a model explainability job.
" }, "ModelExplainabilityAppSpecification":{ "shape":"ModelExplainabilityAppSpecification", "documentation":"Configures the model explainability job to run a specified Docker container image.
" }, "ModelExplainabilityJobInput":{ "shape":"ModelExplainabilityJobInput", "documentation":"Inputs for the model explainability job.
" }, "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Networking options for a model explainability job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateModelExplainabilityJobDefinitionResponse":{ "type":"structure", "required":["JobDefinitionArn"], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model explainability job.
" } } }, "CreateModelInput":{ "type":"structure", "required":[ "ModelName", "ExecutionRoleArn" ], "members":{ "ModelName":{ "shape":"ModelName", "documentation":"The name of the new model.
" }, "PrimaryContainer":{ "shape":"ContainerDefinition", "documentation":"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.
" }, "Containers":{ "shape":"ContainerDefinitionList", "documentation":"Specifies the containers in the inference pipeline.
" }, "InferenceExecutionConfig":{ "shape":"InferenceExecutionConfig", "documentation":"Specifies details of how containers in a multi-container endpoint are called.
" }, "ExecutionRoleArn":{ "shape":"RoleArn", "documentation":"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.
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 Tagging AWS Resources.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"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.
Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
" } } }, "CreateModelOutput":{ "type":"structure", "required":["ModelArn"], "members":{ "ModelArn":{ "shape":"ModelArn", "documentation":"The ARN of the model created in Amazon SageMaker.
" } } }, "CreateModelPackageGroupInput":{ "type":"structure", "required":["ModelPackageGroupName"], "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group.
" }, "ModelPackageGroupDescription":{ "shape":"EntityDescription", "documentation":"A description for the model group.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of key value pairs associated with the model group. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } } }, "CreateModelPackageGroupOutput":{ "type":"structure", "required":["ModelPackageGroupArn"], "members":{ "ModelPackageGroupArn":{ "shape":"ModelPackageGroupArn", "documentation":"The Amazon Resource Name (ARN) of the model group.
" } } }, "CreateModelPackageInput":{ "type":"structure", "members":{ "ModelPackageName":{ "shape":"EntityName", "documentation":"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).
This parameter is required for unversioned models. It is not applicable to versioned models.
" }, "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
" }, "ModelPackageDescription":{ "shape":"EntityDescription", "documentation":"A description of the model package.
" }, "InferenceSpecification":{ "shape":"InferenceSpecification", "documentation":"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.
Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
" }, "SourceAlgorithmSpecification":{ "shape":"SourceAlgorithmSpecification", "documentation":"Details about the algorithm that was used to create the model package.
" }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", "documentation":"Whether to certify the model package for listing on AWS Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of key value pairs associated with the model. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the model.
A structure that contains model metrics reports.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"A unique token that guarantees that the call to this API is idempotent.
", "idempotencyToken":true } } }, "CreateModelPackageOutput":{ "type":"structure", "required":["ModelPackageArn"], "members":{ "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the new model package.
" } } }, "CreateModelQualityJobDefinitionRequest":{ "type":"structure", "required":[ "JobDefinitionName", "ModelQualityAppSpecification", "ModelQualityJobInput", "ModelQualityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the monitoring job definition.
" }, "ModelQualityBaselineConfig":{ "shape":"ModelQualityBaselineConfig", "documentation":"Specifies the constraints and baselines for the monitoring job.
" }, "ModelQualityAppSpecification":{ "shape":"ModelQualityAppSpecification", "documentation":"The container that runs the monitoring job.
" }, "ModelQualityJobInput":{ "shape":"ModelQualityJobInput", "documentation":"A list of the inputs that are monitored. Currently endpoints are supported.
" }, "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Specifies the network configuration for the monitoring job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateModelQualityJobDefinitionResponse":{ "type":"structure", "required":["JobDefinitionArn"], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model quality monitoring job.
" } } }, "CreateMonitoringScheduleRequest":{ "type":"structure", "required":[ "MonitoringScheduleName", "MonitoringScheduleConfig" ], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.
" }, "MonitoringScheduleConfig":{ "shape":"MonitoringScheduleConfig", "documentation":"The configuration object that specifies the monitoring schedule and defines the monitoring job.
" }, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } } }, "CreateMonitoringScheduleResponse":{ "type":"structure", "required":["MonitoringScheduleArn"], "members":{ "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring schedule.
" } } }, "CreateNotebookInstanceInput":{ "type":"structure", "required":[ "NotebookInstanceName", "InstanceType", "RoleArn" ], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the new notebook instance.
" }, "InstanceType":{ "shape":"InstanceType", "documentation":"The type of ML compute instance to launch for the notebook instance.
" }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
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.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" }, "LifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"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.
" }, "DirectInternetAccess":{ "shape":"DirectInternetAccess", "documentation":"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.
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
" }, "AcceleratorTypes":{ "shape":"NotebookInstanceAcceleratorTypes", "documentation":"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.
" }, "DefaultCodeRepository":{ "shape":"CodeRepositoryNameOrUrl", "documentation":"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.
" }, "AdditionalCodeRepositories":{ "shape":"AdditionalCodeRepositoryNamesOrUrls", "documentation":"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.
" }, "RootAccess":{ "shape":"RootAccess", "documentation":"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.
The name of the lifecycle configuration.
" }, "OnCreate":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
" }, "OnStart":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"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.
" } } }, "CreateNotebookInstanceLifecycleConfigOutput":{ "type":"structure", "members":{ "NotebookInstanceLifecycleConfigArn":{ "shape":"NotebookInstanceLifecycleConfigArn", "documentation":"The Amazon Resource Name (ARN) of the lifecycle configuration.
" } } }, "CreateNotebookInstanceOutput":{ "type":"structure", "members":{ "NotebookInstanceArn":{ "shape":"NotebookInstanceArn", "documentation":"The Amazon Resource Name (ARN) of the notebook instance.
" } } }, "CreatePipelineRequest":{ "type":"structure", "required":[ "PipelineName", "PipelineDefinition", "ClientRequestToken", "RoleArn" ], "members":{ "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline.
" }, "PipelineDisplayName":{ "shape":"PipelineName", "documentation":"The display name of the pipeline.
" }, "PipelineDefinition":{ "shape":"PipelineDefinition", "documentation":"The JSON pipeline definition of the pipeline.
" }, "PipelineDescription":{ "shape":"PipelineDescription", "documentation":"A description of the pipeline.
" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "idempotencyToken":true }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of tags to apply to the created pipeline.
" } } }, "CreatePipelineResponse":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the created pipeline.
" } } }, "CreatePresignedDomainUrlRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The name of the UserProfile to sign-in as.
" }, "SessionExpirationDurationInSeconds":{ "shape":"SessionExpirationDurationInSeconds", "documentation":"The session expiration duration in seconds. This value defaults to 43200.
" }, "ExpiresInSeconds":{ "shape":"ExpiresInSeconds", "documentation":"The number of seconds until the pre-signed URL expires. This value defaults to 300.
" } } }, "CreatePresignedDomainUrlResponse":{ "type":"structure", "members":{ "AuthorizedUrl":{ "shape":"PresignedDomainUrl", "documentation":"The presigned URL.
" } } }, "CreatePresignedNotebookInstanceUrlInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance.
" }, "SessionExpirationDurationInSeconds":{ "shape":"SessionExpirationDurationInSeconds", "documentation":"The duration of the session, in seconds. The default is 12 hours.
" } } }, "CreatePresignedNotebookInstanceUrlOutput":{ "type":"structure", "members":{ "AuthorizedUrl":{ "shape":"NotebookInstanceUrl", "documentation":"A JSON object that contains the URL string.
" } } }, "CreateProcessingJobRequest":{ "type":"structure", "required":[ "ProcessingJobName", "ProcessingResources", "AppSpecification", "RoleArn" ], "members":{ "ProcessingInputs":{ "shape":"ProcessingInputs", "documentation":"An array of inputs configuring the data to download into the processing container.
" }, "ProcessingOutputConfig":{ "shape":"ProcessingOutputConfig", "documentation":"Output configuration for the processing job.
" }, "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job. The name must be unique within an AWS Region in the AWS account.
" }, "ProcessingResources":{ "shape":"ProcessingResources", "documentation":"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.
" }, "StoppingCondition":{ "shape":"ProcessingStoppingCondition", "documentation":"The time limit for how long the processing job is allowed to run.
" }, "AppSpecification":{ "shape":"AppSpecification", "documentation":"Configures the processing job to run a specified Docker container image.
" }, "Environment":{ "shape":"ProcessingEnvironmentMap", "documentation":"The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
" }, "NetworkConfig":{ "shape":"NetworkConfig", "documentation":"Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" }, "ExperimentConfig":{"shape":"ExperimentConfig"} } }, "CreateProcessingJobResponse":{ "type":"structure", "required":["ProcessingJobArn"], "members":{ "ProcessingJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the processing job.
" } } }, "CreateProjectInput":{ "type":"structure", "required":[ "ProjectName", "ServiceCatalogProvisioningDetails" ], "members":{ "ProjectName":{ "shape":"ProjectEntityName", "documentation":"The name of the project.
" }, "ProjectDescription":{ "shape":"EntityDescription", "documentation":"A description for the project.
" }, "ServiceCatalogProvisioningDetails":{ "shape":"ServiceCatalogProvisioningDetails", "documentation":"The product ID and provisioning artifact ID to provision a service catalog. For information, see What is AWS Service Catalog.
" }, "Tags":{ "shape":"TagList", "documentation":"An array of key-value pairs that you want to use to organize and track your AWS resource costs. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } } }, "CreateProjectOutput":{ "type":"structure", "required":[ "ProjectArn", "ProjectId" ], "members":{ "ProjectArn":{ "shape":"ProjectArn", "documentation":"The Amazon Resource Name (ARN) of the project.
" }, "ProjectId":{ "shape":"ProjectId", "documentation":"The ID of the new project.
" } } }, "CreateTrainingJobRequest":{ "type":"structure", "required":[ "TrainingJobName", "AlgorithmSpecification", "RoleArn", "OutputDataConfig", "ResourceConfig", "StoppingCondition" ], "members":{ "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"The name of the training job. The name must be unique within an AWS Region in an AWS account.
" }, "HyperParameters":{ "shape":"HyperParameters", "documentation":"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.
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.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
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.
" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
" }, "ResourceConfig":{ "shape":"ResourceConfig", "documentation":"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.
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.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
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 Tagging AWS Resources.
" }, "EnableNetworkIsolation":{ "shape":"Boolean", "documentation":"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.
" }, "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", "documentation":"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.
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.
" }, "CheckpointConfig":{ "shape":"CheckpointConfig", "documentation":"Contains information about the output location for managed spot training checkpoint data.
" }, "DebugHookConfig":{"shape":"DebugHookConfig"}, "DebugRuleConfigurations":{ "shape":"DebugRuleConfigurations", "documentation":"Configuration information for Debugger rules for debugging output tensors.
" }, "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, "ExperimentConfig":{"shape":"ExperimentConfig"}, "ProfilerConfig":{"shape":"ProfilerConfig"}, "ProfilerRuleConfigurations":{ "shape":"ProfilerRuleConfigurations", "documentation":"Configuration information for Debugger rules for profiling system and framework metrics.
" } } }, "CreateTrainingJobResponse":{ "type":"structure", "required":["TrainingJobArn"], "members":{ "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" } } }, "CreateTransformJobRequest":{ "type":"structure", "required":[ "TransformJobName", "ModelName", "TransformInput", "TransformOutput", "TransformResources" ], "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job. The name must be unique within an AWS Region in an AWS account.
" }, "ModelName":{ "shape":"ModelName", "documentation":"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.
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.
Configures the timeout and maximum number of retries for processing a transform job invocation.
" }, "MaxPayloadInMB":{ "shape":"MaxPayloadInMB", "documentation":"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.
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.
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" }, "TransformInput":{ "shape":"TransformInput", "documentation":"Describes the input source and the way the transform job consumes it.
" }, "TransformOutput":{ "shape":"TransformOutput", "documentation":"Describes the results of the transform job.
" }, "TransformResources":{ "shape":"TransformResources", "documentation":"Describes the resources, including ML instance types and ML instance count, to use for the transform job.
" }, "DataProcessing":{ "shape":"DataProcessing", "documentation":"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.
" }, "Tags":{ "shape":"TagList", "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" }, "ExperimentConfig":{"shape":"ExperimentConfig"} } }, "CreateTransformJobResponse":{ "type":"structure", "required":["TransformJobArn"], "members":{ "TransformJobArn":{ "shape":"TransformJobArn", "documentation":"The Amazon Resource Name (ARN) of the transform job.
" } } }, "CreateTrialComponentRequest":{ "type":"structure", "required":["TrialComponentName"], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component. The name must be unique in your AWS account and is not case-sensitive.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
The status of the component. States include:
InProgress
Completed
Failed
When the component started.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"When the component ended.
" }, "Parameters":{ "shape":"TrialComponentParameters", "documentation":"The hyperparameters for the component.
" }, "InputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
" }, "OutputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags to associate with the component. You can use Search API to search on the tags.
" } } }, "CreateTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the trial component.
" } } }, "CreateTrialRequest":{ "type":"structure", "required":[ "TrialName", "ExperimentName" ], "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
The name of the experiment to associate the trial with.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags to associate with the trial. You can use Search API to search on the tags.
" } } }, "CreateTrialResponse":{ "type":"structure", "members":{ "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" } } }, "CreateUserProfileRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The ID of the associated Domain.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"A name for the UserProfile.
" }, "SingleSignOnUserIdentifier":{ "shape":"SingleSignOnUserIdentifier", "documentation":"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.
" }, "SingleSignOnUserValue":{ "shape":"String256", "documentation":"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.
" }, "Tags":{ "shape":"TagList", "documentation":"Each tag consists of a key and an optional value. Tag keys must be unique per resource.
" }, "UserSettings":{ "shape":"UserSettings", "documentation":"A collection of settings.
" } } }, "CreateUserProfileResponse":{ "type":"structure", "members":{ "UserProfileArn":{ "shape":"UserProfileArn", "documentation":"The user profile Amazon Resource Name (ARN).
" } } }, "CreateWorkforceRequest":{ "type":"structure", "required":["WorkforceName"], "members":{ "CognitoConfig":{ "shape":"CognitoConfig", "documentation":"Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use OidcConfig if you specify values for CognitoConfig.
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use CognitoConfig if you specify values for OidcConfig.
The name of the private workforce.
" }, "Tags":{ "shape":"TagList", "documentation":"An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
" } } }, "CreateWorkforceResponse":{ "type":"structure", "required":["WorkforceArn"], "members":{ "WorkforceArn":{ "shape":"WorkforceArn", "documentation":"The Amazon Resource Name (ARN) of the workforce.
" } } }, "CreateWorkteamRequest":{ "type":"structure", "required":[ "WorkteamName", "MemberDefinitions", "Description" ], "members":{ "WorkteamName":{ "shape":"WorkteamName", "documentation":"The name of the work team. Use this name to identify the work team.
" }, "WorkforceName":{ "shape":"WorkforceName", "documentation":"The name of the workforce.
" }, "MemberDefinitions":{ "shape":"MemberDefinitions", "documentation":"A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.
A description of the work team.
" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"Configures notification of workers regarding available or expiring work items.
" }, "Tags":{ "shape":"TagList", "documentation":"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.
" } } }, "CreateWorkteamResponse":{ "type":"structure", "members":{ "WorkteamArn":{ "shape":"WorkteamArn", "documentation":"The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
" } } }, "CreationTime":{"type":"timestamp"}, "CsvContentType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" }, "CsvContentTypes":{ "type":"list", "member":{"shape":"CsvContentType"}, "max":10, "min":1 }, "CustomImage":{ "type":"structure", "required":[ "ImageName", "AppImageConfigName" ], "members":{ "ImageName":{ "shape":"ImageName", "documentation":"The name of the CustomImage. Must be unique to your account.
" }, "ImageVersionNumber":{ "shape":"ImageVersionNumber", "documentation":"The version number of the CustomImage.
", "box":true }, "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig.
" } }, "documentation":"A custom SageMaker image. For more information, see Bring your own SageMaker image.
" }, "CustomImages":{ "type":"list", "member":{"shape":"CustomImage"}, "max":30 }, "DataCaptureConfig":{ "type":"structure", "required":[ "InitialSamplingPercentage", "DestinationS3Uri", "CaptureOptions" ], "members":{ "EnableCapture":{ "shape":"EnableCapture", "documentation":"" }, "InitialSamplingPercentage":{ "shape":"SamplingPercentage", "documentation":"" }, "DestinationS3Uri":{ "shape":"DestinationS3Uri", "documentation":"" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"" }, "CaptureOptions":{ "shape":"CaptureOptionList", "documentation":"" }, "CaptureContentTypeHeader":{ "shape":"CaptureContentTypeHeader", "documentation":"" } }, "documentation":"" }, "DataCaptureConfigSummary":{ "type":"structure", "required":[ "EnableCapture", "CaptureStatus", "CurrentSamplingPercentage", "DestinationS3Uri", "KmsKeyId" ], "members":{ "EnableCapture":{ "shape":"EnableCapture", "documentation":"" }, "CaptureStatus":{ "shape":"CaptureStatus", "documentation":"" }, "CurrentSamplingPercentage":{ "shape":"SamplingPercentage", "documentation":"" }, "DestinationS3Uri":{ "shape":"DestinationS3Uri", "documentation":"" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"" } }, "documentation":"" }, "DataCatalogConfig":{ "type":"structure", "required":[ "TableName", "Catalog", "Database" ], "members":{ "TableName":{ "shape":"TableName", "documentation":"The name of the Glue table.
" }, "Catalog":{ "shape":"Catalog", "documentation":"The name of the Glue table catalog.
" }, "Database":{ "shape":"Database", "documentation":"The name of the Glue table database.
" } }, "documentation":"The meta data of the Glue table which serves as data catalog for the OfflineStore.
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\"
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']\"
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.
" } }, "documentation":"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.
" }, "DataQualityAppSpecification":{ "type":"structure", "required":["ImageUri"], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The container image that the data quality monitoring job runs.
" }, "ContainerEntrypoint":{ "shape":"ContainerEntrypoint", "documentation":"The entrypoint for a container used to run a monitoring job.
" }, "ContainerArguments":{ "shape":"MonitoringContainerArguments", "documentation":"The arguments to send to the container that the monitoring job runs.
" }, "RecordPreprocessorSourceUri":{ "shape":"S3Uri", "documentation":"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.
" }, "PostAnalyticsProcessorSourceUri":{ "shape":"S3Uri", "documentation":"An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" }, "Environment":{ "shape":"MonitoringEnvironmentMap", "documentation":"Sets the environment variables in the container that the monitoring job runs.
" } }, "documentation":"Information about the container that a data quality monitoring job runs.
" }, "DataQualityBaselineConfig":{ "type":"structure", "members":{ "BaseliningJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the job that performs baselining for the data quality monitoring job.
" }, "ConstraintsResource":{"shape":"MonitoringConstraintsResource"}, "StatisticsResource":{"shape":"MonitoringStatisticsResource"} }, "documentation":"Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" }, "DataQualityJobInput":{ "type":"structure", "required":["EndpointInput"], "members":{ "EndpointInput":{"shape":"EndpointInput"} }, "documentation":"The input for the data quality monitoring job. Currently endpoints are supported for input.
" }, "DataSource":{ "type":"structure", "members":{ "S3DataSource":{ "shape":"S3DataSource", "documentation":"The S3 location of the data source that is associated with a channel.
" }, "FileSystemDataSource":{ "shape":"FileSystemDataSource", "documentation":"The file system that is associated with a channel.
" } }, "documentation":"Describes the location of the channel data.
" }, "Database":{ "type":"string", "max":255, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "DatasetDefinition":{ "type":"structure", "members":{ "AthenaDatasetDefinition":{"shape":"AthenaDatasetDefinition"}, "RedshiftDatasetDefinition":{"shape":"RedshiftDatasetDefinition"}, "LocalPath":{ "shape":"ProcessingLocalPath", "documentation":"The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).
Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
Whether to use File or Pipe input mode. In File (default) 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.
Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Path to Amazon S3 storage location for metrics and tensors.
" }, "HookParameters":{ "shape":"HookParameters", "documentation":"Configuration information for the Debugger hook parameters.
" }, "CollectionConfigurations":{ "shape":"CollectionConfigurations", "documentation":"Configuration information for Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for the Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration. It must be unique relative to other rule configuration names.
" }, "LocalPath":{ "shape":"DirectoryPath", "documentation":"Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" }, "RuleEvaluatorImage":{ "shape":"AlgorithmImage", "documentation":"The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
" }, "InstanceType":{ "shape":"ProcessingInstanceType", "documentation":"The instance type to deploy a Debugger custom rule for debugging a training job.
" }, "VolumeSizeInGB":{ "shape":"OptionalVolumeSizeInGB", "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
" }, "RuleParameters":{ "shape":"RuleParameters", "documentation":"Runtime configuration for rule container.
" } }, "documentation":"Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The name of the rule configuration.
" }, "RuleEvaluationJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the rule evaluation job.
" }, "RuleEvaluationStatus":{ "shape":"RuleEvaluationStatus", "documentation":"Status of the rule evaluation.
" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"Details from the rule evaluation.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Timestamp when the rule evaluation status was last modified.
" } }, "documentation":"Information about the status of the rule evaluation.
" }, "DebugRuleEvaluationStatuses":{ "type":"list", "member":{"shape":"DebugRuleEvaluationStatus"}, "max":20, "min":0 }, "DefaultGid":{ "type":"integer", "max":65535, "min":0 }, "DefaultUid":{ "type":"integer", "max":65535, "min":0 }, "DeleteActionRequest":{ "type":"structure", "required":["ActionName"], "members":{ "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action to delete.
" } } }, "DeleteActionResponse":{ "type":"structure", "members":{ "ActionArn":{ "shape":"ActionArn", "documentation":"The Amazon Resource Name (ARN) of the action.
" } } }, "DeleteAlgorithmInput":{ "type":"structure", "required":["AlgorithmName"], "members":{ "AlgorithmName":{ "shape":"EntityName", "documentation":"The name of the algorithm to delete.
" } } }, "DeleteAppImageConfigRequest":{ "type":"structure", "required":["AppImageConfigName"], "members":{ "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig to delete.
" } } }, "DeleteAppRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName", "AppType", "AppName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "AppType":{ "shape":"AppType", "documentation":"The type of app.
" }, "AppName":{ "shape":"AppName", "documentation":"The name of the app.
" } } }, "DeleteArtifactRequest":{ "type":"structure", "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact to delete.
" }, "Source":{ "shape":"ArtifactSource", "documentation":"The URI of the source.
" } } }, "DeleteArtifactResponse":{ "type":"structure", "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact.
" } } }, "DeleteAssociationRequest":{ "type":"structure", "required":[ "SourceArn", "DestinationArn" ], "members":{ "SourceArn":{ "shape":"AssociationEntityArn", "documentation":"The ARN of the source.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"The Amazon Resource Name (ARN) of the destination.
" } } }, "DeleteAssociationResponse":{ "type":"structure", "members":{ "SourceArn":{ "shape":"AssociationEntityArn", "documentation":"The ARN of the source.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"The Amazon Resource Name (ARN) of the destination.
" } } }, "DeleteCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"The name of the Git repository to delete.
" } } }, "DeleteContextRequest":{ "type":"structure", "required":["ContextName"], "members":{ "ContextName":{ "shape":"ExperimentEntityName", "documentation":"The name of the context to delete.
" } } }, "DeleteContextResponse":{ "type":"structure", "members":{ "ContextArn":{ "shape":"ContextArn", "documentation":"The Amazon Resource Name (ARN) of the context.
" } } }, "DeleteDataQualityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the data quality monitoring job definition to delete.
" } } }, "DeleteDeviceFleetRequest":{ "type":"structure", "required":["DeviceFleetName"], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet to delete.
" } } }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainId"], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "RetentionPolicy":{ "shape":"RetentionPolicy", "documentation":"The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).
" } } }, "DeleteEndpointConfigInput":{ "type":"structure", "required":["EndpointConfigName"], "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the endpoint configuration that you want to delete.
" } } }, "DeleteEndpointInput":{ "type":"structure", "required":["EndpointName"], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint that you want to delete.
" } } }, "DeleteExperimentRequest":{ "type":"structure", "required":["ExperimentName"], "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment to delete.
" } } }, "DeleteExperimentResponse":{ "type":"structure", "members":{ "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment that is being deleted.
" } } }, "DeleteFeatureGroupRequest":{ "type":"structure", "required":["FeatureGroupName"], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupName", "documentation":"The name of the FeatureGroup you want to delete. The name must be unique within an AWS Region in an AWS account.
The name of the flow definition you are deleting.
" } } }, "DeleteFlowDefinitionResponse":{ "type":"structure", "members":{ } }, "DeleteHumanTaskUiRequest":{ "type":"structure", "required":["HumanTaskUiName"], "members":{ "HumanTaskUiName":{ "shape":"HumanTaskUiName", "documentation":"The name of the human task user interface (work task template) you want to delete.
" } } }, "DeleteHumanTaskUiResponse":{ "type":"structure", "members":{ } }, "DeleteImageRequest":{ "type":"structure", "required":["ImageName"], "members":{ "ImageName":{ "shape":"ImageName", "documentation":"The name of the image to delete.
" } } }, "DeleteImageResponse":{ "type":"structure", "members":{ } }, "DeleteImageVersionRequest":{ "type":"structure", "required":[ "ImageName", "Version" ], "members":{ "ImageName":{ "shape":"ImageName", "documentation":"The name of the image.
" }, "Version":{ "shape":"ImageVersionNumber", "documentation":"The version to delete.
" } } }, "DeleteImageVersionResponse":{ "type":"structure", "members":{ } }, "DeleteModelBiasJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model bias job definition to delete.
" } } }, "DeleteModelExplainabilityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model explainability job definition to delete.
" } } }, "DeleteModelInput":{ "type":"structure", "required":["ModelName"], "members":{ "ModelName":{ "shape":"ModelName", "documentation":"The name of the model to delete.
" } } }, "DeleteModelPackageGroupInput":{ "type":"structure", "required":["ModelPackageGroupName"], "members":{ "ModelPackageGroupName":{ "shape":"ArnOrName", "documentation":"The name of the model group to delete.
" } } }, "DeleteModelPackageGroupPolicyInput":{ "type":"structure", "required":["ModelPackageGroupName"], "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group for which to delete the policy.
" } } }, "DeleteModelPackageInput":{ "type":"structure", "required":["ModelPackageName"], "members":{ "ModelPackageName":{ "shape":"VersionedArnOrName", "documentation":"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).
" } } }, "DeleteModelQualityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model quality monitoring job definition to delete.
" } } }, "DeleteMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule to delete.
" } } }, "DeleteNotebookInstanceInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the Amazon SageMaker notebook instance to delete.
" } } }, "DeleteNotebookInstanceLifecycleConfigInput":{ "type":"structure", "required":["NotebookInstanceLifecycleConfigName"], "members":{ "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"The name of the lifecycle configuration to delete.
" } } }, "DeletePipelineRequest":{ "type":"structure", "required":[ "PipelineName", "ClientRequestToken" ], "members":{ "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline to delete.
" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "idempotencyToken":true } } }, "DeletePipelineResponse":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline to delete.
" } } }, "DeleteProjectInput":{ "type":"structure", "required":["ProjectName"], "members":{ "ProjectName":{ "shape":"ProjectEntityName", "documentation":"The name of the project to delete.
" } } }, "DeleteTagsInput":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource whose tags you want to delete.
" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"An array or one or more tag keys to delete.
" } } }, "DeleteTagsOutput":{ "type":"structure", "members":{ } }, "DeleteTrialComponentRequest":{ "type":"structure", "required":["TrialComponentName"], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component to delete.
" } } }, "DeleteTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the component is being deleted.
" } } }, "DeleteTrialRequest":{ "type":"structure", "required":["TrialName"], "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial to delete.
" } } }, "DeleteTrialResponse":{ "type":"structure", "members":{ "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial that is being deleted.
" } } }, "DeleteUserProfileRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" } } }, "DeleteWorkforceRequest":{ "type":"structure", "required":["WorkforceName"], "members":{ "WorkforceName":{ "shape":"WorkforceName", "documentation":"The name of the workforce.
" } } }, "DeleteWorkforceResponse":{ "type":"structure", "members":{ } }, "DeleteWorkteamRequest":{ "type":"structure", "required":["WorkteamName"], "members":{ "WorkteamName":{ "shape":"WorkteamName", "documentation":"The name of the work team to delete.
" } } }, "DeleteWorkteamResponse":{ "type":"structure", "required":["Success"], "members":{ "Success":{ "shape":"Success", "documentation":"Returns true if the work team was successfully deleted; otherwise, returns false.
The image path you specified when you created the model.
" }, "ResolvedImage":{ "shape":"ContainerImage", "documentation":"The specific digest path of the image hosted in this ProductionVariant.
The date and time when the image path for the model resolved to the ResolvedImage
Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.
If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.
Currently, the DeploymentConfig API is not supported.
The name of the fleet the devices belong to.
" }, "DeviceNames":{ "shape":"DeviceNames", "documentation":"The unique IDs of the devices.
" } } }, "DescribeActionRequest":{ "type":"structure", "required":["ActionName"], "members":{ "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action to describe.
" } } }, "DescribeActionResponse":{ "type":"structure", "members":{ "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action.
" }, "ActionArn":{ "shape":"ActionArn", "documentation":"The Amazon Resource Name (ARN) of the action.
" }, "Source":{ "shape":"ActionSource", "documentation":"The source of the action.
" }, "ActionType":{ "shape":"String256", "documentation":"The type of the action.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The description of the action.
" }, "Status":{ "shape":"ActionStatus", "documentation":"The status of the action.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of the action's properties.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the action was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the action was last modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "MetadataProperties":{"shape":"MetadataProperties"} } }, "DescribeAlgorithmInput":{ "type":"structure", "required":["AlgorithmName"], "members":{ "AlgorithmName":{ "shape":"ArnOrName", "documentation":"The name of the algorithm to describe.
" } } }, "DescribeAlgorithmOutput":{ "type":"structure", "required":[ "AlgorithmName", "AlgorithmArn", "CreationTime", "TrainingSpecification", "AlgorithmStatus", "AlgorithmStatusDetails" ], "members":{ "AlgorithmName":{ "shape":"EntityName", "documentation":"The name of the algorithm being described.
" }, "AlgorithmArn":{ "shape":"AlgorithmArn", "documentation":"The Amazon Resource Name (ARN) of the algorithm.
" }, "AlgorithmDescription":{ "shape":"EntityDescription", "documentation":"A brief summary about the algorithm.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp specifying when the algorithm was created.
" }, "TrainingSpecification":{ "shape":"TrainingSpecification", "documentation":"Details about training jobs run by this algorithm.
" }, "InferenceSpecification":{ "shape":"InferenceSpecification", "documentation":"Details about inference jobs that the algorithm runs.
" }, "ValidationSpecification":{ "shape":"AlgorithmValidationSpecification", "documentation":"Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.
" }, "AlgorithmStatus":{ "shape":"AlgorithmStatus", "documentation":"The current status of the algorithm.
" }, "AlgorithmStatusDetails":{ "shape":"AlgorithmStatusDetails", "documentation":"Details about the current status of the algorithm.
" }, "ProductId":{ "shape":"ProductId", "documentation":"The product identifier of the algorithm.
" }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", "documentation":"Whether the algorithm is certified to be listed in AWS Marketplace.
" } } }, "DescribeAppImageConfigRequest":{ "type":"structure", "required":["AppImageConfigName"], "members":{ "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig to describe.
" } } }, "DescribeAppImageConfigResponse":{ "type":"structure", "members":{ "AppImageConfigArn":{ "shape":"AppImageConfigArn", "documentation":"The Amazon Resource Name (ARN) of the AppImageConfig.
" }, "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the AppImageConfig was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the AppImageConfig was last modified.
" }, "KernelGatewayImageConfig":{ "shape":"KernelGatewayImageConfig", "documentation":"The configuration of a KernelGateway app.
" } } }, "DescribeAppRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName", "AppType", "AppName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "AppType":{ "shape":"AppType", "documentation":"The type of app.
" }, "AppName":{ "shape":"AppName", "documentation":"The name of the app.
" } } }, "DescribeAppResponse":{ "type":"structure", "members":{ "AppArn":{ "shape":"AppArn", "documentation":"The Amazon Resource Name (ARN) of the app.
" }, "AppType":{ "shape":"AppType", "documentation":"The type of app.
" }, "AppName":{ "shape":"AppName", "documentation":"The name of the app.
" }, "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "Status":{ "shape":"AppStatus", "documentation":"The status.
" }, "LastHealthCheckTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp of the last health check.
" }, "LastUserActivityTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp of the last user's activity.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The failure reason.
" }, "ResourceSpec":{ "shape":"ResourceSpec", "documentation":"The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" } } }, "DescribeArtifactRequest":{ "type":"structure", "required":["ArtifactArn"], "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact to describe.
" } } }, "DescribeArtifactResponse":{ "type":"structure", "members":{ "ArtifactName":{ "shape":"ExperimentEntityName", "documentation":"The name of the artifact.
" }, "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact.
" }, "Source":{ "shape":"ArtifactSource", "documentation":"The source of the artifact.
" }, "ArtifactType":{ "shape":"String256", "documentation":"The type of the artifact.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of the artifact's properties.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the artifact was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the artifact was last modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "MetadataProperties":{"shape":"MetadataProperties"} } }, "DescribeAutoMLJobRequest":{ "type":"structure", "required":["AutoMLJobName"], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"Request information about a job using that job's unique name.
" } } }, "DescribeAutoMLJobResponse":{ "type":"structure", "required":[ "AutoMLJobName", "AutoMLJobArn", "InputDataConfig", "OutputDataConfig", "RoleArn", "CreationTime", "LastModifiedTime", "AutoMLJobStatus", "AutoMLJobSecondaryStatus" ], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"Returns the name of a job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"Returns the job's ARN.
" }, "InputDataConfig":{ "shape":"AutoMLInputDataConfig", "documentation":"Returns the job's input data config.
" }, "OutputDataConfig":{ "shape":"AutoMLOutputDataConfig", "documentation":"Returns the job's output data config.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
" }, "AutoMLJobObjective":{ "shape":"AutoMLJobObjective", "documentation":"Returns the job's objective.
" }, "ProblemType":{ "shape":"ProblemType", "documentation":"Returns the job's problem type.
" }, "AutoMLJobConfig":{ "shape":"AutoMLJobConfig", "documentation":"Returns the job's config.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Returns the job's creation time.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"Returns the job's end time.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Returns the job's last modified time.
" }, "FailureReason":{ "shape":"AutoMLFailureReason", "documentation":"Returns the job's FailureReason.
" }, "BestCandidate":{ "shape":"AutoMLCandidate", "documentation":"Returns the job's BestCandidate.
" }, "AutoMLJobStatus":{ "shape":"AutoMLJobStatus", "documentation":"Returns the job's AutoMLJobStatus.
" }, "AutoMLJobSecondaryStatus":{ "shape":"AutoMLJobSecondaryStatus", "documentation":"Returns the job's AutoMLJobSecondaryStatus.
" }, "GenerateCandidateDefinitionsOnly":{ "shape":"GenerateCandidateDefinitionsOnly", "documentation":"Returns the job's output from GenerateCandidateDefinitionsOnly.
" }, "AutoMLJobArtifacts":{ "shape":"AutoMLJobArtifacts", "documentation":"Returns information on the job's artifacts found in AutoMLJobArtifacts.
" }, "ResolvedAttributes":{ "shape":"ResolvedAttributes", "documentation":"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.
" } } }, "DescribeCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"The name of the Git repository to describe.
" } } }, "DescribeCodeRepositoryOutput":{ "type":"structure", "required":[ "CodeRepositoryName", "CodeRepositoryArn", "CreationTime", "LastModifiedTime" ], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"The name of the Git repository.
" }, "CodeRepositoryArn":{ "shape":"CodeRepositoryArn", "documentation":"The Amazon Resource Name (ARN) of the Git repository.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The date and time that the repository was created.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The date and time that the repository was last changed.
" }, "GitConfig":{ "shape":"GitConfig", "documentation":"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.
" } } }, "DescribeCompilationJobRequest":{ "type":"structure", "required":["CompilationJobName"], "members":{ "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the model compilation job that you want information about.
" } } }, "DescribeCompilationJobResponse":{ "type":"structure", "required":[ "CompilationJobName", "CompilationJobArn", "CompilationJobStatus", "StoppingCondition", "CreationTime", "LastModifiedTime", "FailureReason", "ModelArtifacts", "RoleArn", "InputConfig", "OutputConfig" ], "members":{ "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the model compilation job.
" }, "CompilationJobArn":{ "shape":"CompilationJobArn", "documentation":"The Amazon Resource Name (ARN) of the model compilation job.
" }, "CompilationJobStatus":{ "shape":"CompilationJobStatus", "documentation":"The status of the model compilation job.
" }, "CompilationStartTime":{ "shape":"Timestamp", "documentation":"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.
" }, "CompilationEndTime":{ "shape":"Timestamp", "documentation":"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.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time that the model compilation job was created.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The time that the status of the model compilation job was last modified.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If a model compilation job failed, the reason it failed.
" }, "ModelArtifacts":{ "shape":"ModelArtifacts", "documentation":"Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
" }, "ModelDigests":{ "shape":"ModelDigests", "documentation":"Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
" }, "InputConfig":{ "shape":"InputConfig", "documentation":"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.
" }, "OutputConfig":{ "shape":"OutputConfig", "documentation":"Information about the output location for the compiled model and the target device that the model runs on.
" } } }, "DescribeContextRequest":{ "type":"structure", "required":["ContextName"], "members":{ "ContextName":{ "shape":"ExperimentEntityName", "documentation":"The name of the context to describe.
" } } }, "DescribeContextResponse":{ "type":"structure", "members":{ "ContextName":{ "shape":"ExperimentEntityName", "documentation":"The name of the context.
" }, "ContextArn":{ "shape":"ContextArn", "documentation":"The Amazon Resource Name (ARN) of the context.
" }, "Source":{ "shape":"ContextSource", "documentation":"The source of the context.
" }, "ContextType":{ "shape":"String256", "documentation":"The type of the context.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The description of the context.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"A list of the context's properties.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the context was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the context was last modified.
" }, "LastModifiedBy":{"shape":"UserContext"} } }, "DescribeDataQualityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the data quality monitoring job definition to describe.
" } } }, "DescribeDataQualityJobDefinitionResponse":{ "type":"structure", "required":[ "JobDefinitionArn", "JobDefinitionName", "CreationTime", "DataQualityAppSpecification", "DataQualityJobInput", "DataQualityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the data quality monitoring job definition.
" }, "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the data quality monitoring job definition.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the data quality monitoring job definition was created.
" }, "DataQualityBaselineConfig":{ "shape":"DataQualityBaselineConfig", "documentation":"The constraints and baselines for the data quality monitoring job definition.
" }, "DataQualityAppSpecification":{ "shape":"DataQualityAppSpecification", "documentation":"Information about the container that runs the data quality monitoring job.
" }, "DataQualityJobInput":{ "shape":"DataQualityJobInput", "documentation":"The list of inputs for the data quality monitoring job. Currently endpoints are supported.
" }, "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"The networking configuration for the data quality monitoring job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"} } }, "DescribeDeviceFleetRequest":{ "type":"structure", "required":["DeviceFleetName"], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" } } }, "DescribeDeviceFleetResponse":{ "type":"structure", "required":[ "DeviceFleetName", "DeviceFleetArn", "OutputConfig", "CreationTime", "LastModifiedTime" ], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" }, "DeviceFleetArn":{ "shape":"DeviceFleetArn", "documentation":"The The Amazon Resource Name (ARN) of the fleet.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"The output configuration for storing sampled data.
" }, "Description":{ "shape":"DeviceFleetDescription", "documentation":"A description of the fleet.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Timestamp of when the device fleet was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Timestamp of when the device fleet was last updated.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
" }, "IotRoleAlias":{ "shape":"IotRoleAlias", "documentation":"The Amazon Resource Name (ARN) alias created in AWS Internet of Things (IoT).
" } } }, "DescribeDeviceRequest":{ "type":"structure", "required":[ "DeviceName", "DeviceFleetName" ], "members":{ "NextToken":{ "shape":"NextToken", "documentation":"Next token of device description.
" }, "DeviceName":{ "shape":"EntityName", "documentation":"The unique ID of the device.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet the devices belong to.
" } } }, "DescribeDeviceResponse":{ "type":"structure", "required":[ "DeviceName", "DeviceFleetName", "RegistrationTime" ], "members":{ "DeviceArn":{ "shape":"DeviceArn", "documentation":"The Amazon Resource Name (ARN) of the device.
" }, "DeviceName":{ "shape":"EntityName", "documentation":"The unique identifier of the device.
" }, "Description":{ "shape":"DeviceDescription", "documentation":"A description of the device.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet the device belongs to.
" }, "IotThingName":{ "shape":"ThingName", "documentation":"The AWS Internet of Things (IoT) object thing name associated with the device.
" }, "RegistrationTime":{ "shape":"Timestamp", "documentation":"The timestamp of the last registration or de-reregistration.
" }, "LatestHeartbeat":{ "shape":"Timestamp", "documentation":"The last heartbeat received from the device.
" }, "Models":{ "shape":"EdgeModels", "documentation":"Models on the device.
" }, "MaxModels":{ "shape":"Integer", "documentation":"The maximum number of models.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The response from the last list when returning a list large enough to need tokening.
" } } }, "DescribeDomainRequest":{ "type":"structure", "required":["DomainId"], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" } } }, "DescribeDomainResponse":{ "type":"structure", "members":{ "DomainArn":{ "shape":"DomainArn", "documentation":"The domain's Amazon Resource Name (ARN).
" }, "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The domain name.
" }, "HomeEfsFileSystemId":{ "shape":"ResourceId", "documentation":"The ID of the Amazon Elastic File System (EFS) managed by this Domain.
" }, "SingleSignOnManagedApplicationInstanceId":{ "shape":"String256", "documentation":"The SSO managed application instance ID.
" }, "Status":{ "shape":"DomainStatus", "documentation":"The status.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The last modified time.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The failure reason.
" }, "AuthMode":{ "shape":"AuthMode", "documentation":"The domain's authentication mode.
" }, "DefaultUserSettings":{ "shape":"UserSettings", "documentation":"Settings which are applied to all UserProfiles in this domain, if settings are not explicitly specified in a given UserProfile.
" }, "AppNetworkAccessType":{ "shape":"AppNetworkAccessType", "documentation":"Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
VpcOnly - All Studio traffic is through the specified VPC and subnets
This member is deprecated and replaced with KmsKeyId.
The VPC subnets that Studio uses for communication.
" }, "Url":{ "shape":"String1024", "documentation":"The domain's URL.
" }, "VpcId":{ "shape":"VpcId", "documentation":"The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.
" } } }, "DescribeEdgePackagingJobRequest":{ "type":"structure", "required":["EdgePackagingJobName"], "members":{ "EdgePackagingJobName":{ "shape":"EntityName", "documentation":"The name of the edge packaging job.
" } } }, "DescribeEdgePackagingJobResponse":{ "type":"structure", "required":[ "EdgePackagingJobArn", "EdgePackagingJobName", "EdgePackagingJobStatus" ], "members":{ "EdgePackagingJobArn":{ "shape":"EdgePackagingJobArn", "documentation":"The Amazon Resource Name (ARN) of the edge packaging job.
" }, "EdgePackagingJobName":{ "shape":"EntityName", "documentation":"The name of the edge packaging job.
" }, "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
" }, "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The version of the model.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"The output configuration for the edge packaging job.
" }, "ResourceKey":{ "shape":"KmsKeyId", "documentation":"The CMK to use when encrypting the EBS volume the job run on.
" }, "EdgePackagingJobStatus":{ "shape":"EdgePackagingJobStatus", "documentation":"The current status of the packaging job.
" }, "EdgePackagingJobStatusMessage":{ "shape":"String", "documentation":"Returns a message describing the job status and error messages.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The timestamp of when the packaging job was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The timestamp of when the job was last updated.
" }, "ModelArtifact":{ "shape":"S3Uri", "documentation":"The Amazon Simple Storage (S3) URI where model artifacts ares stored.
" }, "ModelSignature":{ "shape":"String", "documentation":"The signature document of files in the model artifact.
" } } }, "DescribeEndpointConfigInput":{ "type":"structure", "required":["EndpointConfigName"], "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the endpoint configuration.
" } } }, "DescribeEndpointConfigOutput":{ "type":"structure", "required":[ "EndpointConfigName", "EndpointConfigArn", "ProductionVariants", "CreationTime" ], "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"Name of the Amazon SageMaker endpoint configuration.
" }, "EndpointConfigArn":{ "shape":"EndpointConfigArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint configuration.
" }, "ProductionVariants":{ "shape":"ProductionVariantList", "documentation":"An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the endpoint configuration was created.
" } } }, "DescribeEndpointInput":{ "type":"structure", "required":["EndpointName"], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint.
" } } }, "DescribeEndpointOutput":{ "type":"structure", "required":[ "EndpointName", "EndpointArn", "EndpointConfigName", "EndpointStatus", "CreationTime", "LastModifiedTime" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"Name of the endpoint.
" }, "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint.
" }, "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the endpoint configuration associated with this endpoint.
" }, "ProductionVariants":{ "shape":"ProductionVariantSummaryList", "documentation":"An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
" }, "DataCaptureConfig":{"shape":"DataCaptureConfigSummary"}, "EndpointStatus":{ "shape":"EndpointStatus", "documentation":"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.
If the status of the endpoint is Failed, the reason why it failed.
A timestamp that shows when the endpoint was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the endpoint was last modified.
" }, "LastDeploymentConfig":{ "shape":"DeploymentConfig", "documentation":"The most recent deployment configuration for the endpoint.
" } } }, "DescribeExperimentRequest":{ "type":"structure", "required":["ExperimentName"], "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment to describe.
" } } }, "DescribeExperimentResponse":{ "type":"structure", "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment.
" }, "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
The ARN of the source and, optionally, the type.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The description of the experiment.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the experiment was created.
" }, "CreatedBy":{ "shape":"UserContext", "documentation":"Who created the experiment.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the experiment was last modified.
" }, "LastModifiedBy":{ "shape":"UserContext", "documentation":"Who last modified the experiment.
" } } }, "DescribeFeatureGroupRequest":{ "type":"structure", "required":["FeatureGroupName"], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupName", "documentation":"The name of the FeatureGroup you want described.
A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.
The Amazon Resource Name (ARN) of the FeatureGroup.
he name of the FeatureGroup.
The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.
A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.
A timestamp indicating when SageMaker created the FeatureGroup.
The configuration for the OnlineStore.
The configuration of the OfflineStore, inducing the S3 location of the OfflineStore, AWS Glue or AWS Hive data catalogue configurations, and the security configuration.
The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
The status of the feature group.
" }, "OfflineStoreStatus":{ "shape":"OfflineStoreStatus", "documentation":"The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked
The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:
The FeatureGroup could not be created in the OfflineStore.
The FeatureGroup could not be deleted from the OfflineStore.
A free form description of the feature group.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination of the list of Features (FeatureDefinitions).
The name of the flow definition.
" } } }, "DescribeFlowDefinitionResponse":{ "type":"structure", "required":[ "FlowDefinitionArn", "FlowDefinitionName", "FlowDefinitionStatus", "CreationTime", "HumanLoopConfig", "OutputConfig", "RoleArn" ], "members":{ "FlowDefinitionArn":{ "shape":"FlowDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the flow defintion.
" }, "FlowDefinitionName":{ "shape":"FlowDefinitionName", "documentation":"The Amazon Resource Name (ARN) of the flow definition.
" }, "FlowDefinitionStatus":{ "shape":"FlowDefinitionStatus", "documentation":"The status of the flow definition. Valid values are listed below.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The timestamp when the flow definition was created.
" }, "HumanLoopRequestSource":{ "shape":"HumanLoopRequestSource", "documentation":"Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
" }, "HumanLoopActivationConfig":{ "shape":"HumanLoopActivationConfig", "documentation":"An object containing information about what triggers a human review workflow.
" }, "HumanLoopConfig":{ "shape":"HumanLoopConfig", "documentation":"An object containing information about who works on the task, the workforce task price, and other task details.
" }, "OutputConfig":{ "shape":"FlowDefinitionOutputConfig", "documentation":"An object containing information about the output file.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The reason your flow definition failed.
" } } }, "DescribeHumanTaskUiRequest":{ "type":"structure", "required":["HumanTaskUiName"], "members":{ "HumanTaskUiName":{ "shape":"HumanTaskUiName", "documentation":"The name of the human task user interface (worker task template) you want information about.
" } } }, "DescribeHumanTaskUiResponse":{ "type":"structure", "required":[ "HumanTaskUiArn", "HumanTaskUiName", "CreationTime", "UiTemplate" ], "members":{ "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The Amazon Resource Name (ARN) of the human task user interface (worker task template).
" }, "HumanTaskUiName":{ "shape":"HumanTaskUiName", "documentation":"The name of the human task user interface (worker task template).
" }, "HumanTaskUiStatus":{ "shape":"HumanTaskUiStatus", "documentation":"The status of the human task user interface (worker task template). Valid values are listed below.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The timestamp when the human task user interface was created.
" }, "UiTemplate":{"shape":"UiTemplateInfo"} } }, "DescribeHyperParameterTuningJobRequest":{ "type":"structure", "required":["HyperParameterTuningJobName"], "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The name of the tuning job.
" } } }, "DescribeHyperParameterTuningJobResponse":{ "type":"structure", "required":[ "HyperParameterTuningJobName", "HyperParameterTuningJobArn", "HyperParameterTuningJobConfig", "HyperParameterTuningJobStatus", "CreationTime", "TrainingJobStatusCounters", "ObjectiveStatusCounters" ], "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The name of the tuning job.
" }, "HyperParameterTuningJobArn":{ "shape":"HyperParameterTuningJobArn", "documentation":"The Amazon Resource Name (ARN) of the tuning job.
" }, "HyperParameterTuningJobConfig":{ "shape":"HyperParameterTuningJobConfig", "documentation":"The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
" }, "TrainingJobDefinition":{ "shape":"HyperParameterTrainingJobDefinition", "documentation":"The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
" }, "TrainingJobDefinitions":{ "shape":"HyperParameterTrainingJobDefinitions", "documentation":"A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
" }, "HyperParameterTuningJobStatus":{ "shape":"HyperParameterTuningJobStatus", "documentation":"The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the tuning job started.
" }, "HyperParameterTuningEndTime":{ "shape":"Timestamp", "documentation":"The date and time that the tuning job ended.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The date and time that the status of the tuning job was modified.
" }, "TrainingJobStatusCounters":{ "shape":"TrainingJobStatusCounters", "documentation":"The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
" }, "ObjectiveStatusCounters":{ "shape":"ObjectiveStatusCounters", "documentation":"The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.
" }, "BestTrainingJob":{ "shape":"HyperParameterTrainingJobSummary", "documentation":"A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
" }, "OverallBestTrainingJob":{ "shape":"HyperParameterTrainingJobSummary", "documentation":"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.
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.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the tuning job failed, the reason it failed.
" } } }, "DescribeImageRequest":{ "type":"structure", "required":["ImageName"], "members":{ "ImageName":{ "shape":"ImageName", "documentation":"The name of the image to describe.
" } } }, "DescribeImageResponse":{ "type":"structure", "members":{ "CreationTime":{ "shape":"Timestamp", "documentation":"When the image was created.
" }, "Description":{ "shape":"ImageDescription", "documentation":"The description of the image.
" }, "DisplayName":{ "shape":"ImageDisplayName", "documentation":"The name of the image as displayed.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"When a create, update, or delete operation fails, the reason for the failure.
" }, "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image.
" }, "ImageName":{ "shape":"ImageName", "documentation":"The name of the image.
" }, "ImageStatus":{ "shape":"ImageStatus", "documentation":"The status of the image.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the image was last modified.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
" } } }, "DescribeImageVersionRequest":{ "type":"structure", "required":["ImageName"], "members":{ "ImageName":{ "shape":"ImageName", "documentation":"The name of the image.
" }, "Version":{ "shape":"ImageVersionNumber", "documentation":"The version of the image. If not specified, the latest version is described.
" } } }, "DescribeImageVersionResponse":{ "type":"structure", "members":{ "BaseImage":{ "shape":"ImageBaseImage", "documentation":"The registry path of the container image on which this image version is based.
" }, "ContainerImage":{ "shape":"ImageContainerImage", "documentation":"The registry path of the container image that contains this image version.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the version was created.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"When a create or delete operation fails, the reason for the failure.
" }, "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image the version is based on.
" }, "ImageVersionArn":{ "shape":"ImageVersionArn", "documentation":"The ARN of the version.
" }, "ImageVersionStatus":{ "shape":"ImageVersionStatus", "documentation":"The status of the version.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the version was last modified.
" }, "Version":{ "shape":"ImageVersionNumber", "documentation":"The version number.
" } } }, "DescribeLabelingJobRequest":{ "type":"structure", "required":["LabelingJobName"], "members":{ "LabelingJobName":{ "shape":"LabelingJobName", "documentation":"The name of the labeling job to return information for.
" } } }, "DescribeLabelingJobResponse":{ "type":"structure", "required":[ "LabelingJobStatus", "LabelCounters", "CreationTime", "LastModifiedTime", "JobReferenceCode", "LabelingJobName", "LabelingJobArn", "InputConfig", "OutputConfig", "RoleArn", "HumanTaskConfig" ], "members":{ "LabelingJobStatus":{ "shape":"LabelingJobStatus", "documentation":"The processing status of the labeling job.
" }, "LabelCounters":{ "shape":"LabelCounters", "documentation":"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.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the job failed, the reason that it failed.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the labeling job was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The date and time that the labeling job was last updated.
" }, "JobReferenceCode":{ "shape":"JobReferenceCode", "documentation":"A unique identifier for work done as part of a labeling job.
" }, "LabelingJobName":{ "shape":"LabelingJobName", "documentation":"The name assigned to the labeling job when it was created.
" }, "LabelingJobArn":{ "shape":"LabelingJobArn", "documentation":"The Amazon Resource Name (ARN) of the labeling job.
" }, "LabelAttributeName":{ "shape":"LabelAttributeName", "documentation":"The attribute used as the label in the output manifest file.
" }, "InputConfig":{ "shape":"LabelingJobInputConfig", "documentation":"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.
" }, "OutputConfig":{ "shape":"LabelingJobOutputConfig", "documentation":"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.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
" }, "LabelCategoryConfigS3Uri":{ "shape":"S3Uri", "documentation":"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\"
}
]
}
A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
" }, "LabelingJobAlgorithmsConfig":{ "shape":"LabelingJobAlgorithmsConfig", "documentation":"Configuration information for automated data labeling.
" }, "HumanTaskConfig":{ "shape":"HumanTaskConfig", "documentation":"Configuration information required for human workers to complete a labeling task.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" }, "LabelingJobOutput":{ "shape":"LabelingJobOutput", "documentation":"The location of the output produced by the labeling job.
" } } }, "DescribeModelBiasJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model bias job definition. The name must be unique within an AWS Region in the AWS account.
" } } }, "DescribeModelBiasJobDefinitionResponse":{ "type":"structure", "required":[ "JobDefinitionArn", "JobDefinitionName", "CreationTime", "ModelBiasAppSpecification", "ModelBiasJobInput", "ModelBiasJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model bias job.
" }, "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the bias job definition. The name must be unique within an AWS Region in the AWS account.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the model bias job was created.
" }, "ModelBiasBaselineConfig":{ "shape":"ModelBiasBaselineConfig", "documentation":"The baseline configuration for a model bias job.
" }, "ModelBiasAppSpecification":{ "shape":"ModelBiasAppSpecification", "documentation":"Configures the model bias job to run a specified Docker container image.
" }, "ModelBiasJobInput":{ "shape":"ModelBiasJobInput", "documentation":"Inputs for the model bias job.
" }, "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Networking options for a model bias job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"} } }, "DescribeModelExplainabilityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account.
" } } }, "DescribeModelExplainabilityJobDefinitionResponse":{ "type":"structure", "required":[ "JobDefinitionArn", "JobDefinitionName", "CreationTime", "ModelExplainabilityAppSpecification", "ModelExplainabilityJobInput", "ModelExplainabilityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model explainability job.
" }, "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the explainability job definition. The name must be unique within an AWS Region in the AWS account.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the model explainability job was created.
" }, "ModelExplainabilityBaselineConfig":{ "shape":"ModelExplainabilityBaselineConfig", "documentation":"The baseline configuration for a model explainability job.
" }, "ModelExplainabilityAppSpecification":{ "shape":"ModelExplainabilityAppSpecification", "documentation":"Configures the model explainability job to run a specified Docker container image.
" }, "ModelExplainabilityJobInput":{ "shape":"ModelExplainabilityJobInput", "documentation":"Inputs for the model explainability job.
" }, "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Networking options for a model explainability job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"} } }, "DescribeModelInput":{ "type":"structure", "required":["ModelName"], "members":{ "ModelName":{ "shape":"ModelName", "documentation":"The name of the model.
" } } }, "DescribeModelOutput":{ "type":"structure", "required":[ "ModelName", "ExecutionRoleArn", "CreationTime", "ModelArn" ], "members":{ "ModelName":{ "shape":"ModelName", "documentation":"Name of the Amazon SageMaker model.
" }, "PrimaryContainer":{ "shape":"ContainerDefinition", "documentation":"The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
" }, "Containers":{ "shape":"ContainerDefinitionList", "documentation":"The containers in the inference pipeline.
" }, "InferenceExecutionConfig":{ "shape":"InferenceExecutionConfig", "documentation":"Specifies details of how containers in a multi-container endpoint are called.
" }, "ExecutionRoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"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
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the model was created.
" }, "ModelArn":{ "shape":"ModelArn", "documentation":"The Amazon Resource Name (ARN) of the model.
" }, "EnableNetworkIsolation":{ "shape":"Boolean", "documentation":"If True, no inbound or outbound network calls can be made to or from the model container.
The name of the model group to describe.
" } } }, "DescribeModelPackageGroupOutput":{ "type":"structure", "required":[ "ModelPackageGroupName", "ModelPackageGroupArn", "CreationTime", "CreatedBy", "ModelPackageGroupStatus" ], "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group.
" }, "ModelPackageGroupArn":{ "shape":"ModelPackageGroupArn", "documentation":"The Amazon Resource Name (ARN) of the model group.
" }, "ModelPackageGroupDescription":{ "shape":"EntityDescription", "documentation":"A description of the model group.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time that the model group was created.
" }, "CreatedBy":{"shape":"UserContext"}, "ModelPackageGroupStatus":{ "shape":"ModelPackageGroupStatus", "documentation":"The status of the model group.
" } } }, "DescribeModelPackageInput":{ "type":"structure", "required":["ModelPackageName"], "members":{ "ModelPackageName":{ "shape":"VersionedArnOrName", "documentation":"The name of the model package to describe.
" } } }, "DescribeModelPackageOutput":{ "type":"structure", "required":[ "ModelPackageName", "ModelPackageArn", "CreationTime", "ModelPackageStatus", "ModelPackageStatusDetails" ], "members":{ "ModelPackageName":{ "shape":"EntityName", "documentation":"The name of the model package being described.
" }, "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"If the model is a versioned model, the name of the model group that the versioned model belongs to.
" }, "ModelPackageVersion":{ "shape":"ModelPackageVersion", "documentation":"The version of the model package.
" }, "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the model package.
" }, "ModelPackageDescription":{ "shape":"EntityDescription", "documentation":"A brief summary of the model package.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp specifying when the model package was created.
" }, "InferenceSpecification":{ "shape":"InferenceSpecification", "documentation":"Details about inference jobs that can be run with models based on this model package.
" }, "SourceAlgorithmSpecification":{ "shape":"SourceAlgorithmSpecification", "documentation":"Details about the algorithm that was used to create the model package.
" }, "ValidationSpecification":{ "shape":"ModelPackageValidationSpecification", "documentation":"Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
" }, "ModelPackageStatus":{ "shape":"ModelPackageStatus", "documentation":"The current status of the model package.
" }, "ModelPackageStatusDetails":{ "shape":"ModelPackageStatusDetails", "documentation":"Details about the current status of the model package.
" }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", "documentation":"Whether the model package is certified for listing on AWS Marketplace.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"The approval status of the model package.
" }, "CreatedBy":{"shape":"UserContext"}, "MetadataProperties":{"shape":"MetadataProperties"}, "ModelMetrics":{ "shape":"ModelMetrics", "documentation":"Metrics for the model.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last time the model package was modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "ApprovalDescription":{ "shape":"ApprovalDescription", "documentation":"A description provided for the model approval.
" } } }, "DescribeModelQualityJobDefinitionRequest":{ "type":"structure", "required":["JobDefinitionName"], "members":{ "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the model quality job. The name must be unique within an AWS Region in the AWS account.
" } } }, "DescribeModelQualityJobDefinitionResponse":{ "type":"structure", "required":[ "JobDefinitionArn", "JobDefinitionName", "CreationTime", "ModelQualityAppSpecification", "ModelQualityJobInput", "ModelQualityJobOutputConfig", "JobResources", "RoleArn" ], "members":{ "JobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the model quality job.
" }, "JobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the quality job definition. The name must be unique within an AWS Region in the AWS account.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the model quality job was created.
" }, "ModelQualityBaselineConfig":{ "shape":"ModelQualityBaselineConfig", "documentation":"The baseline configuration for a model quality job.
" }, "ModelQualityAppSpecification":{ "shape":"ModelQualityAppSpecification", "documentation":"Configures the model quality job to run a specified Docker container image.
" }, "ModelQualityJobInput":{ "shape":"ModelQualityJobInput", "documentation":"Inputs for the model quality job.
" }, "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, "JobResources":{"shape":"MonitoringResources"}, "NetworkConfig":{ "shape":"MonitoringNetworkConfig", "documentation":"Networking options for a model quality job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "StoppingCondition":{"shape":"MonitoringStoppingCondition"} } }, "DescribeMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"Name of a previously created monitoring schedule.
" } } }, "DescribeMonitoringScheduleResponse":{ "type":"structure", "required":[ "MonitoringScheduleArn", "MonitoringScheduleName", "MonitoringScheduleStatus", "CreationTime", "LastModifiedTime", "MonitoringScheduleConfig" ], "members":{ "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring schedule.
" }, "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"Name of the monitoring schedule.
" }, "MonitoringScheduleStatus":{ "shape":"ScheduleStatus", "documentation":"The status of an monitoring job.
" }, "MonitoringType":{ "shape":"MonitoringType", "documentation":"The type of the monitoring job that this schedule runs. This is one of the following values.
DATA_QUALITY - The schedule is for a data quality monitoring job.
MODEL_QUALITY - The schedule is for a model quality monitoring job.
MODEL_BIAS - The schedule is for a bias monitoring job.
MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.
A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the monitoring job was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time at which the monitoring job was last modified.
" }, "MonitoringScheduleConfig":{ "shape":"MonitoringScheduleConfig", "documentation":"The configuration object that specifies the monitoring schedule and defines the monitoring job.
" }, "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint for the monitoring job.
" }, "LastMonitoringExecutionSummary":{ "shape":"MonitoringExecutionSummary", "documentation":"Describes metadata on the last execution to run, if there was one.
" } } }, "DescribeNotebookInstanceInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance that you want information about.
" } } }, "DescribeNotebookInstanceLifecycleConfigInput":{ "type":"structure", "required":["NotebookInstanceLifecycleConfigName"], "members":{ "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"The name of the lifecycle configuration to describe.
" } } }, "DescribeNotebookInstanceLifecycleConfigOutput":{ "type":"structure", "members":{ "NotebookInstanceLifecycleConfigArn":{ "shape":"NotebookInstanceLifecycleConfigArn", "documentation":"The Amazon Resource Name (ARN) of the lifecycle configuration.
" }, "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"The name of the lifecycle configuration.
" }, "OnCreate":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"The shell script that runs only once, when you create a notebook instance.
" }, "OnStart":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"The shell script that runs every time you start a notebook instance, including when you create the notebook instance.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"A timestamp that tells when the lifecycle configuration was last modified.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp that tells when the lifecycle configuration was created.
" } } }, "DescribeNotebookInstanceOutput":{ "type":"structure", "members":{ "NotebookInstanceArn":{ "shape":"NotebookInstanceArn", "documentation":"The Amazon Resource Name (ARN) of the notebook instance.
" }, "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the Amazon SageMaker notebook instance.
" }, "NotebookInstanceStatus":{ "shape":"NotebookInstanceStatus", "documentation":"The status of the notebook instance.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If status is Failed, the reason it failed.
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
" }, "InstanceType":{ "shape":"InstanceType", "documentation":"The type of ML compute instance running on the notebook instance.
" }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the VPC subnet.
" }, "SecurityGroups":{ "shape":"SecurityGroupIds", "documentation":"The IDs of the VPC security groups.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role associated with the instance.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The network interface IDs that Amazon SageMaker created at the time of creating the instance.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp. Use this parameter to return the time when the notebook instance was created
" }, "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"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
" }, "DirectInternetAccess":{ "shape":"DirectInternetAccess", "documentation":"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.
" }, "VolumeSizeInGB":{ "shape":"NotebookInstanceVolumeSizeInGB", "documentation":"The size, in GB, of the ML storage volume attached to the notebook instance.
" }, "AcceleratorTypes":{ "shape":"NotebookInstanceAcceleratorTypes", "documentation":"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.
" }, "DefaultCodeRepository":{ "shape":"CodeRepositoryNameOrUrl", "documentation":"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.
" }, "AdditionalCodeRepositories":{ "shape":"AdditionalCodeRepositoryNamesOrUrls", "documentation":"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.
" }, "RootAccess":{ "shape":"RootAccess", "documentation":"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.
The Amazon Resource Name (ARN) of the pipeline execution.
" } } }, "DescribePipelineDefinitionForExecutionResponse":{ "type":"structure", "members":{ "PipelineDefinition":{ "shape":"PipelineDefinition", "documentation":"The JSON pipeline definition.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline was created.
" } } }, "DescribePipelineExecutionRequest":{ "type":"structure", "required":["PipelineExecutionArn"], "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" } } }, "DescribePipelineExecutionResponse":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" }, "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" }, "PipelineExecutionDisplayName":{ "shape":"PipelineExecutionName", "documentation":"The display name of the pipeline execution.
" }, "PipelineExecutionStatus":{ "shape":"PipelineExecutionStatus", "documentation":"The status of the pipeline execution.
" }, "PipelineExecutionDescription":{ "shape":"PipelineExecutionDescription", "documentation":"The description of the pipeline execution.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline execution was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline execution was modified last.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedBy":{"shape":"UserContext"} } }, "DescribePipelineRequest":{ "type":"structure", "required":["PipelineName"], "members":{ "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline to describe.
" } } }, "DescribePipelineResponse":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" }, "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline.
" }, "PipelineDisplayName":{ "shape":"PipelineName", "documentation":"The display name of the pipeline.
" }, "PipelineDefinition":{ "shape":"PipelineDefinition", "documentation":"The JSON pipeline definition.
" }, "PipelineDescription":{ "shape":"PipelineDescription", "documentation":"The description of the pipeline.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that the pipeline uses to execute.
" }, "PipelineStatus":{ "shape":"PipelineStatus", "documentation":"The status of the pipeline execution.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline was last modified.
" }, "LastRunTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline was last run.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedBy":{"shape":"UserContext"} } }, "DescribeProcessingJobRequest":{ "type":"structure", "required":["ProcessingJobName"], "members":{ "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job. The name must be unique within an AWS Region in the AWS account.
" } } }, "DescribeProcessingJobResponse":{ "type":"structure", "required":[ "ProcessingJobName", "ProcessingResources", "AppSpecification", "ProcessingJobArn", "ProcessingJobStatus", "CreationTime" ], "members":{ "ProcessingInputs":{ "shape":"ProcessingInputs", "documentation":"The inputs for a processing job.
" }, "ProcessingOutputConfig":{ "shape":"ProcessingOutputConfig", "documentation":"Output configuration for the processing job.
" }, "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job. The name must be unique within an AWS Region in the AWS account.
" }, "ProcessingResources":{ "shape":"ProcessingResources", "documentation":"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.
" }, "StoppingCondition":{ "shape":"ProcessingStoppingCondition", "documentation":"The time limit for how long the processing job is allowed to run.
" }, "AppSpecification":{ "shape":"AppSpecification", "documentation":"Configures the processing job to run a specified container image.
" }, "Environment":{ "shape":"ProcessingEnvironmentMap", "documentation":"The environment variables set in the Docker container.
" }, "NetworkConfig":{ "shape":"NetworkConfig", "documentation":"Networking options for a processing job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" }, "ExperimentConfig":{ "shape":"ExperimentConfig", "documentation":"The configuration information used to create an experiment.
" }, "ProcessingJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the processing job.
" }, "ProcessingJobStatus":{ "shape":"ProcessingJobStatus", "documentation":"Provides the status of a processing job.
" }, "ExitMessage":{ "shape":"ExitMessage", "documentation":"An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" }, "ProcessingEndTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job completed.
" }, "ProcessingStartTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job started.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job was last modified.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job was created.
" }, "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The ARN of a monitoring schedule for an endpoint associated with this processing job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The ARN of an AutoML job associated with this processing job.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The ARN of a training job associated with this processing job.
" } } }, "DescribeProjectInput":{ "type":"structure", "required":["ProjectName"], "members":{ "ProjectName":{ "shape":"ProjectEntityName", "documentation":"The name of the project to describe.
" } } }, "DescribeProjectOutput":{ "type":"structure", "required":[ "ProjectArn", "ProjectName", "ProjectId", "ServiceCatalogProvisioningDetails", "ProjectStatus", "CreationTime" ], "members":{ "ProjectArn":{ "shape":"ProjectArn", "documentation":"The Amazon Resource Name (ARN) of the project.
" }, "ProjectName":{ "shape":"ProjectEntityName", "documentation":"The name of the project.
" }, "ProjectId":{ "shape":"ProjectId", "documentation":"The ID of the project.
" }, "ProjectDescription":{ "shape":"EntityDescription", "documentation":"The description of the project.
" }, "ServiceCatalogProvisioningDetails":{ "shape":"ServiceCatalogProvisioningDetails", "documentation":"Information used to provision a service catalog product. For information, see What is AWS Service Catalog.
" }, "ServiceCatalogProvisionedProductDetails":{ "shape":"ServiceCatalogProvisionedProductDetails", "documentation":"Information about a provisioned service catalog product.
" }, "ProjectStatus":{ "shape":"ProjectStatus", "documentation":"The status of the project.
" }, "CreatedBy":{"shape":"UserContext"}, "CreationTime":{ "shape":"Timestamp", "documentation":"The time when the project was created.
" } } }, "DescribeSubscribedWorkteamRequest":{ "type":"structure", "required":["WorkteamArn"], "members":{ "WorkteamArn":{ "shape":"WorkteamArn", "documentation":"The Amazon Resource Name (ARN) of the subscribed work team to describe.
" } } }, "DescribeSubscribedWorkteamResponse":{ "type":"structure", "required":["SubscribedWorkteam"], "members":{ "SubscribedWorkteam":{ "shape":"SubscribedWorkteam", "documentation":"A Workteam instance that contains information about the work team.
The name of the training job.
" } } }, "DescribeTrainingJobResponse":{ "type":"structure", "required":[ "TrainingJobName", "TrainingJobArn", "ModelArtifacts", "TrainingJobStatus", "SecondaryStatus", "AlgorithmSpecification", "ResourceConfig", "StoppingCondition", "CreationTime" ], "members":{ "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"Name of the model training job.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" }, "TuningJobArn":{ "shape":"HyperParameterTuningJobArn", "documentation":"The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
" }, "LabelingJobArn":{ "shape":"LabelingJobArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The Amazon Resource Name (ARN) of an AutoML job.
" }, "ModelArtifacts":{ "shape":"ModelArtifacts", "documentation":"Information about the Amazon S3 location that is configured for storing model artifacts.
" }, "TrainingJobStatus":{ "shape":"TrainingJobStatus", "documentation":"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.
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:
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 - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
If the training job failed, the reason it failed.
" }, "HyperParameters":{ "shape":"HyperParameters", "documentation":"Algorithm-specific parameters.
" }, "AlgorithmSpecification":{ "shape":"AlgorithmSpecification", "documentation":"Information about the algorithm used for training, and algorithm metadata.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The AWS Identity and Access Management (IAM) role configured for the training job.
" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"An array of Channel objects that describes each data input channel.
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
" }, "ResourceConfig":{ "shape":"ResourceConfig", "documentation":"Resources, including ML compute instances and ML storage volumes, that are configured for model training.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"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.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
A timestamp that indicates when the training job was created.
" }, "TrainingStartTime":{ "shape":"Timestamp", "documentation":"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.
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.
A timestamp that indicates when the status of the training job was last modified.
" }, "SecondaryStatusTransitions":{ "shape":"SecondaryStatusTransitions", "documentation":"A history of all of the secondary statuses that the training job has transitioned through.
" }, "FinalMetricDataList":{ "shape":"FinalMetricDataList", "documentation":"A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.
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.
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.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
The training time in seconds.
" }, "BillableTimeInSeconds":{ "shape":"BillableTimeInSeconds", "documentation":"The billable time in seconds. Billable time refers to the absolute wall-clock time.
Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time Amazon SageMaker will bill you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .
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%.
Configuration information for Debugger rules for debugging output tensors.
" }, "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, "DebugRuleEvaluationStatuses":{ "shape":"DebugRuleEvaluationStatuses", "documentation":"Evaluation status of Debugger rules for debugging on a training job.
" }, "ProfilerConfig":{"shape":"ProfilerConfig"}, "ProfilerRuleConfigurations":{ "shape":"ProfilerRuleConfigurations", "documentation":"Configuration information for Debugger rules for profiling system and framework metrics.
" }, "ProfilerRuleEvaluationStatuses":{ "shape":"ProfilerRuleEvaluationStatuses", "documentation":"Evaluation status of Debugger rules for profiling on a training job.
" }, "ProfilingStatus":{ "shape":"ProfilingStatus", "documentation":"Profiling status of a training job.
" } } }, "DescribeTransformJobRequest":{ "type":"structure", "required":["TransformJobName"], "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job that you want to view details of.
" } } }, "DescribeTransformJobResponse":{ "type":"structure", "required":[ "TransformJobName", "TransformJobArn", "TransformJobStatus", "ModelName", "TransformInput", "TransformResources", "CreationTime" ], "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job.
" }, "TransformJobArn":{ "shape":"TransformJobArn", "documentation":"The Amazon Resource Name (ARN) of the transform job.
" }, "TransformJobStatus":{ "shape":"TransformJobStatus", "documentation":"The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.
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.
The name of the model used in the transform job.
" }, "MaxConcurrentTransforms":{ "shape":"MaxConcurrentTransforms", "documentation":"The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.
" }, "ModelClientConfig":{ "shape":"ModelClientConfig", "documentation":"The timeout and maximum number of retries for processing a transform job invocation.
" }, "MaxPayloadInMB":{ "shape":"MaxPayloadInMB", "documentation":"The maximum payload size, in MB, used in the transform job.
" }, "BatchStrategy":{ "shape":"BatchStrategy", "documentation":"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.
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" }, "TransformInput":{ "shape":"TransformInput", "documentation":"Describes the dataset to be transformed and the Amazon S3 location where it is stored.
" }, "TransformOutput":{ "shape":"TransformOutput", "documentation":"Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
" }, "TransformResources":{ "shape":"TransformResources", "documentation":"Describes the resources, including ML instance types and ML instance count, to use for the transform job.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the transform Job was created.
" }, "TransformStartTime":{ "shape":"Timestamp", "documentation":"Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
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.
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The Amazon Resource Name (ARN) of the AutoML transform job.
" }, "DataProcessing":{"shape":"DataProcessing"}, "ExperimentConfig":{"shape":"ExperimentConfig"} } }, "DescribeTrialComponentRequest":{ "type":"structure", "required":["TrialComponentName"], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial component to describe.
" } } }, "DescribeTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial component.
" }, "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the trial component.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" }, "Status":{ "shape":"TrialComponentStatus", "documentation":"The status of the component. States include:
InProgress
Completed
Failed
When the component started.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"When the component ended.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the component was created.
" }, "CreatedBy":{ "shape":"UserContext", "documentation":"Who created the component.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the component was last modified.
" }, "LastModifiedBy":{ "shape":"UserContext", "documentation":"Who last modified the component.
" }, "Parameters":{ "shape":"TrialComponentParameters", "documentation":"The hyperparameters of the component.
" }, "InputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The input artifacts of the component.
" }, "OutputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The output artifacts of the component.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "Metrics":{ "shape":"TrialComponentMetricSummaries", "documentation":"The metrics for the component.
" } } }, "DescribeTrialRequest":{ "type":"structure", "required":["TrialName"], "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial to describe.
" } } }, "DescribeTrialResponse":{ "type":"structure", "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial.
" }, "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
The name of the experiment the trial is part of.
" }, "Source":{ "shape":"TrialSource", "documentation":"The Amazon Resource Name (ARN) of the source and, optionally, the job type.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the trial was created.
" }, "CreatedBy":{ "shape":"UserContext", "documentation":"Who created the trial.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the trial was last modified.
" }, "LastModifiedBy":{ "shape":"UserContext", "documentation":"Who last modified the trial.
" }, "MetadataProperties":{"shape":"MetadataProperties"} } }, "DescribeUserProfileRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" } } }, "DescribeUserProfileResponse":{ "type":"structure", "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The ID of the domain that contains the profile.
" }, "UserProfileArn":{ "shape":"UserProfileArn", "documentation":"The user profile Amazon Resource Name (ARN).
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "HomeEfsFileSystemUid":{ "shape":"EfsUid", "documentation":"The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
" }, "Status":{ "shape":"UserProfileStatus", "documentation":"The status.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The last modified time.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The failure reason.
" }, "SingleSignOnUserIdentifier":{ "shape":"SingleSignOnUserIdentifier", "documentation":"The SSO user identifier.
" }, "SingleSignOnUserValue":{ "shape":"String256", "documentation":"The SSO user value.
" }, "UserSettings":{ "shape":"UserSettings", "documentation":"A collection of settings.
" } } }, "DescribeWorkforceRequest":{ "type":"structure", "required":["WorkforceName"], "members":{ "WorkforceName":{ "shape":"WorkforceName", "documentation":"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.
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.
" } } }, "DescribeWorkteamRequest":{ "type":"structure", "required":["WorkteamName"], "members":{ "WorkteamName":{ "shape":"WorkteamName", "documentation":"The name of the work team to return a description of.
" } } }, "DescribeWorkteamResponse":{ "type":"structure", "required":["Workteam"], "members":{ "Workteam":{ "shape":"Workteam", "documentation":"A Workteam instance that contains information about the work team.
The name of the variant to update.
" }, "DesiredWeight":{ "shape":"VariantWeight", "documentation":"The variant's weight.
" }, "DesiredInstanceCount":{ "shape":"TaskCount", "documentation":"The variant's capacity.
" } }, "documentation":"Specifies weight and capacity values for a production variant.
" }, "DesiredWeightAndCapacityList":{ "type":"list", "member":{"shape":"DesiredWeightAndCapacity"}, "min":1 }, "DestinationS3Uri":{ "type":"string", "max":512, "pattern":"^(https|s3)://([^/])/?(.*)$" }, "DetailedAlgorithmStatus":{ "type":"string", "enum":[ "NotStarted", "InProgress", "Completed", "Failed" ] }, "DetailedModelPackageStatus":{ "type":"string", "enum":[ "NotStarted", "InProgress", "Completed", "Failed" ] }, "Device":{ "type":"structure", "required":["DeviceName"], "members":{ "DeviceName":{ "shape":"DeviceName", "documentation":"The name of the device.
" }, "Description":{ "shape":"DeviceDescription", "documentation":"Description of the device.
" }, "IotThingName":{ "shape":"ThingName", "documentation":"AWS Internet of Things (IoT) object name.
" } }, "documentation":"Information of a particular device.
" }, "DeviceArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "DeviceDescription":{ "type":"string", "max":40, "min":1, "pattern":"[\\S\\s]+" }, "DeviceFleetArn":{ "type":"string", "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "DeviceFleetDescription":{ "type":"string", "max":800, "min":1, "pattern":"[\\S\\s]+" }, "DeviceFleetSummaries":{ "type":"list", "member":{"shape":"DeviceFleetSummary"} }, "DeviceFleetSummary":{ "type":"structure", "required":[ "DeviceFleetArn", "DeviceFleetName" ], "members":{ "DeviceFleetArn":{ "shape":"DeviceFleetArn", "documentation":"Amazon Resource Name (ARN) of the device fleet.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"Name of the device fleet.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Timestamp of when the device fleet was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Timestamp of when the device fleet was last updated.
" } }, "documentation":"Summary of the device fleet.
" }, "DeviceName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" }, "DeviceNames":{ "type":"list", "member":{"shape":"DeviceName"} }, "DeviceStats":{ "type":"structure", "required":[ "ConnectedDeviceCount", "RegisteredDeviceCount" ], "members":{ "ConnectedDeviceCount":{ "shape":"Long", "documentation":"The number of devices connected with a heartbeat.
" }, "RegisteredDeviceCount":{ "shape":"Long", "documentation":"The number of registered devices.
" } }, "documentation":"Status of devices.
" }, "DeviceSummaries":{ "type":"list", "member":{"shape":"DeviceSummary"} }, "DeviceSummary":{ "type":"structure", "required":[ "DeviceName", "DeviceArn" ], "members":{ "DeviceName":{ "shape":"EntityName", "documentation":"The unique identifier of the device.
" }, "DeviceArn":{ "shape":"DeviceArn", "documentation":"Amazon Resource Name (ARN) of the device.
" }, "Description":{ "shape":"DeviceDescription", "documentation":"A description of the device.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet the device belongs to.
" }, "IotThingName":{ "shape":"ThingName", "documentation":"The AWS Internet of Things (IoT) object thing name associated with the device..
" }, "RegistrationTime":{ "shape":"Timestamp", "documentation":"The timestamp of the last registration or de-reregistration.
" }, "LatestHeartbeat":{ "shape":"Timestamp", "documentation":"The last heartbeat received from the device.
" }, "Models":{ "shape":"EdgeModelSummaries", "documentation":"Models on the device.
" } }, "documentation":"Summary of the device.
" }, "Devices":{ "type":"list", "member":{"shape":"Device"} }, "DirectInternetAccess":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "DirectoryPath":{ "type":"string", "max":4096, "pattern":".*" }, "DisableProfiler":{"type":"boolean"}, "DisableSagemakerServicecatalogPortfolioInput":{ "type":"structure", "members":{ } }, "DisableSagemakerServicecatalogPortfolioOutput":{ "type":"structure", "members":{ } }, "DisassociateAdditionalCodeRepositories":{"type":"boolean"}, "DisassociateDefaultCodeRepository":{"type":"boolean"}, "DisassociateNotebookInstanceAcceleratorTypes":{"type":"boolean"}, "DisassociateNotebookInstanceLifecycleConfig":{"type":"boolean"}, "DisassociateTrialComponentRequest":{ "type":"structure", "required":[ "TrialComponentName", "TrialName" ], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component to disassociate from the trial.
" }, "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial to disassociate from.
" } } }, "DisassociateTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The ARN of the trial component.
" }, "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" } } }, "Dollars":{ "type":"integer", "max":2, "min":0 }, "DomainArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*" }, "DomainDetails":{ "type":"structure", "members":{ "DomainArn":{ "shape":"DomainArn", "documentation":"The domain's Amazon Resource Name (ARN).
" }, "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "DomainName":{ "shape":"DomainName", "documentation":"The domain name.
" }, "Status":{ "shape":"DomainStatus", "documentation":"The status.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The last modified time.
" }, "Url":{ "shape":"String1024", "documentation":"The domain's URL.
" } }, "documentation":"The domain's details.
" }, "DomainId":{ "type":"string", "max":63 }, "DomainList":{ "type":"list", "member":{"shape":"DomainDetails"} }, "DomainName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "DomainStatus":{ "type":"string", "enum":[ "Deleting", "Failed", "InService", "Pending", "Updating", "Update_Failed", "Delete_Failed" ] }, "DoubleParameterValue":{"type":"double"}, "EdgeModel":{ "type":"structure", "required":[ "ModelName", "ModelVersion" ], "members":{ "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The model version.
" }, "LatestSampleTime":{ "shape":"Timestamp", "documentation":"The timestamp of the last data sample taken.
" }, "LatestInference":{ "shape":"Timestamp", "documentation":"The timestamp of the last inference that was made.
" } }, "documentation":"The model on the edge device.
" }, "EdgeModelStat":{ "type":"structure", "required":[ "ModelName", "ModelVersion", "OfflineDeviceCount", "ConnectedDeviceCount", "ActiveDeviceCount", "SamplingDeviceCount" ], "members":{ "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The model version.
" }, "OfflineDeviceCount":{ "shape":"Long", "documentation":"The number of devices that have this model version and do not have a heart beat.
" }, "ConnectedDeviceCount":{ "shape":"Long", "documentation":"The number of devices that have this model version and have a heart beat.
" }, "ActiveDeviceCount":{ "shape":"Long", "documentation":"The number of devices that have this model version, a heart beat, and are currently running.
" }, "SamplingDeviceCount":{ "shape":"Long", "documentation":"The number of devices with this model version and are producing sample data.
" } }, "documentation":"Status of edge devices with this model.
" }, "EdgeModelStats":{ "type":"list", "member":{"shape":"EdgeModelStat"} }, "EdgeModelSummaries":{ "type":"list", "member":{"shape":"EdgeModelSummary"} }, "EdgeModelSummary":{ "type":"structure", "required":[ "ModelName", "ModelVersion" ], "members":{ "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The version model.
" } }, "documentation":"Summary of model on edge device.
" }, "EdgeModels":{ "type":"list", "member":{"shape":"EdgeModel"} }, "EdgeOutputConfig":{ "type":"structure", "required":["S3OutputLocation"], "members":{ "S3OutputLocation":{ "shape":"S3Uri", "documentation":"The Amazon Simple Storage (S3) bucker URI.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
" } }, "documentation":"The output configuration.
" }, "EdgePackagingJobArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "EdgePackagingJobStatus":{ "type":"string", "enum":[ "STARTING", "INPROGRESS", "COMPLETED", "FAILED", "STOPPING", "STOPPED" ] }, "EdgePackagingJobSummaries":{ "type":"list", "member":{"shape":"EdgePackagingJobSummary"} }, "EdgePackagingJobSummary":{ "type":"structure", "required":[ "EdgePackagingJobArn", "EdgePackagingJobName", "EdgePackagingJobStatus" ], "members":{ "EdgePackagingJobArn":{ "shape":"EdgePackagingJobArn", "documentation":"The Amazon Resource Name (ARN) of the edge packaging job.
" }, "EdgePackagingJobName":{ "shape":"EntityName", "documentation":"The name of the edge packaging job.
" }, "EdgePackagingJobStatus":{ "shape":"EdgePackagingJobStatus", "documentation":"The status of the edge packaging job.
" }, "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the SageMaker Neo compilation job.
" }, "ModelName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelVersion":{ "shape":"EdgeVersion", "documentation":"The version of the model.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The timestamp of when the job was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The timestamp of when the edge packaging job was last updated.
" } }, "documentation":"Summary of edge packaging job.
" }, "EdgeVersion":{ "type":"string", "max":30, "min":1, "pattern":"[a-zA-Z0-9\\ \\_\\.]+" }, "EfsUid":{ "type":"string", "max":10, "pattern":"\\d+" }, "EnableCapture":{"type":"boolean"}, "EnableSagemakerServicecatalogPortfolioInput":{ "type":"structure", "members":{ } }, "EnableSagemakerServicecatalogPortfolioOutput":{ "type":"structure", "members":{ } }, "Endpoint":{ "type":"structure", "required":[ "EndpointName", "EndpointArn", "EndpointConfigName", "EndpointStatus", "CreationTime", "LastModifiedTime" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint.
" }, "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint.
" }, "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The endpoint configuration associated with the endpoint.
" }, "ProductionVariants":{ "shape":"ProductionVariantSummaryList", "documentation":"A list of the production variants hosted on the endpoint. Each production variant is a model.
" }, "DataCaptureConfig":{"shape":"DataCaptureConfigSummary"}, "EndpointStatus":{ "shape":"EndpointStatus", "documentation":"The status of the endpoint.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the endpoint failed, the reason it failed.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the endpoint was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last time the endpoint was modified.
" }, "MonitoringSchedules":{ "shape":"MonitoringScheduleList", "documentation":"A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of the tags associated with the endpoint. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } }, "documentation":"A hosted endpoint for real-time inference.
" }, "EndpointArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*" }, "EndpointConfigArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*" }, "EndpointConfigName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "EndpointConfigNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "EndpointConfigSortKey":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "EndpointConfigSummary":{ "type":"structure", "required":[ "EndpointConfigName", "EndpointConfigArn", "CreationTime" ], "members":{ "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the endpoint configuration.
" }, "EndpointConfigArn":{ "shape":"EndpointConfigArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint configuration.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the endpoint configuration was created.
" } }, "documentation":"Provides summary information for an endpoint configuration.
" }, "EndpointConfigSummaryList":{ "type":"list", "member":{"shape":"EndpointConfigSummary"} }, "EndpointInput":{ "type":"structure", "required":[ "EndpointName", "LocalPath" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"An endpoint in customer's account which has enabled DataCaptureConfig enabled.
Path to the filesystem where the endpoint data is available to the container.
" }, "S3InputMode":{ "shape":"ProcessingS3InputMode", "documentation":"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.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated
The attributes of the input data that are the input features.
" }, "InferenceAttribute":{ "shape":"String", "documentation":"The attribute of the input data that represents the ground truth label.
" }, "ProbabilityAttribute":{ "shape":"String", "documentation":"In a classification problem, the attribute that represents the class probability.
" }, "ProbabilityThresholdAttribute":{ "shape":"ProbabilityThresholdAttribute", "documentation":"The threshold for the class probability to be evaluated as a positive result.
" }, "StartTimeOffset":{ "shape":"MonitoringTimeOffsetString", "documentation":"If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" }, "EndTimeOffset":{ "shape":"MonitoringTimeOffsetString", "documentation":"If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" } }, "documentation":"Input object for the endpoint
" }, "EndpointName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "EndpointNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "EndpointSortKey":{ "type":"string", "enum":[ "Name", "CreationTime", "Status" ] }, "EndpointStatus":{ "type":"string", "enum":[ "OutOfService", "Creating", "Updating", "SystemUpdating", "RollingBack", "InService", "Deleting", "Failed" ] }, "EndpointSummary":{ "type":"structure", "required":[ "EndpointName", "EndpointArn", "CreationTime", "LastModifiedTime", "EndpointStatus" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint.
" }, "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the endpoint was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the endpoint was last modified.
" }, "EndpointStatus":{ "shape":"EndpointStatus", "documentation":"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.
" } }, "documentation":"Provides summary information for an endpoint.
" }, "EndpointSummaryList":{ "type":"list", "member":{"shape":"EndpointSummary"} }, "EntityDescription":{ "type":"string", "max":1024, "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "EntityName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" }, "EnvironmentKey":{ "type":"string", "max":1024, "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" }, "EnvironmentMap":{ "type":"map", "key":{"shape":"EnvironmentKey"}, "value":{"shape":"EnvironmentValue"}, "max":16 }, "EnvironmentValue":{ "type":"string", "max":1024, "pattern":"[\\S\\s]*" }, "ExecutionStatus":{ "type":"string", "enum":[ "Pending", "Completed", "CompletedWithViolations", "InProgress", "Failed", "Stopping", "Stopped" ] }, "ExitMessage":{ "type":"string", "max":1024, "pattern":"[\\S\\s]*" }, "Experiment":{ "type":"structure", "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment.
" }, "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
The description of the experiment.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the experiment was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the experiment was last modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "Tags":{ "shape":"TagList", "documentation":"The list of tags that are associated with the experiment. You can use Search API to search on the tags.
" } }, "documentation":"The properties of an experiment as returned by the Search API.
" }, "ExperimentArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*" }, "ExperimentConfig":{ "type":"structure", "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of an existing experiment to associate the trial component with.
" }, "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
" }, "TrialComponentDisplayName":{ "shape":"ExperimentEntityName", "documentation":"The display name for the trial component. If this key isn't specified, the display name is the trial component name.
" } }, "documentation":"Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:
" }, "ExperimentDescription":{ "type":"string", "max":3072, "pattern":".*" }, "ExperimentEntityName":{ "type":"string", "max":120, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" }, "ExperimentSource":{ "type":"structure", "required":["SourceArn"], "members":{ "SourceArn":{ "shape":"ExperimentSourceArn", "documentation":"The Amazon Resource Name (ARN) of the source.
" }, "SourceType":{ "shape":"SourceType", "documentation":"The source type.
" } }, "documentation":"The source of the experiment.
" }, "ExperimentSourceArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "ExperimentSummaries":{ "type":"list", "member":{"shape":"ExperimentSummary"} }, "ExperimentSummary":{ "type":"structure", "members":{ "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment.
" }, "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.
When the experiment was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the experiment was last modified.
" } }, "documentation":"A summary of the properties of an experiment. To get the complete set of properties, call the DescribeExperiment API and provide the ExperimentName.
The explainability report for a model.
" } }, "documentation":"Contains explainability metrics for a model.
" }, "FailureReason":{ "type":"string", "max":1024 }, "FeatureDefinition":{ "type":"structure", "members":{ "FeatureName":{ "shape":"FeatureName", "documentation":"The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.
The value type of a feature. Valid values are Integral, Fractional, or String.
" } }, "documentation":"A list of features. You must include FeatureName and FeatureType. Valid feature FeatureTypes are Integral, Fractional and String.
The Amazon Resource Name (ARN) of a FeatureGroup.
The name of the FeatureGroup.
The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.
The name of the feature that stores the EventTime of a Record in a FeatureGroup.
A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.
A list of Features. Each Feature must include a FeatureName and a FeatureType.
Valid FeatureTypes are Integral, Fractional and String.
FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.
You can create up to 2,500 FeatureDefinitions per FeatureGroup.
The time a FeatureGroup was created.
The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.
" }, "FeatureGroupStatus":{ "shape":"FeatureGroupStatus", "documentation":"A FeatureGroup status.
The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.
A free form description of a FeatureGroup.
Tags used to define a FeatureGroup.
Amazon SageMaker Feature Store stores features in a collection called Feature Group. A Feature Group can be visualized as a table which has rows, with a unique identifier for each row where each column in the table is a feature. In principle, a Feature Group is composed of features and values per features.
" }, "FeatureGroupArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*" }, "FeatureGroupMaxResults":{ "type":"integer", "max":100, "min":1 }, "FeatureGroupName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" }, "FeatureGroupNameContains":{ "type":"string", "max":64, "min":1 }, "FeatureGroupSortBy":{ "type":"string", "enum":[ "Name", "FeatureGroupStatus", "OfflineStoreStatus", "CreationTime" ] }, "FeatureGroupSortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "FeatureGroupStatus":{ "type":"string", "enum":[ "Creating", "Created", "CreateFailed", "Deleting", "DeleteFailed" ] }, "FeatureGroupSummaries":{ "type":"list", "member":{"shape":"FeatureGroupSummary"} }, "FeatureGroupSummary":{ "type":"structure", "required":[ "FeatureGroupName", "FeatureGroupArn", "CreationTime" ], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupName", "documentation":"The name of FeatureGroup.
Unique identifier for the FeatureGroup.
A timestamp indicating the time of creation time of the FeatureGroup.
The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.
Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.
The name, Arn, CreationTime, FeatureGroup values, LastUpdatedTime and EnableOnlineStorage status of a FeatureGroup.
The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
" }, "DefaultUid":{ "shape":"DefaultUid", "documentation":"The default POSIX user ID (UID). If not specified, defaults to 1000.
The default POSIX group ID (GID). If not specified, defaults to 100.
The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
" }, "FileSystemDataSource":{ "type":"structure", "required":[ "FileSystemId", "FileSystemAccessMode", "FileSystemType", "DirectoryPath" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"The file system id.
" }, "FileSystemAccessMode":{ "shape":"FileSystemAccessMode", "documentation":"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.
The file system type.
" }, "DirectoryPath":{ "shape":"DirectoryPath", "documentation":"The full path to the directory to associate with the channel.
" } }, "documentation":"Specifies a file system data source for a channel.
" }, "FileSystemId":{ "type":"string", "min":11, "pattern":".*" }, "FileSystemType":{ "type":"string", "enum":[ "EFS", "FSxLustre" ] }, "Filter":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"ResourcePropertyName", "documentation":"A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The value of Name equals Value.
The value of Name doesn't equal Value.
The Name property exists.
The Name property does not exist.
The value of Name is greater than Value. Not supported for text properties.
The value of Name is greater than or equal to Value. Not supported for text properties.
The value of Name is less than Value. Not supported for text properties.
The value of Name is less than or equal to Value. Not supported for text properties.
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
The value of Name contains the string Value. Only supported for text properties.
A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:
Experiment.DisplayName
Experiment.ExperimentName
Experiment.Tags
Trial.DisplayName
Trial.TrialName
Trial.Tags
TrialComponent.DisplayName
TrialComponent.TrialComponentName
TrialComponent.Tags
TrialComponent.InputArtifacts
TrialComponent.OutputArtifacts
A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: \"'CONTAINS' operator usage limit of 1 exceeded.\"
A value used with Name and Operator to determine which resources 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.
A conditional statement for a search expression that includes a resource property, a Boolean operator, and a value. Resources that match the statement are returned in the results from the Search API.
If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GreaterThan\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LessThan\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form Tags.<key>.
The type of metric with the best result.
" }, "MetricName":{ "shape":"AutoMLMetricEnum", "documentation":"The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
" }, "Value":{ "shape":"MetricValue", "documentation":"The value of the metric with the best result.
" } }, "documentation":"The best candidate result from an AutoML training job.
" }, "FinalHyperParameterTuningJobObjectiveMetric":{ "type":"structure", "required":[ "MetricName", "Value" ], "members":{ "Type":{ "shape":"HyperParameterTuningJobObjectiveType", "documentation":"Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.
" }, "MetricName":{ "shape":"MetricName", "documentation":"The name of the objective metric.
" }, "Value":{ "shape":"MetricValue", "documentation":"The value of the objective metric.
" } }, "documentation":"Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
The Amazon S3 path where the object containing human output will be made available.
To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The Amazon Key Management Service (KMS) key ID for server-side encryption.
" } }, "documentation":"Contains information about where human output will be stored.
" }, "FlowDefinitionStatus":{ "type":"string", "enum":[ "Initializing", "Active", "Failed", "Deleting" ] }, "FlowDefinitionSummaries":{ "type":"list", "member":{"shape":"FlowDefinitionSummary"} }, "FlowDefinitionSummary":{ "type":"structure", "required":[ "FlowDefinitionName", "FlowDefinitionArn", "FlowDefinitionStatus", "CreationTime" ], "members":{ "FlowDefinitionName":{ "shape":"FlowDefinitionName", "documentation":"The name of the flow definition.
" }, "FlowDefinitionArn":{ "shape":"FlowDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the flow definition.
" }, "FlowDefinitionStatus":{ "shape":"FlowDefinitionStatus", "documentation":"The status of the flow definition. Valid values:
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The timestamp when SageMaker created the flow definition.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.
Contains summary information about the flow definition.
" }, "FlowDefinitionTaskAvailabilityLifetimeInSeconds":{ "type":"integer", "max":864000, "min":1 }, "FlowDefinitionTaskCount":{ "type":"integer", "max":3, "min":1 }, "FlowDefinitionTaskDescription":{ "type":"string", "max":255, "min":1, "pattern":".+" }, "FlowDefinitionTaskKeyword":{ "type":"string", "max":30, "min":1, "pattern":"^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" }, "FlowDefinitionTaskKeywords":{ "type":"list", "member":{"shape":"FlowDefinitionTaskKeyword"}, "max":5, "min":1 }, "FlowDefinitionTaskTimeLimitInSeconds":{ "type":"integer", "max":28800, "min":30 }, "FlowDefinitionTaskTitle":{ "type":"string", "max":128, "min":1, "pattern":"^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" }, "Framework":{ "type":"string", "enum":[ "TENSORFLOW", "KERAS", "MXNET", "ONNX", "PYTORCH", "XGBOOST", "TFLITE", "DARKNET", "SKLEARN" ] }, "FrameworkVersion":{ "type":"string", "max":10, "min":3, "pattern":"[0-9]\\.[A-Za-z0-9.]+" }, "GenerateCandidateDefinitionsOnly":{"type":"boolean"}, "GetDeviceFleetReportRequest":{ "type":"structure", "required":["DeviceFleetName"], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" } } }, "GetDeviceFleetReportResponse":{ "type":"structure", "required":[ "DeviceFleetArn", "DeviceFleetName" ], "members":{ "DeviceFleetArn":{ "shape":"DeviceFleetArn", "documentation":"The Amazon Resource Name (ARN) of the device.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"The output configuration for storing sample data collected by the fleet.
" }, "Description":{ "shape":"DeviceFleetDescription", "documentation":"Description of the fleet.
" }, "ReportGenerated":{ "shape":"Timestamp", "documentation":"Timestamp of when the report was generated.
" }, "DeviceStats":{ "shape":"DeviceStats", "documentation":"Status of devices.
" }, "AgentVersions":{ "shape":"AgentVersions", "documentation":"The versions of Edge Manager agent deployed on the fleet.
" }, "ModelStats":{ "shape":"EdgeModelStats", "documentation":"Status of model on device.
" } } }, "GetModelPackageGroupPolicyInput":{ "type":"structure", "required":["ModelPackageGroupName"], "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group for which to get the resource policy.
" } } }, "GetModelPackageGroupPolicyOutput":{ "type":"structure", "required":["ResourcePolicy"], "members":{ "ResourcePolicy":{ "shape":"PolicyString", "documentation":"The resource policy for the model group.
" } } }, "GetSagemakerServicecatalogPortfolioStatusInput":{ "type":"structure", "members":{ } }, "GetSagemakerServicecatalogPortfolioStatusOutput":{ "type":"structure", "members":{ "Status":{ "shape":"SagemakerServicecatalogStatus", "documentation":"Whether Service Catalog is enabled or disabled in SageMaker.
" } } }, "GetSearchSuggestionsRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceType", "documentation":"The name of the Amazon SageMaker resource to search for.
" }, "SuggestionQuery":{ "shape":"SuggestionQuery", "documentation":"Limits the property names that are included in the response.
" } } }, "GetSearchSuggestionsResponse":{ "type":"structure", "members":{ "PropertyNameSuggestions":{ "shape":"PropertyNameSuggestionList", "documentation":"A list of property names for a Resource that match a SuggestionQuery.
The URL where the Git repository is located.
" }, "Branch":{ "shape":"Branch", "documentation":"The default branch for the Git repository.
" }, "SecretArn":{ "shape":"SecretArn", "documentation":"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}
Specifies configuration details for a Git repository in your AWS account.
" }, "GitConfigForUpdate":{ "type":"structure", "members":{ "SecretArn":{ "shape":"SecretArn", "documentation":"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}
Specifies configuration details for a Git repository when the repository is updated.
" }, "GitConfigUrl":{ "type":"string", "pattern":"^https://([^/]+)/?(.*)$" }, "Group":{ "type":"string", "max":63, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "Groups":{ "type":"list", "member":{"shape":"Group"}, "max":10, "min":1 }, "HookParameters":{ "type":"map", "key":{"shape":"ConfigKey"}, "value":{"shape":"ConfigValue"}, "max":20, "min":0 }, "HumanLoopActivationConditions":{ "type":"string", "max":10240 }, "HumanLoopActivationConditionsConfig":{ "type":"structure", "required":["HumanLoopActivationConditions"], "members":{ "HumanLoopActivationConditions":{ "shape":"HumanLoopActivationConditions", "documentation":"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.
", "jsonvalue":true } }, "documentation":"Defines under what conditions SageMaker creates a human loop. Used within . See for the required format of activation conditions.
" }, "HumanLoopActivationConfig":{ "type":"structure", "required":["HumanLoopActivationConditionsConfig"], "members":{ "HumanLoopActivationConditionsConfig":{ "shape":"HumanLoopActivationConditionsConfig", "documentation":"Container structure for defining under what conditions SageMaker creates a human loop.
" } }, "documentation":"Provides information about how and under what conditions SageMaker creates a human loop. If HumanLoopActivationConfig is not given, then all requests go to humans.
Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.
" }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The Amazon Resource Name (ARN) of the human task user interface.
You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.
To learn how to create a custom HTML template, see Create Custom Worker Task Template.
To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.
" }, "TaskTitle":{ "shape":"FlowDefinitionTaskTitle", "documentation":"A title for the human worker task.
" }, "TaskDescription":{ "shape":"FlowDefinitionTaskDescription", "documentation":"A description for the human worker task.
" }, "TaskCount":{ "shape":"FlowDefinitionTaskCount", "documentation":"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.
The length of time that a task remains available for review by human workers.
" }, "TaskTimeLimitInSeconds":{ "shape":"FlowDefinitionTaskTimeLimitInSeconds", "documentation":"The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
" }, "TaskKeywords":{ "shape":"FlowDefinitionTaskKeywords", "documentation":"Keywords used to describe the task so that workers can discover the task.
" }, "PublicWorkforceTaskPrice":{"shape":"PublicWorkforceTaskPrice"} }, "documentation":"Describes the work to be performed by human workers.
" }, "HumanLoopRequestSource":{ "type":"structure", "required":["AwsManagedHumanLoopRequestSource"], "members":{ "AwsManagedHumanLoopRequestSource":{ "shape":"AwsManagedHumanLoopRequestSource", "documentation":"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:
" } }, "documentation":"Container for configuring the source of human task requests.
" }, "HumanTaskConfig":{ "type":"structure", "required":[ "WorkteamArn", "UiConfig", "PreHumanTaskLambdaArn", "TaskTitle", "TaskDescription", "NumberOfHumanWorkersPerDataObject", "TaskTimeLimitInSeconds", "AnnotationConsolidationConfig" ], "members":{ "WorkteamArn":{ "shape":"WorkteamArn", "documentation":"The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.
" }, "UiConfig":{ "shape":"UiConfig", "documentation":"Information about the user interface that workers use to complete the labeling task.
" }, "PreHumanTaskLambdaArn":{ "shape":"LambdaFunctionArn", "documentation":"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 built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.
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:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-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:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-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:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-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:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-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:PRE-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-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:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel
Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.
arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition
Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass
Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection
Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking
3D Point Cloud Modalities
Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.
3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection
3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking
3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.
arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation
Use the following ARNs for Label Verification and Adjustment Jobs
Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .
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:PRE-VerificationBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox
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:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox
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:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation
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:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation
Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection
Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking
3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection
3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking
3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.
arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation
arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation
Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
" }, "TaskTitle":{ "shape":"TaskTitle", "documentation":"A title for the task for your human workers.
" }, "TaskDescription":{ "shape":"TaskDescription", "documentation":"A description of the task for your human workers.
" }, "NumberOfHumanWorkersPerDataObject":{ "shape":"NumberOfHumanWorkersPerDataObject", "documentation":"The number of human workers that will label an object.
" }, "TaskTimeLimitInSeconds":{ "shape":"TaskTimeLimitInSeconds", "documentation":"The amount of time that a worker has to complete a task.
If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).
If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:
For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).
For 3D point cloud and video frame labeling jobs, the maximum is 7 days (604,800 seconds). If you want to change these limits, contact AWS Support.
The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.
If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).
If you choose a private or vendor workforce, the default value is 10 days (864,000 seconds). For most users, the maximum is also 10 days. If you want to change this limit, contact AWS Support.
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.
" }, "AnnotationConsolidationConfig":{ "shape":"AnnotationConsolidationConfig", "documentation":"Configures how labels are consolidated across human workers.
" }, "PublicWorkforceTaskPrice":{ "shape":"PublicWorkforceTaskPrice", "documentation":"The price that you pay for each task performed by an Amazon Mechanical Turk worker.
" } }, "documentation":"Information required for human workers to complete a labeling task.
" }, "HumanTaskUiArn":{ "type":"string", "max":1024, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-task-ui/.*" }, "HumanTaskUiName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-z0-9](-*[a-z0-9])*" }, "HumanTaskUiStatus":{ "type":"string", "enum":[ "Active", "Deleting" ] }, "HumanTaskUiSummaries":{ "type":"list", "member":{"shape":"HumanTaskUiSummary"} }, "HumanTaskUiSummary":{ "type":"structure", "required":[ "HumanTaskUiName", "HumanTaskUiArn", "CreationTime" ], "members":{ "HumanTaskUiName":{ "shape":"HumanTaskUiName", "documentation":"The name of the human task user interface.
" }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The Amazon Resource Name (ARN) of the human task user interface.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp when SageMaker created the human task user interface.
" } }, "documentation":"Container for human task user interface information.
" }, "HyperParameterAlgorithmSpecification":{ "type":"structure", "required":["TrainingInputMode"], "members":{ "TrainingImage":{ "shape":"AlgorithmImage", "documentation":" 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.
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.
" }, "AlgorithmName":{ "shape":"ArnOrName", "documentation":"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.
An array of MetricDefinition objects that specify the metrics that the algorithm emits.
" } }, "documentation":"Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.
" }, "HyperParameterKey":{ "type":"string", "max":256, "pattern":".*" }, "HyperParameterScalingType":{ "type":"string", "enum":[ "Auto", "Linear", "Logarithmic", "ReverseLogarithmic" ] }, "HyperParameterSpecification":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"ParameterName", "documentation":"The name of this hyperparameter. The name must be unique.
" }, "Description":{ "shape":"EntityDescription", "documentation":"A brief description of the hyperparameter.
" }, "Type":{ "shape":"ParameterType", "documentation":"The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.
The allowed range for this hyperparameter.
" }, "IsTunable":{ "shape":"Boolean", "documentation":"Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
" }, "IsRequired":{ "shape":"Boolean", "documentation":"Indicates whether this hyperparameter is required.
" }, "DefaultValue":{ "shape":"HyperParameterValue", "documentation":"The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.
" } }, "documentation":"Defines a hyperparameter to be used by an algorithm.
" }, "HyperParameterSpecifications":{ "type":"list", "member":{"shape":"HyperParameterSpecification"}, "max":100, "min":0 }, "HyperParameterTrainingJobDefinition":{ "type":"structure", "required":[ "AlgorithmSpecification", "RoleArn", "OutputDataConfig", "ResourceConfig", "StoppingCondition" ], "members":{ "DefinitionName":{ "shape":"HyperParameterTrainingJobDefinitionName", "documentation":"The job definition name.
" }, "TuningObjective":{"shape":"HyperParameterTuningJobObjective"}, "HyperParameterRanges":{"shape":"ParameterRanges"}, "StaticHyperParameters":{ "shape":"HyperParameters", "documentation":"Specifies the values of hyperparameters that do not change for the tuning job.
" }, "AlgorithmSpecification":{ "shape":"HyperParameterAlgorithmSpecification", "documentation":"The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.
" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"An array of Channel objects that specify the input for the training jobs that the tuning job launches.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"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.
" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.
" }, "ResourceConfig":{ "shape":"ResourceConfig", "documentation":"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.
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.
" }, "EnableNetworkIsolation":{ "shape":"Boolean", "documentation":"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.
" }, "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", "documentation":"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.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
Defines the training jobs launched by a hyperparameter tuning job.
" }, "HyperParameterTrainingJobDefinitionName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" }, "HyperParameterTrainingJobDefinitions":{ "type":"list", "member":{"shape":"HyperParameterTrainingJobDefinition"}, "max":10, "min":1 }, "HyperParameterTrainingJobSummaries":{ "type":"list", "member":{"shape":"HyperParameterTrainingJobSummary"} }, "HyperParameterTrainingJobSummary":{ "type":"structure", "required":[ "TrainingJobName", "TrainingJobArn", "CreationTime", "TrainingJobStatus", "TunedHyperParameters" ], "members":{ "TrainingJobDefinitionName":{ "shape":"HyperParameterTrainingJobDefinitionName", "documentation":"The training job definition name.
" }, "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"The name of the training job.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" }, "TuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The HyperParameter tuning job that launched the training job.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the training job was created.
" }, "TrainingStartTime":{ "shape":"Timestamp", "documentation":"The date and time that the training job started.
" }, "TrainingEndTime":{ "shape":"Timestamp", "documentation":"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.
The status of the training job.
" }, "TunedHyperParameters":{ "shape":"HyperParameters", "documentation":"A list of the hyperparameters for which you specified ranges to search.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The reason that the training job failed.
" }, "FinalHyperParameterTuningJobObjectiveMetric":{ "shape":"FinalHyperParameterTuningJobObjectiveMetric", "documentation":"The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
" }, "ObjectiveStatus":{ "shape":"ObjectiveStatus", "documentation":"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.
Specifies summary information about a training job.
" }, "HyperParameterTuningJobArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*" }, "HyperParameterTuningJobConfig":{ "type":"structure", "required":[ "Strategy", "ResourceLimits" ], "members":{ "Strategy":{ "shape":"HyperParameterTuningJobStrategyType", "documentation":"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.
The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
" }, "ResourceLimits":{ "shape":"ResourceLimits", "documentation":"The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
" }, "ParameterRanges":{ "shape":"ParameterRanges", "documentation":"The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
" }, "TrainingJobEarlyStoppingType":{ "shape":"TrainingJobEarlyStoppingType", "documentation":"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):
Training jobs launched by the hyperparameter tuning job do not use early stopping.
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.
The tuning job's completion criteria.
" } }, "documentation":"Configures a hyperparameter tuning job.
" }, "HyperParameterTuningJobName":{ "type":"string", "max":32, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" }, "HyperParameterTuningJobObjective":{ "type":"structure", "required":[ "Type", "MetricName" ], "members":{ "Type":{ "shape":"HyperParameterTuningJobObjectiveType", "documentation":"Whether to minimize or maximize the objective metric.
" }, "MetricName":{ "shape":"MetricName", "documentation":"The name of the metric to use for the objective metric.
" } }, "documentation":"Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.
The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model. Currently, the only supported value is Bayesian.
The name of the tuning job.
" }, "HyperParameterTuningJobArn":{ "shape":"HyperParameterTuningJobArn", "documentation":"The Amazon Resource Name (ARN) of the tuning job.
" }, "HyperParameterTuningJobStatus":{ "shape":"HyperParameterTuningJobStatus", "documentation":"The status of the tuning job.
" }, "Strategy":{ "shape":"HyperParameterTuningJobStrategyType", "documentation":"Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the tuning job was created.
" }, "HyperParameterTuningEndTime":{ "shape":"Timestamp", "documentation":"The date and time that the tuning job ended.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The date and time that the tuning job was modified.
" }, "TrainingJobStatusCounters":{ "shape":"TrainingJobStatusCounters", "documentation":"The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
" }, "ObjectiveStatusCounters":{ "shape":"ObjectiveStatusCounters", "documentation":"The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
" }, "ResourceLimits":{ "shape":"ResourceLimits", "documentation":"The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
" } }, "documentation":"Provides summary information about a hyperparameter tuning job.
" }, "HyperParameterTuningJobWarmStartConfig":{ "type":"structure", "required":[ "ParentHyperParameterTuningJobs", "WarmStartType" ], "members":{ "ParentHyperParameterTuningJobs":{ "shape":"ParentHyperParameterTuningJobs", "documentation":"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.
" }, "WarmStartType":{ "shape":"HyperParameterTuningJobWarmStartType", "documentation":"Specifies one of the following:
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.
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.
Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter 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, and the training job that performs the best 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.
When the image was created.
" }, "Description":{ "shape":"ImageDescription", "documentation":"The description of the image.
" }, "DisplayName":{ "shape":"ImageDisplayName", "documentation":"The name of the image as displayed.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"When a create, update, or delete operation fails, the reason for the failure.
" }, "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image.
" }, "ImageName":{ "shape":"ImageName", "documentation":"The name of the image.
" }, "ImageStatus":{ "shape":"ImageStatus", "documentation":"The status of the image.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the image was last modified.
" } }, "documentation":"A SageMaker image. A SageMaker image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker ImageVersion.
Set this to one of the following values:
Platform - The model image is hosted in Amazon ECR.
Vpc - The model image is hosted in a private Docker registry in your VPC.
(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.
Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
" }, "ImageContainerImage":{ "type":"string", "max":255, "min":1 }, "ImageDeleteProperty":{ "type":"string", "max":11, "min":1, "pattern":"(^DisplayName$)|(^Description$)" }, "ImageDeletePropertyList":{ "type":"list", "member":{"shape":"ImageDeleteProperty"}, "max":2 }, "ImageDescription":{ "type":"string", "max":512, "min":1, "pattern":".*" }, "ImageDigest":{ "type":"string", "max":72, "pattern":"^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" }, "ImageDisplayName":{ "type":"string", "max":128, "min":1, "pattern":"^\\S(.*\\S)?$" }, "ImageName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$" }, "ImageNameContains":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9\\-.]+$" }, "ImageSortBy":{ "type":"string", "enum":[ "CREATION_TIME", "LAST_MODIFIED_TIME", "IMAGE_NAME" ] }, "ImageSortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "ImageStatus":{ "type":"string", "enum":[ "CREATING", "CREATED", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED" ] }, "ImageUri":{ "type":"string", "max":255, "pattern":".*" }, "ImageVersion":{ "type":"structure", "required":[ "CreationTime", "ImageArn", "ImageVersionArn", "ImageVersionStatus", "LastModifiedTime", "Version" ], "members":{ "CreationTime":{ "shape":"Timestamp", "documentation":"When the version was created.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"When a create or delete operation fails, the reason for the failure.
" }, "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image the version is based on.
" }, "ImageVersionArn":{ "shape":"ImageVersionArn", "documentation":"The ARN of the version.
" }, "ImageVersionStatus":{ "shape":"ImageVersionStatus", "documentation":"The status of the version.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the version was last modified.
" }, "Version":{ "shape":"ImageVersionNumber", "documentation":"The version number.
" } }, "documentation":"A version of a SageMaker Image. A version represents an existing container image.
How containers in a multi-container are run. The following values are valid.
SERIAL - Containers run as a serial pipeline.
DIRECT - Only the individual container that you specify is run.
Specifies details about how containers in a multi-container endpoint are run.
" }, "InferenceExecutionMode":{ "type":"string", "enum":[ "Serial", "Direct" ] }, "InferenceSpecification":{ "type":"structure", "required":[ "Containers", "SupportedContentTypes", "SupportedResponseMIMETypes" ], "members":{ "Containers":{ "shape":"ModelPackageContainerDefinitionList", "documentation":"The Amazon ECR registry path of the Docker image that contains the inference code.
" }, "SupportedTransformInstanceTypes":{ "shape":"TransformInstanceTypes", "documentation":"A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
This parameter is required for unversioned models, and optional for versioned models.
" }, "SupportedRealtimeInferenceInstanceTypes":{ "shape":"RealtimeInferenceInstanceTypes", "documentation":"A list of the instance types that are used to generate inferences in real-time.
This parameter is required for unversioned models, and optional for versioned models.
" }, "SupportedContentTypes":{ "shape":"ContentTypes", "documentation":"The supported MIME types for the input data.
" }, "SupportedResponseMIMETypes":{ "shape":"ResponseMIMETypes", "documentation":"The supported MIME types for the output data.
" } }, "documentation":"Defines how to perform inference generation after a training job is run.
" }, "InputConfig":{ "type":"structure", "required":[ "S3Uri", "DataInputConfig", "Framework" ], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"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).
" }, "DataInputConfig":{ "shape":"DataInputConfig", "documentation":"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/DARKNET: 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.
DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):
shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:
Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}
Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}
default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}
type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.
bias: If the input type is an Image, you need to provide the bias vector.
scale: If the input type is an Image, you need to provide a scale factor.
CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:
Tensor type input:
\"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3]}}
Tensor type input without input name (PyTorch):
\"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224]}]
Image type input:
\"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\": [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}
\"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}
Image type input without input name (PyTorch):
\"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\": [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]
\"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}
Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.
For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow's default signature def key. For example:
\"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}
\"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}
For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:
\"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}
\"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}
Identifies the framework in which the model was trained. For example: TENSORFLOW.
" }, "FrameworkVersion":{ "shape":"FrameworkVersion", "documentation":"Specifies the framework version to use.
This API field is only supported for PyTorch framework versions 1.4, 1.5, and 1.6 for cloud instance target devices: ml_c4, ml_c5, ml_m4, ml_m5, ml_p2, ml_p3, and ml_g4dn.
Contains 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.
" }, "InputDataConfig":{ "type":"list", "member":{"shape":"Channel"}, "max":20, "min":1 }, "InputMode":{ "type":"string", "enum":[ "Pipe", "File" ] }, "InputModes":{ "type":"list", "member":{"shape":"TrainingInputMode"}, "min":1 }, "InstanceType":{ "type":"string", "enum":[ "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" ] }, "Integer":{"type":"integer"}, "IntegerParameterRange":{ "type":"structure", "required":[ "Name", "MinValue", "MaxValue" ], "members":{ "Name":{ "shape":"ParameterKey", "documentation":"The name of the hyperparameter to search.
" }, "MinValue":{ "shape":"ParameterValue", "documentation":"The minimum value of the hyperparameter to search.
" }, "MaxValue":{ "shape":"ParameterValue", "documentation":"The maximum value of the hyperparameter to search.
" }, "ScalingType":{ "shape":"HyperParameterScalingType", "documentation":"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:
Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
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.
For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
" }, "IntegerParameterRangeSpecification":{ "type":"structure", "required":[ "MinValue", "MaxValue" ], "members":{ "MinValue":{ "shape":"ParameterValue", "documentation":"The minimum integer value allowed.
" }, "MaxValue":{ "shape":"ParameterValue", "documentation":"The maximum integer value allowed.
" } }, "documentation":"Defines the possible values for an integer hyperparameter.
" }, "IntegerParameterRanges":{ "type":"list", "member":{"shape":"IntegerParameterRange"}, "max":20, "min":0 }, "InvocationsMaxRetries":{ "type":"integer", "max":3, "min":0 }, "InvocationsTimeoutInSeconds":{ "type":"integer", "max":3600, "min":1 }, "IotRoleAlias":{ "type":"string", "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "JobReferenceCode":{ "type":"string", "min":1, "pattern":".+" }, "JobReferenceCodeContains":{ "type":"string", "max":255, "min":1, "pattern":".+" }, "JoinSource":{ "type":"string", "enum":[ "Input", "None" ] }, "JsonContentType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" }, "JsonContentTypes":{ "type":"list", "member":{"shape":"JsonContentType"}, "max":10, "min":1 }, "JsonPath":{ "type":"string", "max":63, "min":0 }, "JupyterServerAppSettings":{ "type":"structure", "members":{ "DefaultResourceSpec":{ "shape":"ResourceSpec", "documentation":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
" } }, "documentation":"The JupyterServer app settings.
" }, "KernelDisplayName":{ "type":"string", "max":1024 }, "KernelGatewayAppSettings":{ "type":"structure", "members":{ "DefaultResourceSpec":{ "shape":"ResourceSpec", "documentation":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
" }, "CustomImages":{ "shape":"CustomImages", "documentation":"A list of custom SageMaker images that are configured to run as a KernelGateway app.
" } }, "documentation":"The KernelGateway app settings.
" }, "KernelGatewayImageConfig":{ "type":"structure", "required":["KernelSpecs"], "members":{ "KernelSpecs":{ "shape":"KernelSpecs", "documentation":"The specification of the Jupyter kernels in the image.
" }, "FileSystemConfig":{ "shape":"FileSystemConfig", "documentation":"The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
" } }, "documentation":"The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.
" }, "KernelName":{ "type":"string", "max":1024 }, "KernelSpec":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"KernelName", "documentation":"The name of the kernel.
" }, "DisplayName":{ "shape":"KernelDisplayName", "documentation":"The display name of the kernel.
" } }, "documentation":"The specification of a Jupyter kernel.
" }, "KernelSpecs":{ "type":"list", "member":{"shape":"KernelSpec"}, "max":1, "min":1 }, "KmsKeyId":{ "type":"string", "max":2048, "pattern":".*" }, "LabelAttributeName":{ "type":"string", "max":127, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}" }, "LabelCounter":{ "type":"integer", "min":0 }, "LabelCounters":{ "type":"structure", "members":{ "TotalLabeled":{ "shape":"LabelCounter", "documentation":"The total number of objects labeled.
" }, "HumanLabeled":{ "shape":"LabelCounter", "documentation":"The total number of objects labeled by a human worker.
" }, "MachineLabeled":{ "shape":"LabelCounter", "documentation":"The total number of objects labeled by automated data labeling.
" }, "FailedNonRetryableError":{ "shape":"LabelCounter", "documentation":"The total number of objects that could not be labeled due to an error.
" }, "Unlabeled":{ "shape":"LabelCounter", "documentation":"The total number of objects not yet labeled.
" } }, "documentation":"Provides a breakdown of the number of objects labeled.
" }, "LabelCountersForWorkteam":{ "type":"structure", "members":{ "HumanLabeled":{ "shape":"LabelCounter", "documentation":"The total number of data objects labeled by a human worker.
" }, "PendingHuman":{ "shape":"LabelCounter", "documentation":"The total number of data objects that need to be labeled by a human worker.
" }, "Total":{ "shape":"LabelCounter", "documentation":"The total number of tasks in the labeling job.
" } }, "documentation":"Provides counts for human-labeled tasks in the labeling job.
" }, "LabelingJobAlgorithmSpecificationArn":{ "type":"string", "max":2048, "pattern":"arn:.*" }, "LabelingJobAlgorithmsConfig":{ "type":"structure", "required":["LabelingJobAlgorithmSpecificationArn"], "members":{ "LabelingJobAlgorithmSpecificationArn":{ "shape":"LabelingJobAlgorithmSpecificationArn", "documentation":"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
At the end of an auto-label job Ground Truth sends the Amazon Resource Name (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.
" }, "LabelingJobResourceConfig":{ "shape":"LabelingJobResourceConfig", "documentation":"Provides configuration information for a labeling job.
" } }, "documentation":"Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.
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.
" } }, "documentation":"Attributes of the data specified by the customer. Use these to describe the data to be labeled.
" }, "LabelingJobDataSource":{ "type":"structure", "members":{ "S3DataSource":{ "shape":"LabelingJobS3DataSource", "documentation":"The Amazon S3 location of the input data objects.
" }, "SnsDataSource":{ "shape":"LabelingJobSnsDataSource", "documentation":"An Amazon SNS data source used for streaming labeling jobs.
" } }, "documentation":"Provides information about the location of input data.
You must specify at least one of the following: S3DataSource or SnsDataSource.
Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job.
Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.
The name of the labeling job that the work team is assigned to.
" }, "JobReferenceCode":{ "shape":"JobReferenceCode", "documentation":"A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
" }, "WorkRequesterAccountId":{ "shape":"AccountId", "documentation":"" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the labeling job was created.
" }, "LabelCounters":{ "shape":"LabelCountersForWorkteam", "documentation":"Provides information about the progress of a labeling job.
" }, "NumberOfHumanWorkersPerDataObject":{ "shape":"NumberOfHumanWorkersPerDataObject", "documentation":"The configured number of workers per data object.
" } }, "documentation":"Provides summary information for a work team.
" }, "LabelingJobForWorkteamSummaryList":{ "type":"list", "member":{"shape":"LabelingJobForWorkteamSummary"} }, "LabelingJobInputConfig":{ "type":"structure", "required":["DataSource"], "members":{ "DataSource":{ "shape":"LabelingJobDataSource", "documentation":"The location of the input data.
" }, "DataAttributes":{ "shape":"LabelingJobDataAttributes", "documentation":"Attributes of the data specified by the customer.
" } }, "documentation":"Input configuration information for a labeling job.
" }, "LabelingJobName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "LabelingJobOutput":{ "type":"structure", "required":["OutputDatasetS3Uri"], "members":{ "OutputDatasetS3Uri":{ "shape":"S3Uri", "documentation":"The Amazon S3 bucket location of the manifest file for labeled data.
" }, "FinalActiveLearningModelArn":{ "shape":"ModelArn", "documentation":"The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.
" } }, "documentation":"Specifies the location of the output produced by the labeling job.
" }, "LabelingJobOutputConfig":{ "type":"structure", "required":["S3OutputPath"], "members":{ "S3OutputPath":{ "shape":"S3Uri", "documentation":"The Amazon S3 location to write output data.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
An Amazon Simple Notification Service (Amazon SNS) output topic ARN.
When workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.
You must provide a value for this parameter if you provide an Amazon SNS input topic in SnsDataSource in InputConfig.
Output configuration information for a labeling job.
" }, "LabelingJobResourceConfig":{ "type":"structure", "members":{ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"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\"
Provides configuration information for labeling jobs.
" }, "LabelingJobS3DataSource":{ "type":"structure", "required":["ManifestS3Uri"], "members":{ "ManifestS3Uri":{ "shape":"S3Uri", "documentation":"The Amazon S3 location of the manifest file that describes the input data objects.
The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:
source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.
source: The source of the object is the value. Use this value when the object is a text value.
If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.
" } }, "documentation":"The Amazon S3 location of the input data objects.
" }, "LabelingJobSnsDataSource":{ "type":"structure", "required":["SnsTopicArn"], "members":{ "SnsTopicArn":{ "shape":"SnsTopicArn", "documentation":"The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
If you specify an input topic for SnsTopicArn in InputConfig, you must specify a value for SnsTopicArn in OutputConfig.
An Amazon SNS data source used for streaming labeling jobs.
" }, "LabelingJobStatus":{ "type":"string", "enum":[ "Initializing", "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "LabelingJobStoppingConditions":{ "type":"structure", "members":{ "MaxHumanLabeledObjectCount":{ "shape":"MaxHumanLabeledObjectCount", "documentation":"The maximum number of objects that can be labeled by human workers.
" }, "MaxPercentageOfInputDatasetLabeled":{ "shape":"MaxPercentageOfInputDatasetLabeled", "documentation":"The maximum number of input data objects that should be labeled.
" } }, "documentation":"A set of conditions for stopping a 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.
Labeling jobs fail after 30 days with an appropriate client error message.
The name of the labeling job.
" }, "LabelingJobArn":{ "shape":"LabelingJobArn", "documentation":"The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The date and time that the job was created (timestamp).
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The date and time that the job was last modified (timestamp).
" }, "LabelingJobStatus":{ "shape":"LabelingJobStatus", "documentation":"The current status of the labeling job.
" }, "LabelCounters":{ "shape":"LabelCounters", "documentation":"Counts showing the progress of the labeling job.
" }, "WorkteamArn":{ "shape":"WorkteamArn", "documentation":"The Amazon Resource Name (ARN) of the work team assigned to the job.
" }, "PreHumanTaskLambdaArn":{ "shape":"LambdaFunctionArn", "documentation":"The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
" }, "AnnotationConsolidationLambdaArn":{ "shape":"LambdaFunctionArn", "documentation":"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.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the LabelingJobStatus field is Failed, this field contains a description of the error.
The location of the output produced by the labeling job.
" }, "InputConfig":{ "shape":"LabelingJobInputConfig", "documentation":"Input configuration for the labeling job.
" } }, "documentation":"Provides summary information about a labeling job.
" }, "LabelingJobSummaryList":{ "type":"list", "member":{"shape":"LabelingJobSummary"} }, "LambdaFunctionArn":{ "type":"string", "max":2048, "pattern":"arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*" }, "LastModifiedTime":{"type":"timestamp"}, "LineageEntityParameters":{ "type":"map", "key":{"shape":"StringParameterValue"}, "value":{"shape":"StringParameterValue"}, "max":30 }, "ListActionsRequest":{ "type":"structure", "members":{ "SourceUri":{ "shape":"SourceUri", "documentation":"A filter that returns only actions with the specified source URI.
" }, "ActionType":{ "shape":"String256", "documentation":"A filter that returns only actions of the specified type.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only actions created on or after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only actions created on or before the specified time.
" }, "SortBy":{ "shape":"SortActionsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.
The maximum number of actions to return in the response. The default value is 10.
" } } }, "ListActionsResponse":{ "type":"structure", "members":{ "ActionSummaries":{ "shape":"ActionSummaries", "documentation":"A list of actions and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of actions, if there are any.
" } } }, "ListAlgorithmsInput":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only algorithms created after the specified time (timestamp).
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only algorithms created before the specified time (timestamp).
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of algorithms to return in the response.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
The parameter by which to sort the results. The default is CreationTime.
The sort order for the results. The default is Ascending.
>An array of AlgorithmSummary objects, each of which lists an algorithm.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
" } } }, "ListAppImageConfigsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of AppImageConfigs to return in the response. The default value is 10.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.
A filter that returns only AppImageConfigs whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only AppImageConfigs created on or before the specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only AppImageConfigs created on or after the specified time.
" }, "ModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only AppImageConfigs modified on or before the specified time.
" }, "ModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only AppImageConfigs modified on or after the specified time.
" }, "SortBy":{ "shape":"AppImageConfigSortKey", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
A token for getting the next set of AppImageConfigs, if there are any.
" }, "AppImageConfigs":{ "shape":"AppImageConfigList", "documentation":"A list of AppImageConfigs and their properties.
" } } }, "ListAppsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Returns a list up to a specified limit.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"The sort order for the results. The default is Ascending.
" }, "SortBy":{ "shape":"AppSortKey", "documentation":"The parameter by which to sort the results. The default is CreationTime.
" }, "DomainIdEquals":{ "shape":"DomainId", "documentation":"A parameter to search for the domain ID.
" }, "UserProfileNameEquals":{ "shape":"UserProfileName", "documentation":"A parameter to search by user profile name.
" } } }, "ListAppsResponse":{ "type":"structure", "members":{ "Apps":{ "shape":"AppList", "documentation":"The list of apps.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListArtifactsRequest":{ "type":"structure", "members":{ "SourceUri":{ "shape":"SourceUri", "documentation":"A filter that returns only artifacts with the specified source URI.
" }, "ArtifactType":{ "shape":"String256", "documentation":"A filter that returns only artifacts of the specified type.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only artifacts created on or after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only artifacts created on or before the specified time.
" }, "SortBy":{ "shape":"SortArtifactsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.
The maximum number of artifacts to return in the response. The default value is 10.
" } } }, "ListArtifactsResponse":{ "type":"structure", "members":{ "ArtifactSummaries":{ "shape":"ArtifactSummaries", "documentation":"A list of artifacts and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of artifacts, if there are any.
" } } }, "ListAssociationsRequest":{ "type":"structure", "members":{ "SourceArn":{ "shape":"AssociationEntityArn", "documentation":"A filter that returns only associations with the specified source ARN.
" }, "DestinationArn":{ "shape":"AssociationEntityArn", "documentation":"A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
" }, "SourceType":{ "shape":"String256", "documentation":"A filter that returns only associations with the specified source type.
" }, "DestinationType":{ "shape":"String256", "documentation":"A filter that returns only associations with the specified destination type.
" }, "AssociationType":{ "shape":"AssociationEdgeType", "documentation":"A filter that returns only associations of the specified type.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only associations created on or after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only associations created on or before the specified time.
" }, "SortBy":{ "shape":"SortAssociationsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListAssociations didn't return the full set of associations, the call returns a token for getting the next set of associations.
The maximum number of associations to return in the response. The default value is 10.
" } } }, "ListAssociationsResponse":{ "type":"structure", "members":{ "AssociationSummaries":{ "shape":"AssociationSummaries", "documentation":"A list of associations and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of associations, if there are any.
" } } }, "ListAutoMLJobsRequest":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"Request a list of jobs, using a filter for time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"Request a list of jobs, using a filter for time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"Request a list of jobs, using a filter for time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"Request a list of jobs, using a filter for time.
" }, "NameContains":{ "shape":"AutoMLNameContains", "documentation":"Request a list of jobs, using a search filter for name.
" }, "StatusEquals":{ "shape":"AutoMLJobStatus", "documentation":"Request a list of jobs, using a filter for status.
" }, "SortOrder":{ "shape":"AutoMLSortOrder", "documentation":"The sort order for the results. The default is Descending.
" }, "SortBy":{ "shape":"AutoMLSortBy", "documentation":"The parameter by which to sort the results. The default is AutoMLJobName.
" }, "MaxResults":{ "shape":"AutoMLMaxResults", "documentation":"Request a list of jobs up to a specified limit.
", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListAutoMLJobsResponse":{ "type":"structure", "required":["AutoMLJobSummaries"], "members":{ "AutoMLJobSummaries":{ "shape":"AutoMLJobSummaries", "documentation":"Returns a summary list of jobs.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListCandidatesForAutoMLJobRequest":{ "type":"structure", "required":["AutoMLJobName"], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"List the Candidates created for the job by providing the job's name.
" }, "StatusEquals":{ "shape":"CandidateStatus", "documentation":"List the Candidates for the job and filter by status.
" }, "CandidateNameEquals":{ "shape":"CandidateName", "documentation":"List the Candidates for the job and filter by candidate name.
" }, "SortOrder":{ "shape":"AutoMLSortOrder", "documentation":"The sort order for the results. The default is Ascending.
" }, "SortBy":{ "shape":"CandidateSortBy", "documentation":"The parameter by which to sort the results. The default is Descending.
" }, "MaxResults":{ "shape":"AutoMLMaxResults", "documentation":"List the job's Candidates up to a specified limit.
", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListCandidatesForAutoMLJobResponse":{ "type":"structure", "required":["Candidates"], "members":{ "Candidates":{ "shape":"AutoMLCandidates", "documentation":"Summaries about the Candidates.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListCodeRepositoriesInput":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only Git repositories that were created after the specified time.
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only Git repositories that were created before the specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only Git repositories that were last modified after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only Git repositories that were last modified before the specified time.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of Git repositories to return in the response.
" }, "NameContains":{ "shape":"CodeRepositoryNameContains", "documentation":"A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
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.
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.
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.
The maximum number of model compilation jobs to return in the response.
", "box":true }, "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns the model compilation jobs that were created after a specified time.
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns the model compilation jobs that were created before a specified time.
" }, "LastModifiedTimeAfter":{ "shape":"LastModifiedTime", "documentation":"A filter that returns the model compilation jobs that were modified after a specified time.
" }, "LastModifiedTimeBefore":{ "shape":"LastModifiedTime", "documentation":"A filter that returns the model compilation jobs that were modified before a specified time.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A filter that returns the model compilation jobs whose name contains a specified string.
" }, "StatusEquals":{ "shape":"CompilationJobStatus", "documentation":"A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.
" }, "SortBy":{ "shape":"ListCompilationJobsSortBy", "documentation":"The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of CompilationJobSummary objects, each describing a model compilation job.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A filter that returns only contexts with the specified source URI.
" }, "ContextType":{ "shape":"String256", "documentation":"A filter that returns only contexts of the specified type.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only contexts created on or after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only contexts created on or before the specified time.
" }, "SortBy":{ "shape":"SortContextsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
The maximum number of contexts to return in the response. The default value is 10.
" } } }, "ListContextsResponse":{ "type":"structure", "members":{ "ContextSummaries":{ "shape":"ContextSummaries", "documentation":"A list of contexts and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of contexts, if there are any.
" } } }, "ListDataQualityJobDefinitionsRequest":{ "type":"structure", "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"A filter that lists the data quality job definitions associated with the specified endpoint.
" }, "SortBy":{ "shape":"MonitoringJobDefinitionSortKey", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>
The maximum number of data quality monitoring job definitions to return in the response.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only data quality monitoring job definitions created before the specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only data quality monitoring job definitions created after the specified time.
" } } }, "ListDataQualityJobDefinitionsResponse":{ "type":"structure", "required":["JobDefinitionSummaries"], "members":{ "JobDefinitionSummaries":{ "shape":"MonitoringJobDefinitionSummaryList", "documentation":"A list of data quality monitoring job definitions.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.
The response from the last list when returning a list large enough to need tokening.
" }, "MaxResults":{ "shape":"ListMaxResults", "documentation":"The maximum number of results to select.
", "box":true }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"Filter fleets where packaging job was created after specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"Filter fleets where the edge packaging job was created before specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"Select fleets where the job was updated after X
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"Select fleets where the job was updated before X
" }, "NameContains":{ "shape":"NameContains", "documentation":"Filter for fleets containing this name in their fleet device name.
" }, "SortBy":{ "shape":"ListDeviceFleetsSortBy", "documentation":"The column to sort by.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"What direction to sort in.
" } } }, "ListDeviceFleetsResponse":{ "type":"structure", "required":["DeviceFleetSummaries"], "members":{ "DeviceFleetSummaries":{ "shape":"DeviceFleetSummaries", "documentation":"Summary of the device fleet.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The response from the last list when returning a list large enough to need tokening.
" } } }, "ListDeviceFleetsSortBy":{ "type":"string", "enum":[ "NAME", "CREATION_TIME", "LAST_MODIFIED_TIME" ] }, "ListDevicesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"The response from the last list when returning a list large enough to need tokening.
" }, "MaxResults":{ "shape":"ListMaxResults", "documentation":"Maximum number of results to select.
", "box":true }, "LatestHeartbeatAfter":{ "shape":"Timestamp", "documentation":"Select fleets where the job was updated after X
" }, "ModelName":{ "shape":"EntityName", "documentation":"A filter that searches devices that contains this name in any of their models.
" }, "DeviceFleetName":{ "shape":"EntityName", "documentation":"Filter for fleets containing this name in their device fleet name.
" } } }, "ListDevicesResponse":{ "type":"structure", "required":["DeviceSummaries"], "members":{ "DeviceSummaries":{ "shape":"DeviceSummaries", "documentation":"Summary of devices.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The response from the last list when returning a list large enough to need tokening.
" } } }, "ListDomainsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Returns a list up to a specified limit.
" } } }, "ListDomainsResponse":{ "type":"structure", "members":{ "Domains":{ "shape":"DomainList", "documentation":"The list of domains.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListEdgePackagingJobsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"The response from the last list when returning a list large enough to need tokening.
" }, "MaxResults":{ "shape":"ListMaxResults", "documentation":"Maximum number of results to select.
", "box":true }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"Select jobs where the job was created after specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"Select jobs where the job was created before specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"Select jobs where the job was updated after specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"Select jobs where the job was updated before specified time.
" }, "NameContains":{ "shape":"NameContains", "documentation":"Filter for jobs containing this name in their packaging job name.
" }, "ModelNameContains":{ "shape":"NameContains", "documentation":"Filter for jobs where the model name contains this string.
" }, "StatusEquals":{ "shape":"EdgePackagingJobStatus", "documentation":"The job status to filter for.
" }, "SortBy":{ "shape":"ListEdgePackagingJobsSortBy", "documentation":"Use to specify what column to sort by.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"What direction to sort by.
" } } }, "ListEdgePackagingJobsResponse":{ "type":"structure", "required":["EdgePackagingJobSummaries"], "members":{ "EdgePackagingJobSummaries":{ "shape":"EdgePackagingJobSummaries", "documentation":"Summaries of edge packaging jobs.
" }, "NextToken":{ "shape":"NextToken", "documentation":"Token to use when calling the next page of results.
" } } }, "ListEdgePackagingJobsSortBy":{ "type":"string", "enum":[ "NAME", "MODEL_NAME", "CREATION_TIME", "LAST_MODIFIED_TIME", "STATUS" ] }, "ListEndpointConfigsInput":{ "type":"structure", "members":{ "SortBy":{ "shape":"EndpointConfigSortKey", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of training jobs to return in the response.
" }, "NameContains":{ "shape":"EndpointConfigNameContains", "documentation":"A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoint configurations created before the specified time (timestamp).
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
" } } }, "ListEndpointConfigsOutput":{ "type":"structure", "required":["EndpointConfigs"], "members":{ "EndpointConfigs":{ "shape":"EndpointConfigSummaryList", "documentation":"An array of endpoint configurations.
" }, "NextToken":{ "shape":"PaginationToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
" } } }, "ListEndpointsInput":{ "type":"structure", "members":{ "SortBy":{ "shape":"EndpointSortKey", "documentation":"Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of endpoints to return in the response.
" }, "NameContains":{ "shape":"EndpointNameContains", "documentation":"A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoints that were created before the specified time (timestamp).
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoints that were modified before the specified timestamp.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only endpoints that were modified after the specified timestamp.
" }, "StatusEquals":{ "shape":"EndpointStatus", "documentation":"A filter that returns only endpoints with the specified status.
" } } }, "ListEndpointsOutput":{ "type":"structure", "required":["Endpoints"], "members":{ "Endpoints":{ "shape":"EndpointSummaryList", "documentation":"An array or endpoint objects.
" }, "NextToken":{ "shape":"PaginationToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
" } } }, "ListExperimentsRequest":{ "type":"structure", "members":{ "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only experiments created after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only experiments created before the specified time.
" }, "SortBy":{ "shape":"SortExperimentsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of experiments to return in the response. The default value is 10.
" } } }, "ListExperimentsResponse":{ "type":"structure", "members":{ "ExperimentSummaries":{ "shape":"ExperimentSummaries", "documentation":"A list of the summaries of your experiments.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of experiments, if there are any.
" } } }, "ListFeatureGroupsRequest":{ "type":"structure", "members":{ "NameContains":{ "shape":"FeatureGroupNameContains", "documentation":"A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
A FeatureGroup status. Filters by FeatureGroup status.
An OfflineStore status. Filters by OfflineStore status.
Use this parameter to search for FeatureGroupss created after a specific date and time.
Use this parameter to search for FeatureGroupss created before a specific date and time.
The order in which feature groups are listed.
" }, "SortBy":{ "shape":"FeatureGroupSortBy", "documentation":"The value on which the feature group list is sorted.
" }, "MaxResults":{ "shape":"FeatureGroupMaxResults", "documentation":"The maximum number of results returned by ListFeatureGroups.
A token to resume pagination of ListFeatureGroups results.
A summary of feature groups.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination of ListFeatureGroups results.
A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only flow definitions that were created before the specified timestamp.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"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.
An array of objects describing the flow definitions.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination.
" } } }, "ListHumanTaskUisRequest":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only human task user interfaces that were created before the specified timestamp.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"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.
An array of objects describing the human task user interfaces.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination.
" } } }, "ListHyperParameterTuningJobsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"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.
The maximum number of tuning jobs to return. The default value is 10.
", "box":true }, "SortBy":{ "shape":"HyperParameterTuningJobSortByOptions", "documentation":"The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only tuning jobs that were created after the specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only tuning jobs that were created before the specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only tuning jobs that were modified after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only tuning jobs that were modified before the specified time.
" }, "StatusEquals":{ "shape":"HyperParameterTuningJobStatus", "documentation":"A filter that returns only tuning jobs with the specified status.
" } } }, "ListHyperParameterTuningJobsResponse":{ "type":"structure", "required":["HyperParameterTuningJobSummaries"], "members":{ "HyperParameterTuningJobSummaries":{ "shape":"HyperParameterTuningJobSummaries", "documentation":"A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
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.
A filter that returns only versions created on or after the specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only versions created on or before the specified time.
" }, "ImageName":{ "shape":"ImageName", "documentation":"The name of the image to list the versions of.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only versions modified on or after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only versions modified on or before the specified time.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of versions to return in the response. The default value is 10.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of versions and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of versions, if there are any.
" } } }, "ListImagesRequest":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only images created on or after the specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only images created on or before the specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only images modified on or after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only images modified on or before the specified time.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of images to return in the response. The default value is 10.
" }, "NameContains":{ "shape":"ImageNameContains", "documentation":"A filter that returns only images whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of images and their properties.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of images, if there are any.
" } } }, "ListLabelingJobsForWorkteamRequest":{ "type":"structure", "required":["WorkteamArn"], "members":{ "WorkteamArn":{ "shape":"WorkteamArn", "documentation":"The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of labeling jobs to return in each page of the response.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A filter that returns only labeling jobs created after the specified time (timestamp).
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only labeling jobs created before the specified time (timestamp).
" }, "JobReferenceCodeContains":{ "shape":"JobReferenceCodeContains", "documentation":"A filter the limits jobs to only the ones whose job reference code contains the specified string.
" }, "SortBy":{ "shape":"ListLabelingJobsForWorkteamSortByOptions", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
" } } }, "ListLabelingJobsForWorkteamSortByOptions":{ "type":"string", "enum":["CreationTime"] }, "ListLabelingJobsRequest":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only labeling jobs created after the specified time (timestamp).
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only labeling jobs created before the specified time (timestamp).
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only labeling jobs modified after the specified time (timestamp).
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only labeling jobs modified before the specified time (timestamp).
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of labeling jobs to return in each page of the response.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
" }, "SortBy":{ "shape":"SortBy", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only labeling jobs with a specific status.
" } } }, "ListLabelingJobsResponse":{ "type":"structure", "members":{ "LabelingJobSummaryList":{ "shape":"LabelingJobSummaryList", "documentation":"An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
" } } }, "ListLineageEntityParameterKey":{ "type":"list", "member":{"shape":"StringParameterValue"} }, "ListMaxResults":{ "type":"integer", "max":100 }, "ListModelBiasJobDefinitionsRequest":{ "type":"structure", "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"Name of the endpoint to monitor for model bias.
" }, "SortBy":{ "shape":"MonitoringJobDefinitionSortKey", "documentation":"Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of model bias jobs to return in the response. The default value is 10.
" }, "NameContains":{ "shape":"NameContains", "documentation":"Filter for model bias jobs whose name contains a specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only model bias jobs created before a specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only model bias jobs created after a specified time.
" } } }, "ListModelBiasJobDefinitionsResponse":{ "type":"structure", "required":["JobDefinitionSummaries"], "members":{ "JobDefinitionSummaries":{ "shape":"MonitoringJobDefinitionSummaryList", "documentation":"A JSON array in which each element is a summary for a model bias jobs.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
" } } }, "ListModelExplainabilityJobDefinitionsRequest":{ "type":"structure", "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"Name of the endpoint to monitor for model explainability.
" }, "SortBy":{ "shape":"MonitoringJobDefinitionSortKey", "documentation":"Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of jobs to return in the response. The default value is 10.
" }, "NameContains":{ "shape":"NameContains", "documentation":"Filter for model explainability jobs whose name contains a specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only model explainability jobs created before a specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only model explainability jobs created after a specified time.
" } } }, "ListModelExplainabilityJobDefinitionsResponse":{ "type":"structure", "required":["JobDefinitionSummaries"], "members":{ "JobDefinitionSummaries":{ "shape":"MonitoringJobDefinitionSummaryList", "documentation":"A JSON array in which each element is a summary for a explainability bias jobs.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
" } } }, "ListModelPackageGroupsInput":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only model groups created after the specified time.
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only model groups created before the specified time.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in the response.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the model group name. This filter returns only model groups whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A list of summaries of the model groups in your AWS account.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
" } } }, "ListModelPackagesInput":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only model packages created after the specified time (timestamp).
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only model packages created before the specified time (timestamp).
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of model packages to return in the response.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the model package name. This filter returns only model packages whose name contains the specified string.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"A filter that returns only the model packages with the specified approval status.
" }, "ModelPackageGroupName":{ "shape":"ArnOrName", "documentation":"A filter that returns only model versions that belong to the specified model group.
" }, "ModelPackageType":{ "shape":"ModelPackageType", "documentation":"A filter that returns onlyl the model packages of the specified type. This can be one of the following values.
VERSIONED - List only versioned models.
UNVERSIONED - List only unversioined models.
BOTH - List both versioned and unversioned models.
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.
The parameter by which to sort the results. The default is CreationTime.
The sort order for the results. The default is Ascending.
An array of ModelPackageSummary objects, each of which lists a model package.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
" } } }, "ListModelQualityJobDefinitionsRequest":{ "type":"structure", "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
" }, "SortBy":{ "shape":"MonitoringJobDefinitionSortKey", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.
The maximum number of results to return in a call to ListModelQualityJobDefinitions.
A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only model quality monitoring job definitions created before the specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only model quality monitoring job definitions created after the specified time.
" } } }, "ListModelQualityJobDefinitionsResponse":{ "type":"structure", "required":["JobDefinitionSummaries"], "members":{ "JobDefinitionSummaries":{ "shape":"MonitoringJobDefinitionSummaryList", "documentation":"A list of summaries of model quality monitoring job definitions.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
" } } }, "ListModelsInput":{ "type":"structure", "members":{ "SortBy":{ "shape":"ModelSortKey", "documentation":"Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of models to return in the response.
" }, "NameContains":{ "shape":"ModelNameContains", "documentation":"A string in the training job name. This filter returns only models in the training job whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only models created before the specified time (timestamp).
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
" } } }, "ListModelsOutput":{ "type":"structure", "required":["Models"], "members":{ "Models":{ "shape":"ModelSummaryList", "documentation":"An array of ModelSummary objects, each of which lists a model.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
" } } }, "ListMonitoringExecutionsRequest":{ "type":"structure", "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"Name of a specific schedule to fetch jobs for.
" }, "EndpointName":{ "shape":"EndpointName", "documentation":"Name of a specific endpoint to fetch jobs for.
" }, "SortBy":{ "shape":"MonitoringExecutionSortKey", "documentation":"Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of jobs to return in the response. The default value is 10.
" }, "ScheduledTimeBefore":{ "shape":"Timestamp", "documentation":"Filter for jobs scheduled before a specified time.
" }, "ScheduledTimeAfter":{ "shape":"Timestamp", "documentation":"Filter for jobs scheduled after a specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only jobs created before a specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only jobs created after a specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only jobs modified after a specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only jobs modified before a specified time.
" }, "StatusEquals":{ "shape":"ExecutionStatus", "documentation":"A filter that retrieves only jobs with a specific status.
" }, "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"Gets a list of the monitoring job runs of the specified monitoring job definitions.
" }, "MonitoringTypeEquals":{ "shape":"MonitoringType", "documentation":"A filter that returns only the monitoring job runs of the specified monitoring type.
" } } }, "ListMonitoringExecutionsResponse":{ "type":"structure", "required":["MonitoringExecutionSummaries"], "members":{ "MonitoringExecutionSummaries":{ "shape":"MonitoringExecutionSummaryList", "documentation":"A JSON array in which each element is a summary for a monitoring execution.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
" } } }, "ListMonitoringSchedulesRequest":{ "type":"structure", "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"Name of a specific endpoint to fetch schedules for.
" }, "SortBy":{ "shape":"MonitoringScheduleSortKey", "documentation":"Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of jobs to return in the response. The default value is 10.
" }, "NameContains":{ "shape":"NameContains", "documentation":"Filter for monitoring schedules whose name contains a specified string.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only monitoring schedules created before a specified time.
" }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only monitoring schedules created after a specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only monitoring schedules modified before a specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only monitoring schedules modified after a specified time.
" }, "StatusEquals":{ "shape":"ScheduleStatus", "documentation":"A filter that returns only monitoring schedules modified before a specified time.
" }, "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"Gets a list of the monitoring schedules for the specified monitoring job definition.
" }, "MonitoringTypeEquals":{ "shape":"MonitoringType", "documentation":"A filter that returns only the monitoring schedules for the specified monitoring type.
" } } }, "ListMonitoringSchedulesResponse":{ "type":"structure", "required":["MonitoringScheduleSummaries"], "members":{ "MonitoringScheduleSummaries":{ "shape":"MonitoringScheduleSummaryList", "documentation":"A JSON array in which each element is a summary for a monitoring schedule.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
" } } }, "ListNotebookInstanceLifecycleConfigsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"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.
The maximum number of lifecycle configurations to return in the response.
" }, "SortBy":{ "shape":"NotebookInstanceLifecycleConfigSortKey", "documentation":"Sorts the list of results. The default is CreationTime.
The sort order for results.
" }, "NameContains":{ "shape":"NotebookInstanceLifecycleConfigNameContains", "documentation":"A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
" }, "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
" }, "LastModifiedTimeBefore":{ "shape":"LastModifiedTime", "documentation":"A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
" }, "LastModifiedTimeAfter":{ "shape":"LastModifiedTime", "documentation":"A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
" } } }, "ListNotebookInstanceLifecycleConfigsOutput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
" }, "NotebookInstanceLifecycleConfigs":{ "shape":"NotebookInstanceLifecycleConfigSummaryList", "documentation":"An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
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.
The maximum number of notebook instances to return.
" }, "SortBy":{ "shape":"NotebookInstanceSortKey", "documentation":"The field to sort results by. The default is Name.
The sort order for results.
" }, "NameContains":{ "shape":"NotebookInstanceNameContains", "documentation":"A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
" }, "CreationTimeBefore":{ "shape":"CreationTime", "documentation":"A filter that returns only notebook instances that were created before the specified time (timestamp).
" }, "CreationTimeAfter":{ "shape":"CreationTime", "documentation":"A filter that returns only notebook instances that were created after the specified time (timestamp).
" }, "LastModifiedTimeBefore":{ "shape":"LastModifiedTime", "documentation":"A filter that returns only notebook instances that were modified before the specified time (timestamp).
" }, "LastModifiedTimeAfter":{ "shape":"LastModifiedTime", "documentation":"A filter that returns only notebook instances that were modified after the specified time (timestamp).
" }, "StatusEquals":{ "shape":"NotebookInstanceStatus", "documentation":"A filter that returns only notebook instances with the specified status.
" }, "NotebookInstanceLifecycleConfigNameContains":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"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.
" }, "DefaultCodeRepositoryContains":{ "shape":"CodeRepositoryContains", "documentation":"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.
" }, "AdditionalCodeRepositoryEquals":{ "shape":"CodeRepositoryNameOrUrl", "documentation":"A filter that returns only notebook instances with associated with the specified git repository.
" } } }, "ListNotebookInstancesOutput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"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.
An array of NotebookInstanceSummary objects, one for each notebook instance.
The Amazon Resource Name (ARN) of the pipeline execution.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
The maximum number of pipeline execution steps to return in the response.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"The field by which to sort results. The default is CreatedTime.
A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.
If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.
The name of the pipeline.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns the pipeline executions that were created after a specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns the pipeline executions that were created before a specified time.
" }, "SortBy":{ "shape":"SortPipelineExecutionsBy", "documentation":"The field by which to sort results. The default is CreatedTime.
The sort order for results.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
The maximum number of pipeline executions to return in the response.
" } } }, "ListPipelineExecutionsResponse":{ "type":"structure", "members":{ "PipelineExecutionSummaries":{ "shape":"PipelineExecutionSummaryList", "documentation":"Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
The Amazon Resource Name (ARN) of the pipeline execution.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
The maximum number of parameters to return in the response.
" } } }, "ListPipelineParametersForExecutionResponse":{ "type":"structure", "members":{ "PipelineParameters":{ "shape":"ParameterList", "documentation":"Contains a list of pipeline parameters. This list can be empty.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.
The prefix of the pipeline name.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns the pipelines that were created after a specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns the pipelines that were created before a specified time.
" }, "SortBy":{ "shape":"SortPipelinesBy", "documentation":"The field by which to sort results. The default is CreatedTime.
The sort order for results.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
The maximum number of pipelines to return in the response.
" } } }, "ListPipelinesResponse":{ "type":"structure", "members":{ "PipelineSummaries":{ "shape":"PipelineSummaryList", "documentation":"Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
A filter that returns only processing jobs created after the specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only processing jobs created after the specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only processing jobs modified after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only processing jobs modified before the specified time.
" }, "NameContains":{ "shape":"String", "documentation":"A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
" }, "StatusEquals":{ "shape":"ProcessingJobStatus", "documentation":"A filter that retrieves only processing jobs with a specific status.
" }, "SortBy":{ "shape":"SortBy", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
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.
The maximum number of processing jobs to return in the response.
", "box":true } } }, "ListProcessingJobsResponse":{ "type":"structure", "required":["ProcessingJobSummaries"], "members":{ "ProcessingJobSummaries":{ "shape":"ProcessingJobSummaries", "documentation":"An array of ProcessingJobSummary objects, each listing a processing job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
" } } }, "ListProjectsInput":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns the projects that were created after a specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns the projects that were created before a specified time.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of projects to return in the response.
" }, "NameContains":{ "shape":"ProjectEntityName", "documentation":"A filter that returns the projects whose name contains a specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
A list of summaries of projects.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A string in the work team name. This filter returns only work teams whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
The maximum number of work teams to return in each page of the response.
", "box":true } } }, "ListSubscribedWorkteamsResponse":{ "type":"structure", "required":["SubscribedWorkteams"], "members":{ "SubscribedWorkteams":{ "shape":"SubscribedWorkteams", "documentation":"An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
" } } }, "ListTagsInput":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
" }, "NextToken":{ "shape":"NextToken", "documentation":" 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.
Maximum number of tags to return.
" } } }, "ListTagsMaxResults":{ "type":"integer", "min":50 }, "ListTagsOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"An array of Tag objects, each with a tag key and a value.
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.
" } } }, "ListTrainingJobsForHyperParameterTuningJobRequest":{ "type":"structure", "required":["HyperParameterTuningJobName"], "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The name of the tuning job whose training jobs you want to list.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
The maximum number of training jobs to return. The default value is 10.
" }, "StatusEquals":{ "shape":"TrainingJobStatus", "documentation":"A filter that returns only training jobs with the specified status.
" }, "SortBy":{ "shape":"TrainingJobSortByOptions", "documentation":"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.
The sort order for results. The default is Ascending.
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
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.
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.
The maximum number of training jobs to return in the response.
", "box":true }, "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only training jobs created after the specified time (timestamp).
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only training jobs created before the specified time (timestamp).
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only training jobs modified after the specified time (timestamp).
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only training jobs modified before the specified time (timestamp).
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the training job name. This filter returns only training jobs whose name contains the specified string.
" }, "StatusEquals":{ "shape":"TrainingJobStatus", "documentation":"A filter that retrieves only training jobs with a specific status.
" }, "SortBy":{ "shape":"SortBy", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of TrainingJobSummary objects, each listing a training job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
" } } }, "ListTransformJobsRequest":{ "type":"structure", "members":{ "CreationTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only transform jobs created after the specified time.
" }, "CreationTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only transform jobs created before the specified time.
" }, "LastModifiedTimeAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only transform jobs modified after the specified time.
" }, "LastModifiedTimeBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only transform jobs modified before the specified time.
" }, "NameContains":{ "shape":"NameContains", "documentation":"A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
" }, "StatusEquals":{ "shape":"TransformJobStatus", "documentation":"A filter that retrieves only transform jobs with a specific status.
" }, "SortBy":{ "shape":"SortBy", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of transform jobs to return in the response. The default value is 10.
An array of TransformJobSummary objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
" } } }, "ListTrialComponentKey256":{ "type":"list", "member":{"shape":"TrialComponentKey256"} }, "ListTrialComponentsRequest":{ "type":"structure", "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"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.
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.
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.
A filter that returns only components created after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only components created before the specified time.
" }, "SortBy":{ "shape":"SortTrialComponentsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of components to return in the response. The default value is 10.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A list of the summaries of your trial components.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of components, if there are any.
" } } }, "ListTrialsRequest":{ "type":"structure", "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"A filter that returns only trials that are part of the specified experiment.
" }, "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"A filter that returns only trials that are associated with the specified trial component.
" }, "CreatedAfter":{ "shape":"Timestamp", "documentation":"A filter that returns only trials created after the specified time.
" }, "CreatedBefore":{ "shape":"Timestamp", "documentation":"A filter that returns only trials created before the specified time.
" }, "SortBy":{ "shape":"SortTrialsBy", "documentation":"The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
A list of the summaries of your trials.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token for getting the next set of trials, if there are any.
" } } }, "ListUserProfilesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"Returns a list up to a specified limit.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"The sort order for the results. The default is Ascending.
" }, "SortBy":{ "shape":"UserProfileSortKey", "documentation":"The parameter by which to sort the results. The default is CreationTime.
" }, "DomainIdEquals":{ "shape":"DomainId", "documentation":"A parameter by which to filter the results.
" }, "UserProfileNameContains":{ "shape":"UserProfileName", "documentation":"A parameter by which to filter the results.
" } } }, "ListUserProfilesResponse":{ "type":"structure", "members":{ "UserProfiles":{ "shape":"UserProfileList", "documentation":"The list of user profiles.
" }, "NextToken":{ "shape":"NextToken", "documentation":"If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
" } } }, "ListWorkforcesRequest":{ "type":"structure", "members":{ "SortBy":{ "shape":"ListWorkforcesSortByOptions", "documentation":"Sort workforces using the workforce name or creation date.
" }, "SortOrder":{ "shape":"SortOrder", "documentation":"Sort workforces in ascending or descending order.
" }, "NameContains":{ "shape":"WorkforceName", "documentation":"A filter you can use to search for workforces using part of the workforce name.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of workforces returned in the response.
", "box":true } } }, "ListWorkforcesResponse":{ "type":"structure", "required":["Workforces"], "members":{ "Workforces":{ "shape":"Workforces", "documentation":"A list containing information about your workforce.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A token to resume pagination.
" } } }, "ListWorkforcesSortByOptions":{ "type":"string", "enum":[ "Name", "CreateDate" ] }, "ListWorkteamsRequest":{ "type":"structure", "members":{ "SortBy":{ "shape":"ListWorkteamsSortByOptions", "documentation":"The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A string in the work team's name. This filter returns only work teams whose name contains the specified string.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
The maximum number of work teams to return in each page of the response.
", "box":true } } }, "ListWorkteamsResponse":{ "type":"structure", "required":["Workteams"], "members":{ "Workteams":{ "shape":"Workteams", "documentation":"An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
" } } }, "ListWorkteamsSortByOptions":{ "type":"string", "enum":[ "Name", "CreateDate" ] }, "Long":{"type":"long"}, "MaxAutoMLJobRuntimeInSeconds":{ "type":"integer", "min":1 }, "MaxCandidates":{ "type":"integer", "min":1 }, "MaxConcurrentTaskCount":{ "type":"integer", "max":1000, "min":1 }, "MaxConcurrentTransforms":{ "type":"integer", "min":0 }, "MaxHumanLabeledObjectCount":{ "type":"integer", "min":1 }, "MaxNumberOfTrainingJobs":{ "type":"integer", "min":1 }, "MaxParallelTrainingJobs":{ "type":"integer", "min":1 }, "MaxPayloadInMB":{ "type":"integer", "min":0 }, "MaxPercentageOfInputDatasetLabeled":{ "type":"integer", "max":100, "min":1 }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "MaxRuntimeInSeconds":{ "type":"integer", "min":1 }, "MaxRuntimePerTrainingJobInSeconds":{ "type":"integer", "min":1 }, "MaxWaitTimeInSeconds":{ "type":"integer", "min":1 }, "MaximumExecutionTimeoutInSeconds":{ "type":"integer", "max":14400, "min":600 }, "MediaType":{ "type":"string", "max":64, "pattern":"^[-\\w]+\\/[-\\w+]+$" }, "MemberDefinition":{ "type":"structure", "members":{ "CognitoMemberDefinition":{ "shape":"CognitoMemberDefinition", "documentation":"The Amazon Cognito user group that is part of the work team.
" }, "OidcMemberDefinition":{ "shape":"OidcMemberDefinition", "documentation":"A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
" }, "MemberDefinitions":{ "type":"list", "member":{"shape":"MemberDefinition"}, "max":10, "min":1 }, "MetadataProperties":{ "type":"structure", "members":{ "CommitId":{ "shape":"MetadataPropertyValue", "documentation":"The commit ID.
" }, "Repository":{ "shape":"MetadataPropertyValue", "documentation":"The repository.
" }, "GeneratedBy":{ "shape":"MetadataPropertyValue", "documentation":"The entity this entity was generated by.
" }, "ProjectId":{ "shape":"MetadataPropertyValue", "documentation":"The project ID.
" } }, "documentation":"Metadata properties of the tracking entity, trial, or trial component.
" }, "MetadataPropertyValue":{ "type":"string", "max":1024, "pattern":".*" }, "MetricData":{ "type":"structure", "members":{ "MetricName":{ "shape":"MetricName", "documentation":"The name of the metric.
" }, "Value":{ "shape":"Float", "documentation":"The value of the metric.
" }, "Timestamp":{ "shape":"Timestamp", "documentation":"The date and time that the algorithm emitted the metric.
" } }, "documentation":"The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.
" }, "MetricDefinition":{ "type":"structure", "required":[ "Name", "Regex" ], "members":{ "Name":{ "shape":"MetricName", "documentation":"The name of the metric.
" }, "Regex":{ "shape":"MetricRegex", "documentation":"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.
" } }, "documentation":"Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.
The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
Provides information about the location that is configured for storing model artifacts.
Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model defintion that desribes how to compute inferences, and other metadata.
" }, "ModelBiasAppSpecification":{ "type":"structure", "required":[ "ImageUri", "ConfigUri" ], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The container image to be run by the model bias job.
" }, "ConfigUri":{ "shape":"S3Uri", "documentation":"JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
" }, "Environment":{ "shape":"MonitoringEnvironmentMap", "documentation":"Sets the environment variables in the Docker container.
" } }, "documentation":"Docker container image configuration object for the model bias job.
" }, "ModelBiasBaselineConfig":{ "type":"structure", "members":{ "BaseliningJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the baseline model bias job.
" }, "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} }, "documentation":"The configuration for a baseline model bias job.
" }, "ModelBiasJobInput":{ "type":"structure", "required":[ "EndpointInput", "GroundTruthS3Input" ], "members":{ "EndpointInput":{"shape":"EndpointInput"}, "GroundTruthS3Input":{ "shape":"MonitoringGroundTruthS3Input", "documentation":"Location of ground truth labels to use in model bias job.
" } }, "documentation":"Inputs for the model bias job.
" }, "ModelCacheSetting":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ModelClientConfig":{ "type":"structure", "members":{ "InvocationsTimeoutInSeconds":{ "shape":"InvocationsTimeoutInSeconds", "documentation":"The timeout value in seconds for an invocation request.
" }, "InvocationsMaxRetries":{ "shape":"InvocationsMaxRetries", "documentation":"The maximum number of retries when invocation requests are failing.
" } }, "documentation":"Configures the timeout and maximum number of retries for processing a transform job invocation.
" }, "ModelDataQuality":{ "type":"structure", "members":{ "Statistics":{ "shape":"MetricsSource", "documentation":"Data quality statistics for a model.
" }, "Constraints":{ "shape":"MetricsSource", "documentation":"Data quality constraints for a model.
" } }, "documentation":"Data quality constraints and statistics for a model.
" }, "ModelDigests":{ "type":"structure", "members":{ "ArtifactDigest":{ "shape":"ArtifactDigest", "documentation":"Provides a hash value that uniquely identifies the stored model artifacts.
" } }, "documentation":"Provides information to verify the integrity of stored model artifacts.
" }, "ModelExplainabilityAppSpecification":{ "type":"structure", "required":[ "ImageUri", "ConfigUri" ], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The container image to be run by the model explainability job.
" }, "ConfigUri":{ "shape":"S3Uri", "documentation":"JSON formatted S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
" }, "Environment":{ "shape":"MonitoringEnvironmentMap", "documentation":"Sets the environment variables in the Docker container.
" } }, "documentation":"Docker container image configuration object for the model explainability job.
" }, "ModelExplainabilityBaselineConfig":{ "type":"structure", "members":{ "BaseliningJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the baseline model explainability job.
" }, "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} }, "documentation":"The configuration for a baseline model explainability job.
" }, "ModelExplainabilityJobInput":{ "type":"structure", "required":["EndpointInput"], "members":{ "EndpointInput":{"shape":"EndpointInput"} }, "documentation":"Inputs for the model explainability job.
" }, "ModelMetrics":{ "type":"structure", "members":{ "ModelQuality":{ "shape":"ModelQuality", "documentation":"Metrics that measure the quality of a model.
" }, "ModelDataQuality":{ "shape":"ModelDataQuality", "documentation":"Metrics that measure the quality of the input data for a model.
" }, "Bias":{ "shape":"Bias", "documentation":"Metrics that measure bais in a model.
" }, "Explainability":{ "shape":"Explainability", "documentation":"Metrics that help explain a model.
" } }, "documentation":"Contains metrics captured from a model.
" }, "ModelName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ModelNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "ModelPackage":{ "type":"structure", "members":{ "ModelPackageName":{ "shape":"EntityName", "documentation":"The name of the model.
" }, "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The model group to which the model belongs.
" }, "ModelPackageVersion":{ "shape":"ModelPackageVersion", "documentation":"The version number of a versioned model.
" }, "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the model package.
" }, "ModelPackageDescription":{ "shape":"EntityDescription", "documentation":"The description of the model package.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time that the model package was created.
" }, "InferenceSpecification":{"shape":"InferenceSpecification"}, "SourceAlgorithmSpecification":{"shape":"SourceAlgorithmSpecification"}, "ValidationSpecification":{"shape":"ModelPackageValidationSpecification"}, "ModelPackageStatus":{ "shape":"ModelPackageStatus", "documentation":"The status of the model package. This can be one of the following values.
PENDING - The model package is pending being created.
IN_PROGRESS - The model package is in the process of being created.
COMPLETED - The model package was successfully created.
FAILED - The model package failed.
DELETING - The model package is in the process of being deleted.
Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"The approval status of the model. This can be one of the following values.
APPROVED - The model is approved
REJECTED - The model is rejected.
PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
Metrics for the model.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last time the model package was modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "ApprovalDescription":{ "shape":"ApprovalDescription", "documentation":"A description provided when the model approval is set.
" }, "Tags":{ "shape":"TagList", "documentation":"A list of the tags associated with the model package. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } }, "documentation":"A versioned model that can be deployed for SageMaker inference.
" }, "ModelPackageArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package/.*" }, "ModelPackageContainerDefinition":{ "type":"structure", "required":["Image"], "members":{ "ContainerHostname":{ "shape":"ContainerHostname", "documentation":"The DNS host name for the Docker container.
" }, "Image":{ "shape":"ContainerImage", "documentation":"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.
An MD5 hash of the training algorithm that identifies the Docker image used for training.
" }, "ModelDataUrl":{ "shape":"Url", "documentation":"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).
The model artifacts must be in an S3 bucket that is in the same region as the model package.
The AWS Marketplace product ID of the model package.
" } }, "documentation":"Describes the Docker container for the model package.
" }, "ModelPackageContainerDefinitionList":{ "type":"list", "member":{"shape":"ModelPackageContainerDefinition"}, "max":1, "min":1 }, "ModelPackageGroup":{ "type":"structure", "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group.
" }, "ModelPackageGroupArn":{ "shape":"ModelPackageGroupArn", "documentation":"The Amazon Resource Name (ARN) of the model group.
" }, "ModelPackageGroupDescription":{ "shape":"EntityDescription", "documentation":"The description for the model group.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time that the model group was created.
" }, "CreatedBy":{"shape":"UserContext"}, "ModelPackageGroupStatus":{ "shape":"ModelPackageGroupStatus", "documentation":"The status of the model group. This can be one of the following values.
PENDING - The model group is pending being created.
IN_PROGRESS - The model group is in the process of being created.
COMPLETED - The model group was successfully created.
FAILED - The model group failed.
DELETING - The model group is in the process of being deleted.
DELETE_FAILED - SageMaker failed to delete the model group.
A list of the tags associated with the model group. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } }, "documentation":"A group of versioned models in the model registry.
" }, "ModelPackageGroupArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package-group/.*" }, "ModelPackageGroupSortBy":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "ModelPackageGroupStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Completed", "Failed", "Deleting", "DeleteFailed" ] }, "ModelPackageGroupSummary":{ "type":"structure", "required":[ "ModelPackageGroupName", "ModelPackageGroupArn", "CreationTime", "ModelPackageGroupStatus" ], "members":{ "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"The name of the model group.
" }, "ModelPackageGroupArn":{ "shape":"ModelPackageGroupArn", "documentation":"The Amazon Resource Name (ARN) of the model group.
" }, "ModelPackageGroupDescription":{ "shape":"EntityDescription", "documentation":"A description of the model group.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time that the model group was created.
" }, "ModelPackageGroupStatus":{ "shape":"ModelPackageGroupStatus", "documentation":"The status of the model group.
" } }, "documentation":"Summary information about a model group.
" }, "ModelPackageGroupSummaryList":{ "type":"list", "member":{"shape":"ModelPackageGroupSummary"} }, "ModelPackageSortBy":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "ModelPackageStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Completed", "Failed", "Deleting" ] }, "ModelPackageStatusDetails":{ "type":"structure", "required":["ValidationStatuses"], "members":{ "ValidationStatuses":{ "shape":"ModelPackageStatusItemList", "documentation":"The validation status of the model package.
" }, "ImageScanStatuses":{ "shape":"ModelPackageStatusItemList", "documentation":"The status of the scan of the Docker image container for the model package.
" } }, "documentation":"Specifies the validation and image scan statuses of the model package.
" }, "ModelPackageStatusItem":{ "type":"structure", "required":[ "Name", "Status" ], "members":{ "Name":{ "shape":"EntityName", "documentation":"The name of the model package for which the overall status is being reported.
" }, "Status":{ "shape":"DetailedModelPackageStatus", "documentation":"The current status.
" }, "FailureReason":{ "shape":"String", "documentation":"if the overall status is Failed, the reason for the failure.
Represents the overall status of a model package.
" }, "ModelPackageStatusItemList":{ "type":"list", "member":{"shape":"ModelPackageStatusItem"} }, "ModelPackageSummary":{ "type":"structure", "required":[ "ModelPackageName", "ModelPackageArn", "CreationTime", "ModelPackageStatus" ], "members":{ "ModelPackageName":{ "shape":"EntityName", "documentation":"The name of the model package.
" }, "ModelPackageGroupName":{ "shape":"EntityName", "documentation":"If the model package is a versioned model, the model group that the versioned model belongs to.
" }, "ModelPackageVersion":{ "shape":"ModelPackageVersion", "documentation":"If the model package is a versioned model, the version of the model.
" }, "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the model package.
" }, "ModelPackageDescription":{ "shape":"EntityDescription", "documentation":"A brief description of the model package.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp that shows when the model package was created.
" }, "ModelPackageStatus":{ "shape":"ModelPackageStatus", "documentation":"The overall status of the model package.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"The approval status of the model. This can be one of the following values.
APPROVED - The model is approved
REJECTED - The model is rejected.
PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
Provides summary information about a model package.
" }, "ModelPackageSummaryList":{ "type":"list", "member":{"shape":"ModelPackageSummary"} }, "ModelPackageType":{ "type":"string", "enum":[ "Versioned", "Unversioned", "Both" ] }, "ModelPackageValidationProfile":{ "type":"structure", "required":[ "ProfileName", "TransformJobDefinition" ], "members":{ "ProfileName":{ "shape":"EntityName", "documentation":"The name of the profile for the model package.
" }, "TransformJobDefinition":{ "shape":"TransformJobDefinition", "documentation":"The TransformJobDefinition object that describes the transform job used for the validation of the model package.
Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
" }, "ModelPackageValidationProfiles":{ "type":"list", "member":{"shape":"ModelPackageValidationProfile"}, "max":1, "min":1 }, "ModelPackageValidationSpecification":{ "type":"structure", "required":[ "ValidationRole", "ValidationProfiles" ], "members":{ "ValidationRole":{ "shape":"RoleArn", "documentation":"The IAM roles to be used for the validation of the model package.
" }, "ValidationProfiles":{ "shape":"ModelPackageValidationProfiles", "documentation":"An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.
Specifies batch transform jobs that Amazon SageMaker runs to validate your model package.
" }, "ModelPackageVersion":{ "type":"integer", "min":1 }, "ModelQuality":{ "type":"structure", "members":{ "Statistics":{ "shape":"MetricsSource", "documentation":"Model quality statistics.
" }, "Constraints":{ "shape":"MetricsSource", "documentation":"Model quality constraints.
" } }, "documentation":"Model quality statistics and constraints.
" }, "ModelQualityAppSpecification":{ "type":"structure", "required":["ImageUri"], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The address of the container image that the monitoring job runs.
" }, "ContainerEntrypoint":{ "shape":"ContainerEntrypoint", "documentation":"Specifies the entrypoint for a container that the monitoring job runs.
" }, "ContainerArguments":{ "shape":"MonitoringContainerArguments", "documentation":"An array of arguments for the container used to run the monitoring job.
" }, "RecordPreprocessorSourceUri":{ "shape":"S3Uri", "documentation":"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.
" }, "PostAnalyticsProcessorSourceUri":{ "shape":"S3Uri", "documentation":"An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" }, "ProblemType":{ "shape":"MonitoringProblemType", "documentation":"The machine learning problem type of the model that the monitoring job monitors.
" }, "Environment":{ "shape":"MonitoringEnvironmentMap", "documentation":"Sets the environment variables in the container that the monitoring job runs.
" } }, "documentation":"Container image configuration object for the monitoring job.
" }, "ModelQualityBaselineConfig":{ "type":"structure", "members":{ "BaseliningJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the job that performs baselining for the monitoring job.
" }, "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} }, "documentation":"Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" }, "ModelQualityJobInput":{ "type":"structure", "required":[ "EndpointInput", "GroundTruthS3Input" ], "members":{ "EndpointInput":{"shape":"EndpointInput"}, "GroundTruthS3Input":{ "shape":"MonitoringGroundTruthS3Input", "documentation":"The ground truth label provided for the model.
" } }, "documentation":"The input for the model quality monitoring job. Currently endponts are supported for input for model quality monitoring jobs.
" }, "ModelSortKey":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "ModelStepMetadata":{ "type":"structure", "members":{ "Arn":{ "shape":"String256", "documentation":"The Amazon Resource Name (ARN) of the created model.
" } }, "documentation":"Metadata for Model steps.
" }, "ModelSummary":{ "type":"structure", "required":[ "ModelName", "ModelArn", "CreationTime" ], "members":{ "ModelName":{ "shape":"ModelName", "documentation":"The name of the model that you want a summary for.
" }, "ModelArn":{ "shape":"ModelArn", "documentation":"The Amazon Resource Name (ARN) of the model.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that indicates when the model was created.
" } }, "documentation":"Provides summary information about a model.
" }, "ModelSummaryList":{ "type":"list", "member":{"shape":"ModelSummary"} }, "MonitoringAppSpecification":{ "type":"structure", "required":["ImageUri"], "members":{ "ImageUri":{ "shape":"ImageUri", "documentation":"The container image to be run by the monitoring job.
" }, "ContainerEntrypoint":{ "shape":"ContainerEntrypoint", "documentation":"Specifies the entrypoint for a container used to run the monitoring job.
" }, "ContainerArguments":{ "shape":"MonitoringContainerArguments", "documentation":"An array of arguments for the container used to run the monitoring job.
" }, "RecordPreprocessorSourceUri":{ "shape":"S3Uri", "documentation":"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.
" }, "PostAnalyticsProcessorSourceUri":{ "shape":"S3Uri", "documentation":"An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
" } }, "documentation":"Container image configuration object for the monitoring job.
" }, "MonitoringBaselineConfig":{ "type":"structure", "members":{ "BaseliningJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the job that performs baselining for the monitoring job.
" }, "ConstraintsResource":{ "shape":"MonitoringConstraintsResource", "documentation":"The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
" }, "StatisticsResource":{ "shape":"MonitoringStatisticsResource", "documentation":"The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
" } }, "documentation":"Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
" }, "MonitoringClusterConfig":{ "type":"structure", "required":[ "InstanceCount", "InstanceType", "VolumeSizeInGB" ], "members":{ "InstanceCount":{ "shape":"ProcessingInstanceCount", "documentation":"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.
" }, "InstanceType":{ "shape":"ProcessingInstanceType", "documentation":"The ML compute instance type for the processing job.
" }, "VolumeSizeInGB":{ "shape":"ProcessingVolumeSizeInGB", "documentation":"The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
" } }, "documentation":"Configuration for the cluster used to run model monitoring jobs.
" }, "MonitoringConstraintsResource":{ "type":"structure", "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"The Amazon S3 URI for the constraints resource.
" } }, "documentation":"The constraints resource for a monitoring job.
" }, "MonitoringContainerArguments":{ "type":"list", "member":{"shape":"ContainerArgument"}, "max":50, "min":1 }, "MonitoringEnvironmentMap":{ "type":"map", "key":{"shape":"ProcessingEnvironmentKey"}, "value":{"shape":"ProcessingEnvironmentValue"}, "max":50 }, "MonitoringExecutionSortKey":{ "type":"string", "enum":[ "CreationTime", "ScheduledTime", "Status" ] }, "MonitoringExecutionSummary":{ "type":"structure", "required":[ "MonitoringScheduleName", "ScheduledTime", "CreationTime", "LastModifiedTime", "MonitoringExecutionStatus" ], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule.
" }, "ScheduledTime":{ "shape":"Timestamp", "documentation":"The time the monitoring job was scheduled.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the monitoring job was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"A timestamp that indicates the last time the monitoring job was modified.
" }, "MonitoringExecutionStatus":{ "shape":"ExecutionStatus", "documentation":"The status of the monitoring job.
" }, "ProcessingJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring job.
" }, "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint used to run the monitoring job.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"Contains the reason a monitoring job failed, if it failed.
" }, "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the monitoring job.
" }, "MonitoringType":{ "shape":"MonitoringType", "documentation":"The type of the monitoring job.
" } }, "documentation":"Summary of information about the last monitoring job to run.
" }, "MonitoringExecutionSummaryList":{ "type":"list", "member":{"shape":"MonitoringExecutionSummary"} }, "MonitoringGroundTruthS3Input":{ "type":"structure", "members":{ "S3Uri":{ "shape":"MonitoringS3Uri", "documentation":"The address of the Amazon S3 location of the ground truth labels.
" } }, "documentation":"The ground truth labels for the dataset used for the monitoring job.
" }, "MonitoringInput":{ "type":"structure", "required":["EndpointInput"], "members":{ "EndpointInput":{ "shape":"EndpointInput", "documentation":"The endpoint for a monitoring job.
" } }, "documentation":"The inputs for a monitoring job.
" }, "MonitoringInputs":{ "type":"list", "member":{"shape":"MonitoringInput"}, "max":1, "min":1 }, "MonitoringJobDefinition":{ "type":"structure", "required":[ "MonitoringInputs", "MonitoringOutputConfig", "MonitoringResources", "MonitoringAppSpecification", "RoleArn" ], "members":{ "BaselineConfig":{ "shape":"MonitoringBaselineConfig", "documentation":"Baseline configuration used to validate that the data conforms to the specified constraints and statistics
" }, "MonitoringInputs":{ "shape":"MonitoringInputs", "documentation":"The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.
" }, "MonitoringOutputConfig":{ "shape":"MonitoringOutputConfig", "documentation":"The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
" }, "MonitoringResources":{ "shape":"MonitoringResources", "documentation":"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.
" }, "MonitoringAppSpecification":{ "shape":"MonitoringAppSpecification", "documentation":"Configures the monitoring job to run a specified Docker container image.
" }, "StoppingCondition":{ "shape":"MonitoringStoppingCondition", "documentation":"Specifies a time limit for how long the monitoring job is allowed to run.
" }, "Environment":{ "shape":"MonitoringEnvironmentMap", "documentation":"Sets the environment variables in the Docker container.
" }, "NetworkConfig":{ "shape":"NetworkConfig", "documentation":"Specifies networking options for an monitoring job.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
" } }, "documentation":"Defines the monitoring job.
" }, "MonitoringJobDefinitionArn":{ "type":"string", "max":256, "pattern":".*" }, "MonitoringJobDefinitionName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" }, "MonitoringJobDefinitionSortKey":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "MonitoringJobDefinitionSummary":{ "type":"structure", "required":[ "MonitoringJobDefinitionName", "MonitoringJobDefinitionArn", "CreationTime", "EndpointName" ], "members":{ "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the monitoring job.
" }, "MonitoringJobDefinitionArn":{ "shape":"MonitoringJobDefinitionArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring job.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the monitoring job was created.
" }, "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint that the job monitors.
" } }, "documentation":"Summary information about a monitoring job.
" }, "MonitoringJobDefinitionSummaryList":{ "type":"list", "member":{"shape":"MonitoringJobDefinitionSummary"} }, "MonitoringMaxRuntimeInSeconds":{ "type":"integer", "max":86400, "min":1 }, "MonitoringNetworkConfig":{ "type":"structure", "members":{ "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", "documentation":"Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
" }, "VpcConfig":{"shape":"VpcConfig"} }, "documentation":"The networking configuration for the monitoring job.
" }, "MonitoringOutput":{ "type":"structure", "required":["S3Output"], "members":{ "S3Output":{ "shape":"MonitoringS3Output", "documentation":"The Amazon S3 storage location where the results of a monitoring job are saved.
" } }, "documentation":"The output object for a monitoring job.
" }, "MonitoringOutputConfig":{ "type":"structure", "required":["MonitoringOutputs"], "members":{ "MonitoringOutputs":{ "shape":"MonitoringOutputs", "documentation":"Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
" } }, "documentation":"The output configuration for monitoring jobs.
" }, "MonitoringOutputs":{ "type":"list", "member":{"shape":"MonitoringOutput"}, "max":1, "min":1 }, "MonitoringProblemType":{ "type":"string", "enum":[ "BinaryClassification", "MulticlassClassification", "Regression" ] }, "MonitoringResources":{ "type":"structure", "required":["ClusterConfig"], "members":{ "ClusterConfig":{ "shape":"MonitoringClusterConfig", "documentation":"The configuration for the cluster resources used to run the processing job.
" } }, "documentation":"Identifies the resources to deploy for a monitoring job.
" }, "MonitoringS3Output":{ "type":"structure", "required":[ "S3Uri", "LocalPath" ], "members":{ "S3Uri":{ "shape":"MonitoringS3Uri", "documentation":"A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
" }, "LocalPath":{ "shape":"ProcessingLocalPath", "documentation":"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.
" }, "S3UploadMode":{ "shape":"ProcessingS3UploadMode", "documentation":"Whether to upload the results of the monitoring job continuously or after the job completes.
" } }, "documentation":"Information about where and how you want to store the results of a monitoring job.
" }, "MonitoringS3Uri":{ "type":"string", "max":512, "pattern":"^(https|s3)://([^/]+)/?(.*)$" }, "MonitoringSchedule":{ "type":"structure", "members":{ "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring schedule.
" }, "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule.
" }, "MonitoringScheduleStatus":{ "shape":"ScheduleStatus", "documentation":"The status of the monitoring schedule. This can be one of the following values.
PENDING - The schedule is pending being created.
FAILED - The schedule failed.
SCHEDULED - The schedule was successfully created.
STOPPED - The schedule was stopped.
The type of the monitoring job definition to schedule.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the monitoring schedule failed, the reason it failed.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the monitoring schedule was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last time the monitoring schedule was changed.
" }, "MonitoringScheduleConfig":{"shape":"MonitoringScheduleConfig"}, "EndpointName":{ "shape":"EndpointName", "documentation":"The endpoint that hosts the model being monitored.
" }, "LastMonitoringExecutionSummary":{"shape":"MonitoringExecutionSummary"}, "Tags":{ "shape":"TagList", "documentation":"A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
" } }, "documentation":"A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.
" }, "MonitoringScheduleArn":{ "type":"string", "max":256, "pattern":".*" }, "MonitoringScheduleConfig":{ "type":"structure", "members":{ "ScheduleConfig":{ "shape":"ScheduleConfig", "documentation":"Configures the monitoring schedule.
" }, "MonitoringJobDefinition":{ "shape":"MonitoringJobDefinition", "documentation":"Defines the monitoring job.
" }, "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the monitoring job definition to schedule.
" }, "MonitoringType":{ "shape":"MonitoringType", "documentation":"The type of the monitoring job definition to schedule.
" } }, "documentation":"Configures the monitoring schedule and defines the monitoring job.
" }, "MonitoringScheduleList":{ "type":"list", "member":{"shape":"MonitoringSchedule"} }, "MonitoringScheduleName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" }, "MonitoringScheduleSortKey":{ "type":"string", "enum":[ "Name", "CreationTime", "Status" ] }, "MonitoringScheduleSummary":{ "type":"structure", "required":[ "MonitoringScheduleName", "MonitoringScheduleArn", "CreationTime", "LastModifiedTime", "MonitoringScheduleStatus" ], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule.
" }, "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring schedule.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The creation time of the monitoring schedule.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The last time the monitoring schedule was modified.
" }, "MonitoringScheduleStatus":{ "shape":"ScheduleStatus", "documentation":"The status of the monitoring schedule.
" }, "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint using the monitoring schedule.
" }, "MonitoringJobDefinitionName":{ "shape":"MonitoringJobDefinitionName", "documentation":"The name of the monitoring job definition that the schedule is for.
" }, "MonitoringType":{ "shape":"MonitoringType", "documentation":"The type of the monitoring job definition that the schedule is for.
" } }, "documentation":"Summarizes the monitoring schedule.
" }, "MonitoringScheduleSummaryList":{ "type":"list", "member":{"shape":"MonitoringScheduleSummary"} }, "MonitoringStatisticsResource":{ "type":"structure", "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"The Amazon S3 URI for the statistics resource.
" } }, "documentation":"The statistics resource for a monitoring job.
" }, "MonitoringStoppingCondition":{ "type":"structure", "required":["MaxRuntimeInSeconds"], "members":{ "MaxRuntimeInSeconds":{ "shape":"MonitoringMaxRuntimeInSeconds", "documentation":"The maximum runtime allowed in seconds.
" } }, "documentation":"A time limit for how long the monitoring job is allowed to run before stopping.
" }, "MonitoringTimeOffsetString":{ "type":"string", "max":15, "min":1, "pattern":"^.?P.*" }, "MonitoringType":{ "type":"string", "enum":[ "DataQuality", "ModelQuality", "ModelBias", "ModelExplainability" ] }, "MountPath":{ "type":"string", "max":1024, "pattern":"^\\/.*" }, "MultiModelConfig":{ "type":"structure", "members":{ "ModelCacheSetting":{ "shape":"ModelCacheSetting", "documentation":"Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.
Specifies additional configuration for hosting multi-model endpoints.
" }, "NameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9\\-]+" }, "NestedFilters":{ "type":"structure", "required":[ "NestedPropertyName", "Filters" ], "members":{ "NestedPropertyName":{ "shape":"ResourcePropertyName", "documentation":"The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
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.
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's InputDataConfig property with a specific channel name and S3Uri prefix, define the following filters:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"Equals\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"Contains\", \"Value\":\"mybucket/catdata\"}'
Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
" }, "VpcConfig":{"shape":"VpcConfig"} }, "documentation":"Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
" }, "NetworkInterfaceId":{"type":"string"}, "NextToken":{ "type":"string", "max":8192, "pattern":".*" }, "NotebookInstanceAcceleratorType":{ "type":"string", "enum":[ "ml.eia1.medium", "ml.eia1.large", "ml.eia1.xlarge", "ml.eia2.medium", "ml.eia2.large", "ml.eia2.xlarge" ] }, "NotebookInstanceAcceleratorTypes":{ "type":"list", "member":{"shape":"NotebookInstanceAcceleratorType"} }, "NotebookInstanceArn":{ "type":"string", "max":256 }, "NotebookInstanceLifecycleConfigArn":{ "type":"string", "max":256 }, "NotebookInstanceLifecycleConfigContent":{ "type":"string", "max":16384, "min":1, "pattern":"[\\S\\s]+" }, "NotebookInstanceLifecycleConfigList":{ "type":"list", "member":{"shape":"NotebookInstanceLifecycleHook"}, "max":1 }, "NotebookInstanceLifecycleConfigName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "NotebookInstanceLifecycleConfigNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "NotebookInstanceLifecycleConfigSortKey":{ "type":"string", "enum":[ "Name", "CreationTime", "LastModifiedTime" ] }, "NotebookInstanceLifecycleConfigSortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "NotebookInstanceLifecycleConfigSummary":{ "type":"structure", "required":[ "NotebookInstanceLifecycleConfigName", "NotebookInstanceLifecycleConfigArn" ], "members":{ "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"The name of the lifecycle configuration.
" }, "NotebookInstanceLifecycleConfigArn":{ "shape":"NotebookInstanceLifecycleConfigArn", "documentation":"The Amazon Resource Name (ARN) of the lifecycle configuration.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp that tells when the lifecycle configuration was created.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"A timestamp that tells when the lifecycle configuration was last modified.
" } }, "documentation":"Provides a summary of a notebook instance lifecycle configuration.
" }, "NotebookInstanceLifecycleConfigSummaryList":{ "type":"list", "member":{"shape":"NotebookInstanceLifecycleConfigSummary"} }, "NotebookInstanceLifecycleHook":{ "type":"structure", "members":{ "Content":{ "shape":"NotebookInstanceLifecycleConfigContent", "documentation":"A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
" } }, "documentation":"Contains the notebook instance lifecycle configuration script.
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.
" }, "NotebookInstanceName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "NotebookInstanceNameContains":{ "type":"string", "max":63, "pattern":"[a-zA-Z0-9-]+" }, "NotebookInstanceSortKey":{ "type":"string", "enum":[ "Name", "CreationTime", "Status" ] }, "NotebookInstanceSortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "NotebookInstanceStatus":{ "type":"string", "enum":[ "Pending", "InService", "Stopping", "Stopped", "Failed", "Deleting", "Updating" ] }, "NotebookInstanceSummary":{ "type":"structure", "required":[ "NotebookInstanceName", "NotebookInstanceArn" ], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance that you want a summary for.
" }, "NotebookInstanceArn":{ "shape":"NotebookInstanceArn", "documentation":"The Amazon Resource Name (ARN) of the notebook instance.
" }, "NotebookInstanceStatus":{ "shape":"NotebookInstanceStatus", "documentation":"The status of the notebook instance.
" }, "Url":{ "shape":"NotebookInstanceUrl", "documentation":"The URL that you use to connect to the Jupyter instance running in your notebook instance.
" }, "InstanceType":{ "shape":"InstanceType", "documentation":"The type of ML compute instance that the notebook instance is running on.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"A timestamp that shows when the notebook instance was created.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"A timestamp that shows when the notebook instance was last modified.
" }, "NotebookInstanceLifecycleConfigName":{ "shape":"NotebookInstanceLifecycleConfigName", "documentation":"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.
" }, "DefaultCodeRepository":{ "shape":"CodeRepositoryNameOrUrl", "documentation":"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.
" }, "AdditionalCodeRepositories":{ "shape":"AdditionalCodeRepositoryNamesOrUrls", "documentation":"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.
" } }, "documentation":"Provides summary information for an Amazon SageMaker notebook instance.
" }, "NotebookInstanceSummaryList":{ "type":"list", "member":{"shape":"NotebookInstanceSummary"} }, "NotebookInstanceUrl":{"type":"string"}, "NotebookInstanceVolumeSizeInGB":{ "type":"integer", "max":16384, "min":5 }, "NotebookOutputOption":{ "type":"string", "enum":[ "Allowed", "Disabled" ] }, "NotificationConfiguration":{ "type":"structure", "members":{ "NotificationTopicArn":{ "shape":"NotificationTopicArn", "documentation":"The ARN for the SNS topic to which notifications should be published.
" } }, "documentation":"Configures SNS notifications of available or expiring work items for work teams.
" }, "NotificationTopicArn":{ "type":"string", "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" }, "NumberOfHumanWorkersPerDataObject":{ "type":"integer", "max":9, "min":1 }, "ObjectiveStatus":{ "type":"string", "enum":[ "Succeeded", "Pending", "Failed" ] }, "ObjectiveStatusCounter":{ "type":"integer", "min":0 }, "ObjectiveStatusCounters":{ "type":"structure", "members":{ "Succeeded":{ "shape":"ObjectiveStatusCounter", "documentation":"The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
" }, "Pending":{ "shape":"ObjectiveStatusCounter", "documentation":"The number of training jobs that are in progress and pending evaluation of their final objective metric.
" }, "Failed":{ "shape":"ObjectiveStatusCounter", "documentation":"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.
" } }, "documentation":"Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
" }, "OfflineStoreConfig":{ "type":"structure", "required":["S3StorageConfig"], "members":{ "S3StorageConfig":{ "shape":"S3StorageConfig", "documentation":"The Amazon Simple Storage (Amazon S3) location of OfflineStore.
Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
The meta data of the Glue table that is autogenerated when an OfflineStore is created.
The configuration of an OfflineStore.
Provide an OfflineStoreConfig in a request to CreateFeatureGroup to create an OfflineStore.
To encrypt an OfflineStore using at rest data encryption, specify AWS Key Management Service (KMS) key ID, or KMSKeyId, in S3StorageConfig.
An OfflineStore status.
The justification for why the OfflineStoreStatus is Blocked (if applicable).
" } }, "documentation":"The status of OfflineStore.
The OIDC IdP client ID used to configure your private workforce.
" }, "ClientSecret":{ "shape":"ClientSecret", "documentation":"The OIDC IdP client secret used to configure your private workforce.
" }, "Issuer":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP issuer used to configure your private workforce.
" }, "AuthorizationEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP authorization endpoint used to configure your private workforce.
" }, "TokenEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP token endpoint used to configure your private workforce.
" }, "UserInfoEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP user information endpoint used to configure your private workforce.
" }, "LogoutEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP logout endpoint used to configure your private workforce.
" }, "JwksUri":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
" } }, "documentation":"Use this parameter to configure your OIDC Identity Provider (IdP).
" }, "OidcConfigForResponse":{ "type":"structure", "members":{ "ClientId":{ "shape":"ClientId", "documentation":"The OIDC IdP client ID used to configure your private workforce.
" }, "Issuer":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP issuer used to configure your private workforce.
" }, "AuthorizationEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP authorization endpoint used to configure your private workforce.
" }, "TokenEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP token endpoint used to configure your private workforce.
" }, "UserInfoEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP user information endpoint used to configure your private workforce.
" }, "LogoutEndpoint":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP logout endpoint used to configure your private workforce.
" }, "JwksUri":{ "shape":"OidcEndpoint", "documentation":"The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
" } }, "documentation":"Your OIDC IdP workforce configuration.
" }, "OidcEndpoint":{ "type":"string", "max":500, "pattern":"https://\\S+" }, "OidcMemberDefinition":{ "type":"structure", "required":["Groups"], "members":{ "Groups":{ "shape":"Groups", "documentation":"A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
" } }, "documentation":"A list of user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
The default value is False.
Use this to specify the AWS Key Management Service (KMS) Key ID, or KMSKeyId, for at rest data encryption. You can turn OnlineStore on or off by specifying the EnableOnlineStore flag at General Assembly; the default value is False.
The ID of the AWS Key Management Service (AWS KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either IAM user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:
\"kms:Encrypt\"
\"kms:Decrypt\"
\"kms:DescribeKey\"
\"kms:CreateGrant\"
\"kms:RetireGrant\"
\"kms:ReEncryptFrom\"
\"kms:ReEncryptTo\"
\"kms:GenerateDataKey\"
\"kms:ListAliases\"
\"kms:ListGrants\"
\"kms:RevokeGrant\"
The caller (either IAM user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:
\"kms:Decrypt\"
The security configuration for OnlineStore.
Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.
The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:
Raspberry Pi 3 Model B+
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},
\"CompilerOptions\": {'mattr': ['+neon']}
Jetson TX2
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"NVIDIA\"},
\"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}
EC2 m5.2xlarge instance OS
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\": \"NVIDIA\"},
\"CompilerOptions\": {'mcpu': 'skylake-avx512'}
RK3399
\"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\": \"MALI\"}
ARMv7 phone (CPU)
\"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},
\"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}
ARMv8 phone (CPU)
\"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},
\"CompilerOptions\": {'ANDROID_PLATFORM': 29}
Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.
DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model's input. \"float32\" is used if \"DTYPE\" is not specified. Options for data type are:
float32: Use either \"float\" or \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
CPU: Compilation for CPU supports the following compiler options.
mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
ARM: Details of ARM CPU compilations.
NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.
NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.
gpu_code: Specifies the targeted architecture.
trt-ver: Specifies the TensorRT versions in x.y.z. format.
cuda-ver: Specifies the CUDA version in x.y format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}
ANDROID: Compilation for the Android OS supports the following compiler options:
ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.
mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.
INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".
For information about supported compiler options, see Neuron Compiler CLI.
CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:
class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {\"class_labels\": \"imagenet_labels_1000.txt\"}. Labels inside the txt file should be separated by newlines.
EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:
precision_mode: Specifies the precision of compiled artifacts. Supported values are \"FP16\" and \"FP32\". Default is \"FP32\".
signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow's default signature def key.
output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.
For example: {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account
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
Contains information about the output location for the compiled model and the target device that the model runs on. TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.
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.
Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
Provides information about how to store model training results (model artifacts).
" }, "PaginationToken":{ "type":"string", "max":8192, "pattern":".*" }, "Parameter":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"PipelineParameterName", "documentation":"The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
" }, "Value":{ "shape":"String1024", "documentation":"The literal value for the parameter.
" } }, "documentation":"Assigns a value to a named Pipeline parameter.
" }, "ParameterKey":{ "type":"string", "max":256, "pattern":".*" }, "ParameterList":{ "type":"list", "member":{"shape":"Parameter"}, "max":50, "min":0 }, "ParameterName":{ "type":"string", "max":256, "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "ParameterRange":{ "type":"structure", "members":{ "IntegerParameterRangeSpecification":{ "shape":"IntegerParameterRangeSpecification", "documentation":"A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.
A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.
A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.
" }, "ParameterRanges":{ "type":"structure", "members":{ "IntegerParameterRanges":{ "shape":"IntegerParameterRanges", "documentation":"The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.
" }, "ContinuousParameterRanges":{ "shape":"ContinuousParameterRanges", "documentation":"The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.
" }, "CategoricalParameterRanges":{ "shape":"CategoricalParameterRanges", "documentation":"The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.
" } }, "documentation":"Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.
You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.
The name of the trial.
" }, "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment.
" } }, "documentation":"The trial that a trial component is associated with and the experiment the trial is part of. A component might not be associated with a trial. A component can be associated with multiple trials.
" }, "ParentHyperParameterTuningJob":{ "type":"structure", "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
" } }, "documentation":"A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.
" }, "ParentHyperParameterTuningJobs":{ "type":"list", "member":{"shape":"ParentHyperParameterTuningJob"}, "max":5, "min":1 }, "Parents":{ "type":"list", "member":{"shape":"Parent"} }, "Pipeline":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" }, "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline.
" }, "PipelineDisplayName":{ "shape":"PipelineName", "documentation":"The display name of the pipeline.
" }, "PipelineDescription":{ "shape":"PipelineDescription", "documentation":"The description of the pipeline.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the role that created the pipeline.
" }, "PipelineStatus":{ "shape":"PipelineStatus", "documentation":"The status of the pipeline.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The creation time of the pipeline.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time that the pipeline was last modified.
" }, "LastRunTime":{ "shape":"Timestamp", "documentation":"The time when the pipeline was last run.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedBy":{"shape":"UserContext"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags that apply to the pipeline.
" } }, "documentation":"A SageMaker Model Building Pipeline instance.
" }, "PipelineArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*" }, "PipelineDefinition":{ "type":"string", "max":1048576, "min":1, "pattern":".*(?:[ \\r\\n\\t].*)*" }, "PipelineDescription":{ "type":"string", "max":3072, "min":0, "pattern":".*" }, "PipelineExecution":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline that was executed.
" }, "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" }, "PipelineExecutionDisplayName":{ "shape":"PipelineExecutionName", "documentation":"The display name of the pipeline execution.
" }, "PipelineExecutionStatus":{ "shape":"PipelineExecutionStatus", "documentation":"The status of the pipeline status.
" }, "PipelineExecutionDescription":{ "shape":"PipelineExecutionDescription", "documentation":"The description of the pipeline execution.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The creation time of the pipeline execution.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time that the pipeline execution was last modified.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedBy":{"shape":"UserContext"}, "PipelineParameters":{ "shape":"ParameterList", "documentation":"Contains a list of pipeline parameters. This list can be empty.
" } }, "documentation":"An execution of a pipeline.
" }, "PipelineExecutionArn":{ "type":"string", "max":256, "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$" }, "PipelineExecutionDescription":{ "type":"string", "max":3072, "min":0, "pattern":".*" }, "PipelineExecutionName":{ "type":"string", "max":82, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}" }, "PipelineExecutionStatus":{ "type":"string", "enum":[ "Executing", "Stopping", "Stopped", "Failed", "Succeeded" ] }, "PipelineExecutionStep":{ "type":"structure", "members":{ "StepName":{ "shape":"StepName", "documentation":"The name of the step that is executed.
" }, "StartTime":{ "shape":"Timestamp", "documentation":"The time that the step started executing.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"The time that the step stopped executing.
" }, "StepStatus":{ "shape":"StepStatus", "documentation":"The status of the step execution.
" }, "CacheHitResult":{ "shape":"CacheHitResult", "documentation":"If this pipeline execution step was cached, details on the cache hit.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"The reason why the step failed execution. This is only returned if the step failed its execution.
" }, "Metadata":{ "shape":"PipelineExecutionStepMetadata", "documentation":"The metadata for the step execution.
" } }, "documentation":"An execution of a step in a pipeline.
" }, "PipelineExecutionStepList":{ "type":"list", "member":{"shape":"PipelineExecutionStep"}, "max":100, "min":0 }, "PipelineExecutionStepMetadata":{ "type":"structure", "members":{ "TrainingJob":{ "shape":"TrainingJobStepMetadata", "documentation":"The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" }, "ProcessingJob":{ "shape":"ProcessingJobStepMetadata", "documentation":"The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
" }, "TransformJob":{ "shape":"TransformJobStepMetadata", "documentation":"The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" }, "Model":{ "shape":"ModelStepMetadata", "documentation":"Metadata for the Model step.
" }, "RegisterModel":{ "shape":"RegisterModelStepMetadata", "documentation":"Metadata for the RegisterModel step.
" }, "Condition":{ "shape":"ConditionStepMetadata", "documentation":"If this is a Condition step metadata object, details on the condition.
" } }, "documentation":"Metadata for a step execution.
" }, "PipelineExecutionSummary":{ "type":"structure", "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" }, "StartTime":{ "shape":"Timestamp", "documentation":"The start time of the pipeline execution.
" }, "PipelineExecutionStatus":{ "shape":"PipelineExecutionStatus", "documentation":"The status of the pipeline execution.
" }, "PipelineExecutionDescription":{ "shape":"PipelineExecutionDescription", "documentation":"The description of the pipeline execution.
" }, "PipelineExecutionDisplayName":{ "shape":"PipelineExecutionName", "documentation":"The display name of the pipeline execution.
" } }, "documentation":"A pipeline execution summary.
" }, "PipelineExecutionSummaryList":{ "type":"list", "member":{"shape":"PipelineExecutionSummary"}, "max":100, "min":0 }, "PipelineName":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" }, "PipelineParameterName":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$" }, "PipelineStatus":{ "type":"string", "enum":["Active"] }, "PipelineSummary":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline.
" }, "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline.
" }, "PipelineDisplayName":{ "shape":"PipelineName", "documentation":"The display name of the pipeline.
" }, "PipelineDescription":{ "shape":"PipelineDescription", "documentation":"The description of the pipeline.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that the pipeline used to execute.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The creation time of the pipeline.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time that the pipeline was last modified.
" }, "LastExecutionTime":{ "shape":"Timestamp", "documentation":"The last time that a pipeline execution began.
" } }, "documentation":"A summary of a pipeline.
" }, "PipelineSummaryList":{ "type":"list", "member":{"shape":"PipelineSummary"}, "max":100, "min":0 }, "PolicyString":{ "type":"string", "max":20480, "min":1, "pattern":".*" }, "PresignedDomainUrl":{"type":"string"}, "ProbabilityThresholdAttribute":{"type":"double"}, "ProblemType":{ "type":"string", "enum":[ "BinaryClassification", "MulticlassClassification", "Regression" ] }, "ProcessingClusterConfig":{ "type":"structure", "required":[ "InstanceCount", "InstanceType", "VolumeSizeInGB" ], "members":{ "InstanceCount":{ "shape":"ProcessingInstanceCount", "documentation":"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.
" }, "InstanceType":{ "shape":"ProcessingInstanceType", "documentation":"The ML compute instance type for the processing job.
" }, "VolumeSizeInGB":{ "shape":"ProcessingVolumeSizeInGB", "documentation":"The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
" }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
" } }, "documentation":"Configuration for the cluster used to run a processing job.
" }, "ProcessingEnvironmentKey":{ "type":"string", "max":256, "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" }, "ProcessingEnvironmentMap":{ "type":"map", "key":{"shape":"ProcessingEnvironmentKey"}, "value":{"shape":"ProcessingEnvironmentValue"}, "max":100 }, "ProcessingEnvironmentValue":{ "type":"string", "max":256, "pattern":"[\\S\\s]*" }, "ProcessingFeatureStoreOutput":{ "type":"structure", "required":["FeatureGroupName"], "members":{ "FeatureGroupName":{ "shape":"FeatureGroupName", "documentation":"The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.
" } }, "documentation":"Configuration for processing job outputs in Amazon SageMaker Feature Store.
" }, "ProcessingInput":{ "type":"structure", "required":["InputName"], "members":{ "InputName":{ "shape":"String", "documentation":"The name for the processing job input.
" }, "AppManaged":{ "shape":"AppManaged", "documentation":"When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
Configuration for downloading input data from Amazon S3 into the processing container.
" }, "DatasetDefinition":{ "shape":"DatasetDefinition", "documentation":"Configuration for a Dataset Definition input.
" } }, "documentation":"The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
List of input configurations for the processing job.
" }, "ProcessingOutputConfig":{"shape":"ProcessingOutputConfig"}, "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job.
" }, "ProcessingResources":{"shape":"ProcessingResources"}, "StoppingCondition":{"shape":"ProcessingStoppingCondition"}, "AppSpecification":{"shape":"AppSpecification"}, "Environment":{ "shape":"ProcessingEnvironmentMap", "documentation":"Sets the environment variables in the Docker container.
" }, "NetworkConfig":{"shape":"NetworkConfig"}, "RoleArn":{ "shape":"RoleArn", "documentation":"The ARN of the role used to create the processing job.
" }, "ExperimentConfig":{"shape":"ExperimentConfig"}, "ProcessingJobArn":{ "shape":"ProcessingJobArn", "documentation":"The ARN of the processing job.
" }, "ProcessingJobStatus":{ "shape":"ProcessingJobStatus", "documentation":"The status of the processing job.
" }, "ExitMessage":{ "shape":"ExitMessage", "documentation":"A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" }, "ProcessingEndTime":{ "shape":"Timestamp", "documentation":"The time that the processing job ended.
" }, "ProcessingStartTime":{ "shape":"Timestamp", "documentation":"The time that the processing job started.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The time the processing job was last modified.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time the processing job was created.
" }, "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The ARN of a monitoring schedule for an endpoint associated with this processing job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The ARN of the training job associated with this processing job.
" }, "Tags":{ "shape":"TagList", "documentation":"An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
" } }, "documentation":"An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
" }, "ProcessingJobArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/.*" }, "ProcessingJobName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "ProcessingJobStatus":{ "type":"string", "enum":[ "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "ProcessingJobStepMetadata":{ "type":"structure", "members":{ "Arn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the processing job.
" } }, "documentation":"Metadata for a processing job step.
" }, "ProcessingJobSummaries":{ "type":"list", "member":{"shape":"ProcessingJobSummary"} }, "ProcessingJobSummary":{ "type":"structure", "required":[ "ProcessingJobName", "ProcessingJobArn", "CreationTime", "ProcessingJobStatus" ], "members":{ "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job.
" }, "ProcessingJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the processing job..
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job was created.
" }, "ProcessingEndTime":{ "shape":"Timestamp", "documentation":"The time at which the processing job completed.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"A timestamp that indicates the last time the processing job was modified.
" }, "ProcessingJobStatus":{ "shape":"ProcessingJobStatus", "documentation":"The status of the processing job.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
" }, "ExitMessage":{ "shape":"ExitMessage", "documentation":"An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
" } }, "documentation":"Summary of information about a processing job.
" }, "ProcessingLocalPath":{ "type":"string", "max":256, "pattern":".*" }, "ProcessingMaxRuntimeInSeconds":{ "type":"integer", "max":604800, "min":1 }, "ProcessingOutput":{ "type":"structure", "required":["OutputName"], "members":{ "OutputName":{ "shape":"String", "documentation":"The name for the processing job output.
" }, "S3Output":{ "shape":"ProcessingS3Output", "documentation":"Configuration for processing job outputs in Amazon S3.
" }, "FeatureStoreOutput":{ "shape":"ProcessingFeatureStoreOutput", "documentation":"Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.
When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
An array of outputs configuring the data to upload from the processing container.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"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.
Configuration for uploading output from the processing container.
" }, "ProcessingOutputs":{ "type":"list", "member":{"shape":"ProcessingOutput"}, "max":10, "min":0 }, "ProcessingResources":{ "type":"structure", "required":["ClusterConfig"], "members":{ "ClusterConfig":{ "shape":"ProcessingClusterConfig", "documentation":"The configuration for the resources in a cluster used to run the processing job.
" } }, "documentation":"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.
" }, "ProcessingS3CompressionType":{ "type":"string", "enum":[ "None", "Gzip" ] }, "ProcessingS3DataDistributionType":{ "type":"string", "enum":[ "FullyReplicated", "ShardedByS3Key" ] }, "ProcessingS3DataType":{ "type":"string", "enum":[ "ManifestFile", "S3Prefix" ] }, "ProcessingS3Input":{ "type":"structure", "required":[ "S3Uri", "S3DataType" ], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
" }, "LocalPath":{ "shape":"ProcessingLocalPath", "documentation":"The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
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.
Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
Configuration for downloading input data from Amazon S3 into the processing container.
" }, "ProcessingS3InputMode":{ "type":"string", "enum":[ "Pipe", "File" ] }, "ProcessingS3Output":{ "type":"structure", "required":[ "S3Uri", "LocalPath", "S3UploadMode" ], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
" }, "LocalPath":{ "shape":"ProcessingLocalPath", "documentation":"The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.
Whether to upload the results of the processing job continuously or after the job completes.
" } }, "documentation":"Configuration for uploading output data to Amazon S3 from the processing container.
" }, "ProcessingS3UploadMode":{ "type":"string", "enum":[ "Continuous", "EndOfJob" ] }, "ProcessingStoppingCondition":{ "type":"structure", "required":["MaxRuntimeInSeconds"], "members":{ "MaxRuntimeInSeconds":{ "shape":"ProcessingMaxRuntimeInSeconds", "documentation":"Specifies the maximum runtime in seconds.
" } }, "documentation":"Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
" }, "ProcessingVolumeSizeInGB":{ "type":"integer", "max":16384, "min":1 }, "ProductId":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" }, "ProductListings":{ "type":"list", "member":{"shape":"String"} }, "ProductionVariant":{ "type":"structure", "required":[ "VariantName", "ModelName", "InitialInstanceCount", "InstanceType" ], "members":{ "VariantName":{ "shape":"VariantName", "documentation":"The name of the production variant.
" }, "ModelName":{ "shape":"ModelName", "documentation":"The name of the model that you want to host. This is the name that you specified when creating the model.
" }, "InitialInstanceCount":{ "shape":"TaskCount", "documentation":"Number of instances to launch initially.
" }, "InstanceType":{ "shape":"ProductionVariantInstanceType", "documentation":"The ML compute instance type.
" }, "InitialVariantWeight":{ "shape":"VariantWeight", "documentation":"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.
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.
" }, "CoreDumpConfig":{ "shape":"ProductionVariantCoreDumpConfig", "documentation":"Specifies configuration for a core dump from the model container when the process crashes.
" } }, "documentation":"Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.
" }, "ProductionVariantAcceleratorType":{ "type":"string", "enum":[ "ml.eia1.medium", "ml.eia1.large", "ml.eia1.xlarge", "ml.eia2.medium", "ml.eia2.large", "ml.eia2.xlarge" ] }, "ProductionVariantCoreDumpConfig":{ "type":"structure", "required":["DestinationS3Uri"], "members":{ "DestinationS3Uri":{ "shape":"DestinationS3Uri", "documentation":"The Amazon S3 bucket to send the core dump to.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the core dump data 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 CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
Specifies configuration for a core dump from the model container when the process crashes.
" }, "ProductionVariantInstanceType":{ "type":"string", "enum":[ "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" ] }, "ProductionVariantList":{ "type":"list", "member":{"shape":"ProductionVariant"}, "max":10, "min":1 }, "ProductionVariantSummary":{ "type":"structure", "required":["VariantName"], "members":{ "VariantName":{ "shape":"VariantName", "documentation":"The name of the variant.
" }, "DeployedImages":{ "shape":"DeployedImages", "documentation":"An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.
The weight associated with the variant.
" }, "DesiredWeight":{ "shape":"VariantWeight", "documentation":"The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.
The number of instances associated with the variant.
" }, "DesiredInstanceCount":{ "shape":"TaskCount", "documentation":"The number of instances requested in the UpdateEndpointWeightsAndCapacities request.
Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.
Path to Amazon S3 storage location for system and framework metrics.
" }, "ProfilingIntervalInMilliseconds":{ "shape":"ProfilingIntervalInMilliseconds", "documentation":"A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" }, "ProfilingParameters":{ "shape":"ProfilingParameters", "documentation":"Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for Debugger system monitoring, framework profiling, and storage paths.
" }, "ProfilerConfigForUpdate":{ "type":"structure", "members":{ "S3OutputPath":{ "shape":"S3Uri", "documentation":"Path to Amazon S3 storage location for system and framework metrics.
" }, "ProfilingIntervalInMilliseconds":{ "shape":"ProfilingIntervalInMilliseconds", "documentation":"A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" }, "ProfilingParameters":{ "shape":"ProfilingParameters", "documentation":"Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
To disable Debugger monitoring and profiling, set to True.
Configuration information for updating the Debugger profile parameters, system and framework metrics configurations, and storage paths.
" }, "ProfilerRuleConfiguration":{ "type":"structure", "required":[ "RuleConfigurationName", "RuleEvaluatorImage" ], "members":{ "RuleConfigurationName":{ "shape":"RuleConfigurationName", "documentation":"The name of the rule configuration. It must be unique relative to other rule configuration names.
" }, "LocalPath":{ "shape":"DirectoryPath", "documentation":"Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to Amazon S3 storage location for rules.
" }, "RuleEvaluatorImage":{ "shape":"AlgorithmImage", "documentation":"The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
" }, "InstanceType":{ "shape":"ProcessingInstanceType", "documentation":"The instance type to deploy a Debugger custom rule for profiling a training job.
" }, "VolumeSizeInGB":{ "shape":"OptionalVolumeSizeInGB", "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
" }, "RuleParameters":{ "shape":"RuleParameters", "documentation":"Runtime configuration for rule container.
" } }, "documentation":"Configuration information for profiling rules.
" }, "ProfilerRuleConfigurations":{ "type":"list", "member":{"shape":"ProfilerRuleConfiguration"}, "max":20, "min":0 }, "ProfilerRuleEvaluationStatus":{ "type":"structure", "members":{ "RuleConfigurationName":{ "shape":"RuleConfigurationName", "documentation":"The name of the rule configuration.
" }, "RuleEvaluationJobArn":{ "shape":"ProcessingJobArn", "documentation":"The Amazon Resource Name (ARN) of the rule evaluation job.
" }, "RuleEvaluationStatus":{ "shape":"RuleEvaluationStatus", "documentation":"Status of the rule evaluation.
" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"Details from the rule evaluation.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Timestamp when the rule evaluation status was last modified.
" } }, "documentation":"Information about the status of the rule evaluation.
" }, "ProfilerRuleEvaluationStatuses":{ "type":"list", "member":{"shape":"ProfilerRuleEvaluationStatus"}, "max":20, "min":0 }, "ProfilingIntervalInMilliseconds":{"type":"long"}, "ProfilingParameters":{ "type":"map", "key":{"shape":"ConfigKey"}, "value":{"shape":"ConfigValue"}, "max":20, "min":0 }, "ProfilingStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ProjectArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:project:.*" }, "ProjectEntityName":{ "type":"string", "max":32, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" }, "ProjectId":{ "type":"string", "max":20, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ProjectSortBy":{ "type":"string", "enum":[ "Name", "CreationTime" ] }, "ProjectSortOrder":{ "type":"string", "enum":[ "Ascending", "Descending" ] }, "ProjectStatus":{ "type":"string", "enum":[ "Pending", "CreateInProgress", "CreateCompleted", "CreateFailed", "DeleteInProgress", "DeleteFailed", "DeleteCompleted" ] }, "ProjectSummary":{ "type":"structure", "required":[ "ProjectName", "ProjectArn", "ProjectId", "CreationTime", "ProjectStatus" ], "members":{ "ProjectName":{ "shape":"ProjectEntityName", "documentation":"The name of the project.
" }, "ProjectDescription":{ "shape":"EntityDescription", "documentation":"The description of the project.
" }, "ProjectArn":{ "shape":"ProjectArn", "documentation":"The Amazon Resource Name (ARN) of the project.
" }, "ProjectId":{ "shape":"ProjectId", "documentation":"The ID of the project.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the project was created.
" }, "ProjectStatus":{ "shape":"ProjectStatus", "documentation":"The status of the project.
" } }, "documentation":"Information about a project.
" }, "ProjectSummaryList":{ "type":"list", "member":{"shape":"ProjectSummary"} }, "PropertyNameHint":{ "type":"string", "max":100, "min":0, "pattern":".*" }, "PropertyNameQuery":{ "type":"structure", "required":["PropertyNameHint"], "members":{ "PropertyNameHint":{ "shape":"PropertyNameHint", "documentation":"Text that begins a property's name.
" } }, "documentation":"Part of the SuggestionQuery type. Specifies a hint for retrieving property names that begin with the specified text.
A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.
" } }, "documentation":"A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.
The key that identifies a provisioning parameter.
" }, "Value":{ "shape":"ProvisioningParameterValue", "documentation":"The value of the provisioning parameter.
" } }, "documentation":"A key value pair used when you provision a project as a service catalog product. For information, see What is AWS Service Catalog.
" }, "ProvisioningParameterKey":{ "type":"string", "max":1000, "min":1, "pattern":".*" }, "ProvisioningParameterValue":{ "type":"string", "max":4096, "pattern":".*" }, "ProvisioningParameters":{ "type":"list", "member":{"shape":"ProvisioningParameter"} }, "PublicWorkforceTaskPrice":{ "type":"structure", "members":{ "AmountInUsd":{ "shape":"USD", "documentation":"Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
" } }, "documentation":"Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
0.012
0.024
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
0.840
0.960
1.080
1.200
Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.
2.400
2.280
2.160
2.040
1.920
1.800
1.680
1.560
1.440
1.320
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.
1.200
1.080
0.960
0.840
0.720
0.600
0.480
0.360
0.240
0.120
0.072
0.060
0.048
0.036
0.024
0.012
The name of the model group to add a resource policy to.
" }, "ResourcePolicy":{ "shape":"PolicyString", "documentation":"The resource policy for the model group.
" } } }, "PutModelPackageGroupPolicyOutput":{ "type":"structure", "required":["ModelPackageGroupArn"], "members":{ "ModelPackageGroupArn":{ "shape":"ModelPackageGroupArn", "documentation":"The Amazon Resource Name (ARN) of the model package group.
" } } }, "RealtimeInferenceInstanceTypes":{ "type":"list", "member":{"shape":"ProductionVariantInstanceType"} }, "RecordWrapper":{ "type":"string", "enum":[ "None", "RecordIO" ] }, "RedshiftClusterId":{ "type":"string", "documentation":"The Redshift cluster Identifier.
", "max":63, "min":1, "pattern":".*" }, "RedshiftDatabase":{ "type":"string", "documentation":"The name of the Redshift database used in Redshift query execution.
", "max":64, "min":1, "pattern":".*" }, "RedshiftDatasetDefinition":{ "type":"structure", "required":[ "ClusterId", "Database", "DbUser", "QueryString", "ClusterRoleArn", "OutputS3Uri", "OutputFormat" ], "members":{ "ClusterId":{"shape":"RedshiftClusterId"}, "Database":{"shape":"RedshiftDatabase"}, "DbUser":{"shape":"RedshiftUserName"}, "QueryString":{"shape":"RedshiftQueryString"}, "ClusterRoleArn":{ "shape":"RoleArn", "documentation":"The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
" }, "OutputS3Uri":{ "shape":"S3Uri", "documentation":"The location in Amazon S3 where the Redshift query results are stored.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
" }, "OutputFormat":{"shape":"RedshiftResultFormat"}, "OutputCompression":{"shape":"RedshiftResultCompressionType"} }, "documentation":"Configuration for Redshift Dataset Definition input.
" }, "RedshiftQueryString":{ "type":"string", "documentation":"The SQL query statements to be executed.
", "max":4096, "min":1, "pattern":"[\\s\\S]+" }, "RedshiftResultCompressionType":{ "type":"string", "documentation":"The compression used for Redshift query results.
", "enum":[ "None", "GZIP", "BZIP2", "ZSTD", "SNAPPY" ] }, "RedshiftResultFormat":{ "type":"string", "documentation":"The data storage format for Redshift query results.
", "enum":[ "PARQUET", "CSV" ] }, "RedshiftUserName":{ "type":"string", "documentation":"The database user name used in Redshift query execution.
", "max":128, "min":1, "pattern":".*" }, "RegisterDevicesRequest":{ "type":"structure", "required":[ "DeviceFleetName", "Devices" ], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" }, "Devices":{ "shape":"Devices", "documentation":"A list of devices to register with SageMaker Edge Manager.
" }, "Tags":{ "shape":"TagList", "documentation":"The tags associated with devices.
" } } }, "RegisterModelStepMetadata":{ "type":"structure", "members":{ "Arn":{ "shape":"String256", "documentation":"The Amazon Resource Name (ARN) of the model package.
" } }, "documentation":"Metadata for a register model job step.
" }, "RenderUiTemplateRequest":{ "type":"structure", "required":[ "Task", "RoleArn" ], "members":{ "UiTemplate":{ "shape":"UiTemplate", "documentation":"A Template object containing the worker UI template to render.
A RenderableTask object containing a representative task to render.
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
" }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.
See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.
" } } }, "RenderUiTemplateResponse":{ "type":"structure", "required":[ "RenderedContent", "Errors" ], "members":{ "RenderedContent":{ "shape":"String", "documentation":"A Liquid template that renders the HTML for the worker UI.
" }, "Errors":{ "shape":"RenderingErrorList", "documentation":"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.
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\".
Contains input values for a task.
" }, "RenderingError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"A unique identifier for a specific class of errors.
" }, "Message":{ "shape":"String", "documentation":"A human-readable message describing the error.
" } }, "documentation":"A description of an error that occurred while rendering the template.
" }, "RenderingErrorList":{ "type":"list", "member":{"shape":"RenderingError"} }, "RepositoryAccessMode":{ "type":"string", "enum":[ "Platform", "Vpc" ] }, "RepositoryAuthConfig":{ "type":"structure", "required":["RepositoryCredentialsProviderArn"], "members":{ "RepositoryCredentialsProviderArn":{ "shape":"RepositoryCredentialsProviderArn", "documentation":"The Amazon Resource Name (ARN) of an AWS Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an AWS Lambda function, see Create a Lambda function with the console in the AWS Lambda Developer Guide.
" } }, "documentation":"Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field of the ImageConfig object that you passed to a call to CreateModel and the private Docker registry where the model image is hosted requires authentication.
The problem type.
" }, "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"} }, "documentation":"The resolved attributes.
" }, "ResourceArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+" }, "ResourceConfig":{ "type":"structure", "required":[ "InstanceType", "InstanceCount", "VolumeSizeInGB" ], "members":{ "InstanceType":{ "shape":"TrainingInstanceType", "documentation":"The ML compute instance type.
" }, "InstanceCount":{ "shape":"TrainingInstanceCount", "documentation":"The number of ML compute instances to use. For distributed training, provide a value greater than 1.
" }, "VolumeSizeInGB":{ "shape":"VolumeSizeInGB", "documentation":"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.
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\"
Describes the resources, including ML compute instances and ML storage volumes, to use for model training.
" }, "ResourceId":{ "type":"string", "max":32 }, "ResourceInUse":{ "type":"structure", "members":{ "Message":{"shape":"FailureReason"} }, "documentation":"Resource being accessed is in use.
", "exception":true }, "ResourceLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"FailureReason"} }, "documentation":"You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
", "exception":true }, "ResourceLimits":{ "type":"structure", "required":[ "MaxNumberOfTrainingJobs", "MaxParallelTrainingJobs" ], "members":{ "MaxNumberOfTrainingJobs":{ "shape":"MaxNumberOfTrainingJobs", "documentation":"The maximum number of training jobs that a hyperparameter tuning job can launch.
" }, "MaxParallelTrainingJobs":{ "shape":"MaxParallelTrainingJobs", "documentation":"The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
" } }, "documentation":"Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.
" }, "ResourceNotFound":{ "type":"structure", "members":{ "Message":{"shape":"FailureReason"} }, "documentation":"Resource being access is not found.
", "exception":true }, "ResourcePropertyName":{ "type":"string", "max":255, "min":1, "pattern":".+" }, "ResourceSpec":{ "type":"structure", "members":{ "SageMakerImageArn":{ "shape":"ImageArn", "documentation":"The ARN of the SageMaker image that the image version belongs to.
" }, "SageMakerImageVersionArn":{ "shape":"ImageVersionArn", "documentation":"The ARN of the image version created on the instance.
" }, "InstanceType":{ "shape":"AppInstanceType", "documentation":"The instance type that the image version runs on.
" } }, "documentation":"Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
" }, "ResourceType":{ "type":"string", "enum":[ "TrainingJob", "Experiment", "ExperimentTrial", "ExperimentTrialComponent", "Endpoint", "ModelPackage", "ModelPackageGroup", "Pipeline", "PipelineExecution", "FeatureGroup" ] }, "ResponseMIMEType":{ "type":"string", "max":1024, "pattern":"^[-\\w]+\\/.+$" }, "ResponseMIMETypes":{ "type":"list", "member":{"shape":"ResponseMIMEType"} }, "RetentionPolicy":{ "type":"structure", "members":{ "HomeEfsFileSystem":{ "shape":"RetentionType", "documentation":"The default is Retain, which specifies to keep the data stored on the EFS volume.
Specify Delete to delete the data stored on the EFS volume.
The retention policy for data stored on an Amazon Elastic File System (EFS) volume.
" }, "RetentionType":{ "type":"string", "enum":[ "Retain", "Delete" ] }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "RootAccess":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "RuleConfigurationName":{ "type":"string", "max":256, "min":1, "pattern":".*" }, "RuleEvaluationStatus":{ "type":"string", "enum":[ "InProgress", "NoIssuesFound", "IssuesFound", "Error", "Stopping", "Stopped" ] }, "RuleParameters":{ "type":"map", "key":{"shape":"ConfigKey"}, "value":{"shape":"ConfigValue"}, "max":100, "min":0 }, "S3DataDistribution":{ "type":"string", "enum":[ "FullyReplicated", "ShardedByS3Key" ] }, "S3DataSource":{ "type":"structure", "required":[ "S3DataType", "S3Uri" ], "members":{ "S3DataType":{ "shape":"S3DataType", "documentation":"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.
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
A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
This JSON is equivalent to the following S3Uri list:
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 S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
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.
A list of one or more attribute names to use that are found in a specified augmented manifest file.
" } }, "documentation":"Describes the S3 data source.
" }, "S3DataType":{ "type":"string", "enum":[ "ManifestFile", "S3Prefix", "AugmentedManifestFile" ] }, "S3StorageConfig":{ "type":"structure", "required":["S3Uri"], "members":{ "S3Uri":{ "shape":"S3Uri", "documentation":"The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:
\"kms:GenerateDataKey\"
The S3 path where offline records are written.
" } }, "documentation":"The Amazon Simple Storage (Amazon S3) location and and security configuration for OfflineStore.
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.
Configuration details about the monitoring schedule.
" }, "ScheduleExpression":{ "type":"string", "max":256, "min":1 }, "ScheduleStatus":{ "type":"string", "enum":[ "Pending", "Failed", "Scheduled", "Stopped" ] }, "SearchExpression":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"A list of filter objects.
" }, "NestedFilters":{ "shape":"NestedFiltersList", "documentation":"A list of nested filter objects.
" }, "SubExpressions":{ "shape":"SearchExpressionList", "documentation":"A list of search expression objects.
" }, "Operator":{ "shape":"BooleanOperator", "documentation":"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.
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
A Boolean operator: And or Or.
The properties of a training job.
" }, "Experiment":{ "shape":"Experiment", "documentation":"The properties of an experiment.
" }, "Trial":{ "shape":"Trial", "documentation":"The properties of a trial.
" }, "TrialComponent":{ "shape":"TrialComponent", "documentation":"The properties of a trial component.
" }, "Endpoint":{"shape":"Endpoint"}, "ModelPackage":{"shape":"ModelPackage"}, "ModelPackageGroup":{"shape":"ModelPackageGroup"}, "Pipeline":{"shape":"Pipeline"}, "PipelineExecution":{"shape":"PipelineExecution"}, "FeatureGroup":{"shape":"FeatureGroup"} }, "documentation":"A single resource returned as part of the Search API response.
" }, "SearchRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceType", "documentation":"The name of the Amazon SageMaker resource to search for.
" }, "SearchExpression":{ "shape":"SearchExpression", "documentation":"A Boolean conditional statement. Resources 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.
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.
The maximum number of results to return.
", "box":true } } }, "SearchResponse":{ "type":"structure", "members":{ "Results":{ "shape":"SearchResultsList", "documentation":"A list of SearchRecord objects.
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.
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
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 - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
A timestamp that shows when the training job transitioned to the current secondary status state.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"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.
" }, "StatusMessage":{ "shape":"StatusMessage", "documentation":"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 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.
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
An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
" }, "SecondaryStatusTransitions":{ "type":"list", "member":{"shape":"SecondaryStatusTransition"} }, "SecretArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*" }, "SecurityGroupId":{ "type":"string", "max":32, "pattern":"[-0-9a-zA-Z]+" }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":5 }, "Seed":{"type":"long"}, "ServiceCatalogEntityId":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9_\\-]*" }, "ServiceCatalogProvisionedProductDetails":{ "type":"structure", "members":{ "ProvisionedProductId":{ "shape":"ServiceCatalogEntityId", "documentation":"The ID of the provisioned product.
" }, "ProvisionedProductStatusMessage":{ "shape":"ProvisionedProductStatusMessage", "documentation":"The current status of the product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
Details of a provisioned service catalog product. For information about service catalog, see What is AWS Service Catalog.
" }, "ServiceCatalogProvisioningDetails":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "ProductId":{ "shape":"ServiceCatalogEntityId", "documentation":"The ID of the product to provision.
" }, "ProvisioningArtifactId":{ "shape":"ServiceCatalogEntityId", "documentation":"The ID of the provisioning artifact.
" }, "PathId":{ "shape":"ServiceCatalogEntityId", "documentation":"The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
" }, "ProvisioningParameters":{ "shape":"ProvisioningParameters", "documentation":"A list of key value pairs that you specify when you provision a product.
" } }, "documentation":"Details that you specify to provision a service catalog product. For information about service catalog, see .What is AWS Service Catalog.
" }, "SessionExpirationDurationInSeconds":{ "type":"integer", "max":43200, "min":1800 }, "SharingSettings":{ "type":"structure", "members":{ "NotebookOutputOption":{ "shape":"NotebookOutputOption", "documentation":"Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.
Determines the shuffling order in ShuffleConfig value.
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. 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, when ShuffleConfig is specified 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, and 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.
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).
The model artifacts must be in an S3 bucket that is in the same region as the algorithm.
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.
" } }, "documentation":"Specifies 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.
" }, "SourceAlgorithmList":{ "type":"list", "member":{"shape":"SourceAlgorithm"}, "max":1, "min":1 }, "SourceAlgorithmSpecification":{ "type":"structure", "required":["SourceAlgorithms"], "members":{ "SourceAlgorithms":{ "shape":"SourceAlgorithmList", "documentation":"A list of the algorithms that were used to create a model package.
" } }, "documentation":"A list of algorithms that were used to create a model package.
" }, "SourceIpConfig":{ "type":"structure", "required":["Cidrs"], "members":{ "Cidrs":{ "shape":"Cidrs", "documentation":"A list of one to ten Classless Inter-Domain Routing (CIDR) values.
Maximum: Ten CIDR values
The following Length Constraints apply to individual CIDR values in the CIDR value list.
A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
" }, "SourceType":{ "type":"string", "max":128 }, "SourceUri":{ "type":"string", "max":2048, "pattern":".*" }, "SplitType":{ "type":"string", "enum":[ "None", "Line", "RecordIO", "TFRecord" ] }, "StartMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the schedule to start.
" } } }, "StartNotebookInstanceInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance to start.
" } } }, "StartPipelineExecutionRequest":{ "type":"structure", "required":[ "PipelineName", "ClientRequestToken" ], "members":{ "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline.
" }, "PipelineExecutionDisplayName":{ "shape":"PipelineExecutionName", "documentation":"The display name of the pipeline execution.
" }, "PipelineParameters":{ "shape":"ParameterList", "documentation":"Contains a list of pipeline parameters. This list can be empty.
" }, "PipelineExecutionDescription":{ "shape":"PipelineExecutionDescription", "documentation":"The description of the pipeline execution.
" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "idempotencyToken":true } } }, "StartPipelineExecutionResponse":{ "type":"structure", "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" } } }, "StatusDetails":{ "type":"string", "max":1024, "pattern":".*" }, "StatusMessage":{"type":"string"}, "StepName":{ "type":"string", "max":256, "pattern":".*" }, "StepStatus":{ "type":"string", "enum":[ "Starting", "Executing", "Stopping", "Stopped", "Failed", "Succeeded" ] }, "StopAutoMLJobRequest":{ "type":"structure", "required":["AutoMLJobName"], "members":{ "AutoMLJobName":{ "shape":"AutoMLJobName", "documentation":"The name of the object you are requesting.
" } } }, "StopCompilationJobRequest":{ "type":"structure", "required":["CompilationJobName"], "members":{ "CompilationJobName":{ "shape":"EntityName", "documentation":"The name of the model compilation job to stop.
" } } }, "StopEdgePackagingJobRequest":{ "type":"structure", "required":["EdgePackagingJobName"], "members":{ "EdgePackagingJobName":{ "shape":"EntityName", "documentation":"The name of the edge packaging job.
" } } }, "StopHyperParameterTuningJobRequest":{ "type":"structure", "required":["HyperParameterTuningJobName"], "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", "documentation":"The name of the tuning job to stop.
" } } }, "StopLabelingJobRequest":{ "type":"structure", "required":["LabelingJobName"], "members":{ "LabelingJobName":{ "shape":"LabelingJobName", "documentation":"The name of the labeling job to stop.
" } } }, "StopMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the schedule to stop.
" } } }, "StopNotebookInstanceInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance to terminate.
" } } }, "StopPipelineExecutionRequest":{ "type":"structure", "required":[ "PipelineExecutionArn", "ClientRequestToken" ], "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" }, "ClientRequestToken":{ "shape":"IdempotencyToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
", "idempotencyToken":true } } }, "StopPipelineExecutionResponse":{ "type":"structure", "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" } } }, "StopProcessingJobRequest":{ "type":"structure", "required":["ProcessingJobName"], "members":{ "ProcessingJobName":{ "shape":"ProcessingJobName", "documentation":"The name of the processing job to stop.
" } } }, "StopTrainingJobRequest":{ "type":"structure", "required":["TrainingJobName"], "members":{ "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"The name of the training job to stop.
" } } }, "StopTransformJobRequest":{ "type":"structure", "required":["TransformJobName"], "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job to stop.
" } } }, "StoppingCondition":{ "type":"structure", "members":{ "MaxRuntimeInSeconds":{ "shape":"MaxRuntimeInSeconds", "documentation":"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.
" }, "MaxWaitTimeInSeconds":{ "shape":"MaxWaitTimeInSeconds", "documentation":"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.
Specifies a limit to how long a model training or compilation 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 time limit, Amazon SageMaker ends the training or compilation 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.
The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
The Amazon Resource Name (ARN) of the vendor that you have subscribed.
" }, "MarketplaceTitle":{ "shape":"String200", "documentation":"The title of the service provided by the vendor in the Amazon Marketplace.
" }, "SellerName":{ "shape":"String", "documentation":"The name of the vendor in the Amazon Marketplace.
" }, "MarketplaceDescription":{ "shape":"String200", "documentation":"The description of the vendor from the Amazon Marketplace.
" }, "ListingId":{ "shape":"String", "documentation":"Marketplace product listing ID.
" } }, "documentation":"Describes a work team of a vendor that does the a labelling job.
" }, "SubscribedWorkteams":{ "type":"list", "member":{"shape":"SubscribedWorkteam"} }, "Success":{"type":"boolean"}, "SuggestionQuery":{ "type":"structure", "members":{ "PropertyNameQuery":{ "shape":"PropertyNameQuery", "documentation":"Defines a property name hint. Only property names that begin with the specified hint are included in the response.
" } }, "documentation":"Specified in the GetSearchSuggestions request. Limits the property names that are included in the response.
" }, "TableName":{ "type":"string", "max":255, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"The tag key.
" }, "Value":{ "shape":"TagValue", "documentation":"The tag value.
" } }, "documentation":"Describes a tag.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TargetAttributeName":{ "type":"string", "min":1 }, "TargetDevice":{ "type":"string", "enum":[ "lambda", "ml_m4", "ml_m5", "ml_c4", "ml_c5", "ml_p2", "ml_p3", "ml_g4dn", "ml_inf1", "ml_eia2", "jetson_tx1", "jetson_tx2", "jetson_nano", "jetson_xavier", "rasp3b", "imx8qm", "deeplens", "rk3399", "rk3288", "aisage", "sbe_c", "qcs605", "qcs603", "sitara_am57x", "amba_cv22", "x86_win32", "x86_win64", "coreml", "jacinto_tda4vm" ] }, "TargetObjectiveMetricValue":{"type":"float"}, "TargetPlatform":{ "type":"structure", "required":[ "Os", "Arch" ], "members":{ "Os":{ "shape":"TargetPlatformOs", "documentation":"Specifies a target platform OS.
LINUX: Linux-based operating systems.
ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, \"CompilerOptions\": {'ANDROID_PLATFORM': 28}
Specifies a target platform architecture.
X86_64: 64-bit version of the x86 instruction set.
X86: 32-bit version of the x86 instruction set.
ARM64: ARMv8 64-bit CPU.
ARM_EABIHF: ARMv7 32-bit, Hard Float.
ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.
Specifies a target platform accelerator (optional).
NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options
MALI: ARM Mali graphics processor
INTEL_GRAPHICS: Integrated Intel graphics
Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" } }, "documentation":"The TensorBoard app settings.
" }, "TensorBoardOutputConfig":{ "type":"structure", "required":["S3OutputPath"], "members":{ "LocalPath":{ "shape":"DirectoryPath", "documentation":"Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
Path to Amazon S3 storage location for TensorBoard output.
" } }, "documentation":"Configuration of storage locations for the Debugger TensorBoard output data.
" }, "TenthFractionsOfACent":{ "type":"integer", "max":9, "min":0 }, "TerminationWaitInSeconds":{ "type":"integer", "max":3600, "min":0 }, "ThingName":{ "type":"string", "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, "Timestamp":{"type":"timestamp"}, "TrafficRoutingConfig":{ "type":"structure", "required":[ "Type", "WaitIntervalInSeconds" ], "members":{ "Type":{ "shape":"TrafficRoutingConfigType", "documentation":"" }, "WaitIntervalInSeconds":{ "shape":"WaitIntervalInSeconds", "documentation":"" }, "CanarySize":{ "shape":"CapacitySize", "documentation":"" } }, "documentation":"Currently, the TrafficRoutingConfig API is not supported.
The name of the training job.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" }, "TuningJobArn":{ "shape":"HyperParameterTuningJobArn", "documentation":"The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
" }, "LabelingJobArn":{ "shape":"LabelingJobArn", "documentation":"The Amazon Resource Name (ARN) of the labeling job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The Amazon Resource Name (ARN) of the job.
" }, "ModelArtifacts":{ "shape":"ModelArtifacts", "documentation":"Information about the Amazon S3 location that is configured for storing model artifacts.
" }, "TrainingJobStatus":{ "shape":"TrainingJobStatus", "documentation":"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.
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:
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 - The training job has completed.
Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
Stopped - The training job has stopped.
Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
If the training job failed, the reason it failed.
" }, "HyperParameters":{ "shape":"HyperParameters", "documentation":"Algorithm-specific parameters.
" }, "AlgorithmSpecification":{ "shape":"AlgorithmSpecification", "documentation":"Information about the algorithm used for training, and algorithm metadata.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The AWS Identity and Access Management (IAM) role configured for the training job.
" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"An array of Channel objects that describes each data input channel.
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
" }, "ResourceConfig":{ "shape":"ResourceConfig", "documentation":"Resources, including ML compute instances and ML storage volumes, that are configured for model training.
" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"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.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
A timestamp that indicates when the training job was created.
" }, "TrainingStartTime":{ "shape":"Timestamp", "documentation":"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.
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.
A timestamp that indicates when the status of the training job was last modified.
" }, "SecondaryStatusTransitions":{ "shape":"SecondaryStatusTransitions", "documentation":"A history of all of the secondary statuses that the training job has transitioned through.
" }, "FinalMetricDataList":{ "shape":"FinalMetricDataList", "documentation":"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.
" }, "EnableNetworkIsolation":{ "shape":"Boolean", "documentation":"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.
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.
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.
" }, "CheckpointConfig":{"shape":"CheckpointConfig"}, "TrainingTimeInSeconds":{ "shape":"TrainingTimeInSeconds", "documentation":"The training time in seconds.
" }, "BillableTimeInSeconds":{ "shape":"BillableTimeInSeconds", "documentation":"The billable time in seconds.
" }, "DebugHookConfig":{"shape":"DebugHookConfig"}, "ExperimentConfig":{"shape":"ExperimentConfig"}, "DebugRuleConfigurations":{ "shape":"DebugRuleConfigurations", "documentation":"Information about the debug rule configuration.
" }, "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, "DebugRuleEvaluationStatuses":{ "shape":"DebugRuleEvaluationStatuses", "documentation":"Information about the evaluation status of the rules for the training job.
" }, "Tags":{ "shape":"TagList", "documentation":"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 Tagging AWS Resources.
" } }, "documentation":"Contains information about a training job.
" }, "TrainingJobArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*" }, "TrainingJobDefinition":{ "type":"structure", "required":[ "TrainingInputMode", "InputDataConfig", "OutputDataConfig", "ResourceConfig", "StoppingCondition" ], "members":{ "TrainingInputMode":{ "shape":"TrainingInputMode", "documentation":"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.
The hyperparameters used for the training job.
" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"An array of Channel objects, each of which specifies an input source.
the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.
" }, "ResourceConfig":{ "shape":"ResourceConfig", "documentation":"The resources, including the ML compute instances and ML storage volumes, to use for model training.
" }, "StoppingCondition":{ "shape":"StoppingCondition", "documentation":"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.
" } }, "documentation":"Defines the input needed to run a training job using the algorithm.
" }, "TrainingJobEarlyStoppingType":{ "type":"string", "enum":[ "Off", "Auto" ] }, "TrainingJobName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "TrainingJobSortByOptions":{ "type":"string", "enum":[ "Name", "CreationTime", "Status", "FinalObjectiveMetricValue" ] }, "TrainingJobStatus":{ "type":"string", "enum":[ "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "TrainingJobStatusCounter":{ "type":"integer", "min":0 }, "TrainingJobStatusCounters":{ "type":"structure", "members":{ "Completed":{ "shape":"TrainingJobStatusCounter", "documentation":"The number of completed training jobs launched by the hyperparameter tuning job.
" }, "InProgress":{ "shape":"TrainingJobStatusCounter", "documentation":"The number of in-progress training jobs launched by a hyperparameter tuning job.
" }, "RetryableError":{ "shape":"TrainingJobStatusCounter", "documentation":"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.
" }, "NonRetryableError":{ "shape":"TrainingJobStatusCounter", "documentation":"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.
" }, "Stopped":{ "shape":"TrainingJobStatusCounter", "documentation":"The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
" } }, "documentation":"The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
" }, "TrainingJobStepMetadata":{ "type":"structure", "members":{ "Arn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job that was run by this step execution.
" } }, "documentation":"Metadata for a training job step.
" }, "TrainingJobSummaries":{ "type":"list", "member":{"shape":"TrainingJobSummary"} }, "TrainingJobSummary":{ "type":"structure", "required":[ "TrainingJobName", "TrainingJobArn", "CreationTime", "TrainingJobStatus" ], "members":{ "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"The name of the training job that you want a summary for.
" }, "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the training job was created.
" }, "TrainingEndTime":{ "shape":"Timestamp", "documentation":"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).
Timestamp when the training job was last modified.
" }, "TrainingJobStatus":{ "shape":"TrainingJobStatus", "documentation":"The status of the training job.
" } }, "documentation":"Provides summary information about a training job.
" }, "TrainingSpecification":{ "type":"structure", "required":[ "TrainingImage", "SupportedTrainingInstanceTypes", "TrainingChannels" ], "members":{ "TrainingImage":{ "shape":"ContainerImage", "documentation":"The Amazon ECR registry path of the Docker image that contains the training algorithm.
" }, "TrainingImageDigest":{ "shape":"ImageDigest", "documentation":"An MD5 hash of the training algorithm that identifies the Docker image used for training.
" }, "SupportedHyperParameters":{ "shape":"HyperParameterSpecifications", "documentation":"A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>
A list of the instance types that this algorithm can use for training.
" }, "SupportsDistributedTraining":{ "shape":"Boolean", "documentation":"Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
" }, "MetricDefinitions":{ "shape":"MetricDefinitionList", "documentation":"A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.
A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.
A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
" } }, "documentation":"Defines how the algorithm is used for a training job.
" }, "TrainingTimeInSeconds":{ "type":"integer", "min":1 }, "TransformDataSource":{ "type":"structure", "required":["S3DataSource"], "members":{ "S3DataSource":{ "shape":"TransformS3DataSource", "documentation":"The S3 location of the data source that is associated with a channel.
" } }, "documentation":"Describes the location of the channel data.
" }, "TransformEnvironmentKey":{ "type":"string", "max":1024, "pattern":"[a-zA-Z_][a-zA-Z0-9_]{0,1023}" }, "TransformEnvironmentMap":{ "type":"map", "key":{"shape":"TransformEnvironmentKey"}, "value":{"shape":"TransformEnvironmentValue"}, "max":16 }, "TransformEnvironmentValue":{ "type":"string", "max":10240, "pattern":"[\\S\\s]*" }, "TransformInput":{ "type":"structure", "required":["DataSource"], "members":{ "DataSource":{ "shape":"TransformDataSource", "documentation":"Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.
" }, "ContentType":{ "shape":"ContentType", "documentation":"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.
" }, "CompressionType":{ "shape":"CompressionType", "documentation":"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.
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. Currently, the supported record formats are:
RecordIO
TFRecord
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.
Describes the input source of a transform job and the way the transform job consumes it.
" }, "TransformInstanceCount":{ "type":"integer", "min":1 }, "TransformInstanceType":{ "type":"string", "enum":[ "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" ] }, "TransformInstanceTypes":{ "type":"list", "member":{"shape":"TransformInstanceType"}, "min":1 }, "TransformJob":{ "type":"structure", "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job.
" }, "TransformJobArn":{ "shape":"TransformJobArn", "documentation":"The Amazon Resource Name (ARN) of the transform job.
" }, "TransformJobStatus":{ "shape":"TransformJobStatus", "documentation":"The status of the transform job.
Transform job statuses are:
InProgress - The job is in progress.
Completed - The job has completed.
Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
Stopping - The transform job is stopping.
Stopped - The transform job has stopped.
If the transform job failed, the reason it failed.
" }, "ModelName":{ "shape":"ModelName", "documentation":"The name of the model associated with the transform job.
" }, "MaxConcurrentTransforms":{ "shape":"MaxConcurrentTransforms", "documentation":"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, 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 built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.
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, SageMaker built-in algorithms do not support HTTP chunked encoding.
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.
" }, "Environment":{ "shape":"TransformEnvironmentMap", "documentation":"The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" }, "TransformInput":{"shape":"TransformInput"}, "TransformOutput":{"shape":"TransformOutput"}, "TransformResources":{"shape":"TransformResources"}, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the transform Job was created.
" }, "TransformStartTime":{ "shape":"Timestamp", "documentation":"Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
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.
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
" }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", "documentation":"The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
" }, "DataProcessing":{"shape":"DataProcessing"}, "ExperimentConfig":{"shape":"ExperimentConfig"}, "Tags":{ "shape":"TagList", "documentation":"A list of tags associated with the transform job.
" } }, "documentation":"A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.
" }, "TransformJobArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*" }, "TransformJobDefinition":{ "type":"structure", "required":[ "TransformInput", "TransformOutput", "TransformResources" ], "members":{ "MaxConcurrentTransforms":{ "shape":"MaxConcurrentTransforms", "documentation":"The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
" }, "MaxPayloadInMB":{ "shape":"MaxPayloadInMB", "documentation":"The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
" }, "BatchStrategy":{ "shape":"BatchStrategy", "documentation":"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.
The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.
" }, "TransformInput":{ "shape":"TransformInput", "documentation":"A description of the input source and the way the transform job consumes it.
" }, "TransformOutput":{ "shape":"TransformOutput", "documentation":"Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
" }, "TransformResources":{ "shape":"TransformResources", "documentation":"Identifies the ML compute instances for the transform job.
" } }, "documentation":"Defines the input needed to run a transform job using the inference specification specified in the algorithm.
" }, "TransformJobName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "TransformJobStatus":{ "type":"string", "enum":[ "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "TransformJobStepMetadata":{ "type":"structure", "members":{ "Arn":{ "shape":"TransformJobArn", "documentation":"The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
" } }, "documentation":"Metadata for a transform job step.
" }, "TransformJobSummaries":{ "type":"list", "member":{"shape":"TransformJobSummary"} }, "TransformJobSummary":{ "type":"structure", "required":[ "TransformJobName", "TransformJobArn", "CreationTime", "TransformJobStatus" ], "members":{ "TransformJobName":{ "shape":"TransformJobName", "documentation":"The name of the transform job.
" }, "TransformJobArn":{ "shape":"TransformJobArn", "documentation":"The Amazon Resource Name (ARN) of the transform job.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"A timestamp that shows when the transform Job was created.
" }, "TransformEndTime":{ "shape":"Timestamp", "documentation":"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.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Indicates when the transform job was last modified.
" }, "TransformJobStatus":{ "shape":"TransformJobStatus", "documentation":"The status of the transform job.
" }, "FailureReason":{ "shape":"FailureReason", "documentation":"If the transform job failed, the reason it failed.
" } }, "documentation":"Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.
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.
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.
" }, "AssembleWith":{ "shape":"AssemblyType", "documentation":"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.
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.
" } }, "documentation":"Describes the results of a transform job.
" }, "TransformResources":{ "type":"structure", "required":[ "InstanceType", "InstanceCount" ], "members":{ "InstanceType":{ "shape":"TransformInstanceType", "documentation":"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.
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.
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
Describes the resources, including ML instance types and ML instance count, to use for transform job.
" }, "TransformS3DataSource":{ "type":"structure", "required":[ "S3DataType", "S3Uri" ], "members":{ "S3DataType":{ "shape":"S3DataType", "documentation":"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
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.
Describes the S3 data source.
" }, "Trial":{ "type":"structure", "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial.
" }, "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
The name of the experiment the trial is part of.
" }, "Source":{"shape":"TrialSource"}, "CreationTime":{ "shape":"Timestamp", "documentation":"When the trial was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"Who last modified the trial.
" }, "LastModifiedBy":{"shape":"UserContext"}, "MetadataProperties":{"shape":"MetadataProperties"}, "Tags":{ "shape":"TagList", "documentation":"The list of tags that are associated with the trial. You can use Search API to search on the tags.
" }, "TrialComponentSummaries":{ "shape":"TrialComponentSimpleSummaries", "documentation":"A list of the components associated with the trial. For each component, a summary of the component's properties is included.
" } }, "documentation":"The properties of a trial as returned by the Search API.
" }, "TrialArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*" }, "TrialComponent":{ "type":"structure", "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial component.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The Amazon Resource Name (ARN) of the trial component.
" }, "Source":{ "shape":"TrialComponentSource", "documentation":"The Amazon Resource Name (ARN) and job type of the source of the component.
" }, "Status":{"shape":"TrialComponentStatus"}, "StartTime":{ "shape":"Timestamp", "documentation":"When the component started.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"When the component ended.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the component was created.
" }, "CreatedBy":{"shape":"UserContext"}, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the component was last modified.
" }, "LastModifiedBy":{"shape":"UserContext"}, "Parameters":{ "shape":"TrialComponentParameters", "documentation":"The hyperparameters of the component.
" }, "InputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The input artifacts of the component.
" }, "OutputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"The output artifacts of the component.
" }, "Metrics":{ "shape":"TrialComponentMetricSummaries", "documentation":"The metrics for the component.
" }, "MetadataProperties":{"shape":"MetadataProperties"}, "SourceDetail":{ "shape":"TrialComponentSourceDetail", "documentation":"Details of the source of the component.
" }, "Tags":{ "shape":"TagList", "documentation":"The list of tags that are associated with the component. You can use Search API to search on the tags.
" }, "Parents":{ "shape":"Parents", "documentation":"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.
" } }, "documentation":"The properties of a trial component as returned by the Search API.
" }, "TrialComponentArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*" }, "TrialComponentArtifact":{ "type":"structure", "required":["Value"], "members":{ "MediaType":{ "shape":"MediaType", "documentation":"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.
" }, "Value":{ "shape":"TrialComponentArtifactValue", "documentation":"The location of the artifact.
" } }, "documentation":"Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.
Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.
" }, "TrialComponentArtifactValue":{ "type":"string", "max":2048, "pattern":".*" }, "TrialComponentArtifacts":{ "type":"map", "key":{"shape":"TrialComponentKey64"}, "value":{"shape":"TrialComponentArtifact"}, "max":30 }, "TrialComponentKey256":{ "type":"string", "max":256, "pattern":".*" }, "TrialComponentKey64":{ "type":"string", "max":64, "pattern":".*" }, "TrialComponentMetricSummaries":{ "type":"list", "member":{"shape":"TrialComponentMetricSummary"} }, "TrialComponentMetricSummary":{ "type":"structure", "members":{ "MetricName":{ "shape":"MetricName", "documentation":"The name of the metric.
" }, "SourceArn":{ "shape":"TrialComponentSourceArn", "documentation":"The Amazon Resource Name (ARN) of the source.
" }, "TimeStamp":{ "shape":"Timestamp", "documentation":"When the metric was last updated.
" }, "Max":{ "shape":"OptionalDouble", "documentation":"The maximum value of the metric.
" }, "Min":{ "shape":"OptionalDouble", "documentation":"The minimum value of the metric.
" }, "Last":{ "shape":"OptionalDouble", "documentation":"The most recent value of the metric.
" }, "Count":{ "shape":"OptionalInteger", "documentation":"The number of samples used to generate the metric.
" }, "Avg":{ "shape":"OptionalDouble", "documentation":"The average value of the metric.
" }, "StdDev":{ "shape":"OptionalDouble", "documentation":"The standard deviation of the metric.
" } }, "documentation":"A summary of the metrics of a trial component.
" }, "TrialComponentParameterValue":{ "type":"structure", "members":{ "StringValue":{ "shape":"StringParameterValue", "documentation":"The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.
This object is specified in the CreateTrialComponent request.
" }, "TrialComponentParameters":{ "type":"map", "key":{"shape":"TrialComponentKey256"}, "value":{"shape":"TrialComponentParameterValue"}, "max":150 }, "TrialComponentPrimaryStatus":{ "type":"string", "enum":[ "InProgress", "Completed", "Failed", "Stopping", "Stopped" ] }, "TrialComponentSimpleSummaries":{ "type":"list", "member":{"shape":"TrialComponentSimpleSummary"} }, "TrialComponentSimpleSummary":{ "type":"structure", "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial component.
" }, "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the trial component.
" }, "TrialComponentSource":{"shape":"TrialComponentSource"}, "CreationTime":{ "shape":"Timestamp", "documentation":"When the component was created.
" }, "CreatedBy":{"shape":"UserContext"} }, "documentation":"A short summary of a trial component.
" }, "TrialComponentSource":{ "type":"structure", "required":["SourceArn"], "members":{ "SourceArn":{ "shape":"TrialComponentSourceArn", "documentation":"The source ARN.
" }, "SourceType":{ "shape":"SourceType", "documentation":"The source job type.
" } }, "documentation":"The Amazon Resource Name (ARN) and job type of the source of a trial component.
" }, "TrialComponentSourceArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "TrialComponentSourceDetail":{ "type":"structure", "members":{ "SourceArn":{ "shape":"TrialComponentSourceArn", "documentation":"The Amazon Resource Name (ARN) of the source.
" }, "TrainingJob":{ "shape":"TrainingJob", "documentation":"Information about a training job that's the source of a trial component.
" }, "ProcessingJob":{ "shape":"ProcessingJob", "documentation":"Information about a processing job that's the source of a trial component.
" }, "TransformJob":{ "shape":"TransformJob", "documentation":"Information about a transform job that's the source of a trial component.
" } }, "documentation":"Detailed information about the source of a trial component. Either ProcessingJob or TrainingJob is returned.
The status of the trial component.
" }, "Message":{ "shape":"TrialComponentStatusMessage", "documentation":"If the component failed, a message describing why.
" } }, "documentation":"The status of the trial component.
" }, "TrialComponentStatusMessage":{ "type":"string", "max":1024, "pattern":".*" }, "TrialComponentSummaries":{ "type":"list", "member":{"shape":"TrialComponentSummary"} }, "TrialComponentSummary":{ "type":"structure", "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial component.
" }, "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The ARN of the trial component.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The status of the component. States include:
InProgress
Completed
Failed
When the component started.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"When the component ended.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"When the component was created.
" }, "CreatedBy":{ "shape":"UserContext", "documentation":"Who created the component.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the component was last modified.
" }, "LastModifiedBy":{ "shape":"UserContext", "documentation":"Who last modified the component.
" } }, "documentation":"A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.
The Amazon Resource Name (ARN) of the source.
" }, "SourceType":{ "shape":"SourceType", "documentation":"The source job type.
" } }, "documentation":"The source of the trial.
" }, "TrialSourceArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "TrialSummaries":{ "type":"list", "member":{"shape":"TrialSummary"} }, "TrialSummary":{ "type":"structure", "members":{ "TrialArn":{ "shape":"TrialArn", "documentation":"The Amazon Resource Name (ARN) of the trial.
" }, "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
When the trial was created.
" }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"When the trial was last modified.
" } }, "documentation":"A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.
The value of the objective metric.
" } }, "documentation":"The job completion criteria.
" }, "USD":{ "type":"structure", "members":{ "Dollars":{ "shape":"Dollars", "documentation":"The whole number of dollars in the amount.
" }, "Cents":{ "shape":"Cents", "documentation":"The fractional portion, in cents, of the amount.
" }, "TenthFractionsOfACent":{ "shape":"TenthFractionsOfACent", "documentation":"Fractions of a cent, in tenths.
" } }, "documentation":"Represents an amount of money in United States dollars/
" }, "UiConfig":{ "type":"structure", "members":{ "UiTemplateS3Uri":{ "shape":"S3Uri", "documentation":"The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
" }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", "documentation":"The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.
Use this parameter when you are creating a labeling job for 3D point cloud and video fram labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the AWS region you are creating your labeling job in.
3D Point Cloud HumanTaskUiArns
Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection
Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking
Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation
Video Frame HumanTaskUiArns
Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.
arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection
Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.
arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking
Provided configuration information for the worker UI for a labeling job.
" }, "UiTemplate":{ "type":"structure", "required":["Content"], "members":{ "Content":{ "shape":"TemplateContent", "documentation":"The content of the Liquid template for the worker user interface.
" } }, "documentation":"The Liquid template for the worker user interface.
" }, "UiTemplateInfo":{ "type":"structure", "members":{ "Url":{ "shape":"TemplateUrl", "documentation":"The URL for the user interface template.
" }, "ContentSha256":{ "shape":"TemplateContentSha256", "documentation":"The SHA-256 digest of the contents of the template.
" } }, "documentation":"Container for user interface template information.
" }, "UpdateActionRequest":{ "type":"structure", "required":["ActionName"], "members":{ "ActionName":{ "shape":"ExperimentEntityName", "documentation":"The name of the action to update.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The new description for the action.
" }, "Status":{ "shape":"ActionStatus", "documentation":"The new status for the action.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"The new list of properties. Overwrites the current property list.
" }, "PropertiesToRemove":{ "shape":"ListLineageEntityParameterKey", "documentation":"A list of properties to remove.
" } } }, "UpdateActionResponse":{ "type":"structure", "members":{ "ActionArn":{ "shape":"ActionArn", "documentation":"The Amazon Resource Name (ARN) of the action.
" } } }, "UpdateAppImageConfigRequest":{ "type":"structure", "required":["AppImageConfigName"], "members":{ "AppImageConfigName":{ "shape":"AppImageConfigName", "documentation":"The name of the AppImageConfig to update.
" }, "KernelGatewayImageConfig":{ "shape":"KernelGatewayImageConfig", "documentation":"The new KernelGateway app to run on the image.
" } } }, "UpdateAppImageConfigResponse":{ "type":"structure", "members":{ "AppImageConfigArn":{ "shape":"AppImageConfigArn", "documentation":"The Amazon Resource Name (ARN) for the AppImageConfig.
" } } }, "UpdateArtifactRequest":{ "type":"structure", "required":["ArtifactArn"], "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact to update.
" }, "ArtifactName":{ "shape":"ExperimentEntityName", "documentation":"The new name for the artifact.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"The new list of properties. Overwrites the current property list.
" }, "PropertiesToRemove":{ "shape":"ListLineageEntityParameterKey", "documentation":"A list of properties to remove.
" } } }, "UpdateArtifactResponse":{ "type":"structure", "members":{ "ArtifactArn":{ "shape":"ArtifactArn", "documentation":"The Amazon Resource Name (ARN) of the artifact.
" } } }, "UpdateCodeRepositoryInput":{ "type":"structure", "required":["CodeRepositoryName"], "members":{ "CodeRepositoryName":{ "shape":"EntityName", "documentation":"The name of the Git repository to update.
" }, "GitConfig":{ "shape":"GitConfigForUpdate", "documentation":"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}
The ARN of the Git repository.
" } } }, "UpdateContextRequest":{ "type":"structure", "required":["ContextName"], "members":{ "ContextName":{ "shape":"ExperimentEntityName", "documentation":"The name of the context to update.
" }, "Description":{ "shape":"ExperimentDescription", "documentation":"The new description for the context.
" }, "Properties":{ "shape":"LineageEntityParameters", "documentation":"The new list of properties. Overwrites the current property list.
" }, "PropertiesToRemove":{ "shape":"ListLineageEntityParameterKey", "documentation":"A list of properties to remove.
" } } }, "UpdateContextResponse":{ "type":"structure", "members":{ "ContextArn":{ "shape":"ContextArn", "documentation":"The Amazon Resource Name (ARN) of the context.
" } } }, "UpdateDeviceFleetRequest":{ "type":"structure", "required":[ "DeviceFleetName", "OutputConfig" ], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the device.
" }, "Description":{ "shape":"DeviceFleetDescription", "documentation":"Description of the fleet.
" }, "OutputConfig":{ "shape":"EdgeOutputConfig", "documentation":"Output configuration for storing sample data collected by the fleet.
" } } }, "UpdateDevicesRequest":{ "type":"structure", "required":[ "DeviceFleetName", "Devices" ], "members":{ "DeviceFleetName":{ "shape":"EntityName", "documentation":"The name of the fleet the devices belong to.
" }, "Devices":{ "shape":"Devices", "documentation":"List of devices to register with Edge Manager agent.
" } } }, "UpdateDomainRequest":{ "type":"structure", "required":["DomainId"], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The ID of the domain to be updated.
" }, "DefaultUserSettings":{ "shape":"UserSettings", "documentation":"A collection of settings.
" } } }, "UpdateDomainResponse":{ "type":"structure", "members":{ "DomainArn":{ "shape":"DomainArn", "documentation":"The Amazon Resource Name (ARN) of the domain.
" } } }, "UpdateEndpointInput":{ "type":"structure", "required":[ "EndpointName", "EndpointConfigName" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of the endpoint whose configuration you want to update.
" }, "EndpointConfigName":{ "shape":"EndpointConfigName", "documentation":"The name of the new endpoint configuration.
" }, "RetainAllVariantProperties":{ "shape":"Boolean", "documentation":"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. The default is false.
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.
The deployment configuration for the endpoint to be updated.
" } } }, "UpdateEndpointOutput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the endpoint.
" } } }, "UpdateEndpointWeightsAndCapacitiesInput":{ "type":"structure", "required":[ "EndpointName", "DesiredWeightsAndCapacities" ], "members":{ "EndpointName":{ "shape":"EndpointName", "documentation":"The name of an existing Amazon SageMaker endpoint.
" }, "DesiredWeightsAndCapacities":{ "shape":"DesiredWeightAndCapacityList", "documentation":"An object that provides new capacity and weight values for a variant.
" } } }, "UpdateEndpointWeightsAndCapacitiesOutput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"EndpointArn", "documentation":"The Amazon Resource Name (ARN) of the updated endpoint.
" } } }, "UpdateExperimentRequest":{ "type":"structure", "required":["ExperimentName"], "members":{ "ExperimentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment to update.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.
The description of the experiment.
" } } }, "UpdateExperimentResponse":{ "type":"structure", "members":{ "ExperimentArn":{ "shape":"ExperimentArn", "documentation":"The Amazon Resource Name (ARN) of the experiment.
" } } }, "UpdateImageRequest":{ "type":"structure", "required":["ImageName"], "members":{ "DeleteProperties":{ "shape":"ImageDeletePropertyList", "documentation":"A list of properties to delete. Only the Description and DisplayName properties can be deleted.
The new description for the image.
" }, "DisplayName":{ "shape":"ImageDisplayName", "documentation":"The new display name for the image.
" }, "ImageName":{ "shape":"ImageName", "documentation":"The name of the image to update.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
" } } }, "UpdateImageResponse":{ "type":"structure", "members":{ "ImageArn":{ "shape":"ImageArn", "documentation":"The Amazon Resource Name (ARN) of the image.
" } } }, "UpdateModelPackageInput":{ "type":"structure", "required":[ "ModelPackageArn", "ModelApprovalStatus" ], "members":{ "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the model.
" }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", "documentation":"The approval status of the model.
" }, "ApprovalDescription":{ "shape":"ApprovalDescription", "documentation":"A description for the approval status of the model.
" } } }, "UpdateModelPackageOutput":{ "type":"structure", "required":["ModelPackageArn"], "members":{ "ModelPackageArn":{ "shape":"ModelPackageArn", "documentation":"The Amazon Resource Name (ARN) of the model.
" } } }, "UpdateMonitoringScheduleRequest":{ "type":"structure", "required":[ "MonitoringScheduleName", "MonitoringScheduleConfig" ], "members":{ "MonitoringScheduleName":{ "shape":"MonitoringScheduleName", "documentation":"The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account.
" }, "MonitoringScheduleConfig":{ "shape":"MonitoringScheduleConfig", "documentation":"The configuration object that specifies the monitoring schedule and defines the monitoring job.
" } } }, "UpdateMonitoringScheduleResponse":{ "type":"structure", "required":["MonitoringScheduleArn"], "members":{ "MonitoringScheduleArn":{ "shape":"MonitoringScheduleArn", "documentation":"The Amazon Resource Name (ARN) of the monitoring schedule.
" } } }, "UpdateNotebookInstanceInput":{ "type":"structure", "required":["NotebookInstanceName"], "members":{ "NotebookInstanceName":{ "shape":"NotebookInstanceName", "documentation":"The name of the notebook instance to update.
" }, "InstanceType":{ "shape":"InstanceType", "documentation":"The Amazon ML compute instance type.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"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.
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.
" }, "DisassociateLifecycleConfig":{ "shape":"DisassociateNotebookInstanceLifecycleConfig", "documentation":"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.
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.
" }, "DefaultCodeRepository":{ "shape":"CodeRepositoryNameOrUrl", "documentation":"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.
" }, "AdditionalCodeRepositories":{ "shape":"AdditionalCodeRepositoryNamesOrUrls", "documentation":"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.
" }, "AcceleratorTypes":{ "shape":"NotebookInstanceAcceleratorTypes", "documentation":"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.
" }, "DisassociateAcceleratorTypes":{ "shape":"DisassociateNotebookInstanceAcceleratorTypes", "documentation":"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.
" }, "DisassociateDefaultCodeRepository":{ "shape":"DisassociateDefaultCodeRepository", "documentation":"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.
" }, "DisassociateAdditionalCodeRepositories":{ "shape":"DisassociateAdditionalCodeRepositories", "documentation":"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.
" }, "RootAccess":{ "shape":"RootAccess", "documentation":"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.
The name of the lifecycle configuration.
" }, "OnCreate":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
" }, "OnStart":{ "shape":"NotebookInstanceLifecycleConfigList", "documentation":"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.
" } } }, "UpdateNotebookInstanceLifecycleConfigOutput":{ "type":"structure", "members":{ } }, "UpdateNotebookInstanceOutput":{ "type":"structure", "members":{ } }, "UpdatePipelineExecutionRequest":{ "type":"structure", "required":["PipelineExecutionArn"], "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the pipeline execution.
" }, "PipelineExecutionDescription":{ "shape":"PipelineExecutionDescription", "documentation":"The description of the pipeline execution.
" }, "PipelineExecutionDisplayName":{ "shape":"PipelineExecutionName", "documentation":"The display name of the pipeline execution.
" } } }, "UpdatePipelineExecutionResponse":{ "type":"structure", "members":{ "PipelineExecutionArn":{ "shape":"PipelineExecutionArn", "documentation":"The Amazon Resource Name (ARN) of the updated pipeline execution.
" } } }, "UpdatePipelineRequest":{ "type":"structure", "required":["PipelineName"], "members":{ "PipelineName":{ "shape":"PipelineName", "documentation":"The name of the pipeline to update.
" }, "PipelineDisplayName":{ "shape":"PipelineName", "documentation":"The display name of the pipeline.
" }, "PipelineDefinition":{ "shape":"PipelineDefinition", "documentation":"The JSON pipeline definition.
" }, "PipelineDescription":{ "shape":"PipelineDescription", "documentation":"The description of the pipeline.
" }, "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) that the pipeline uses to execute.
" } } }, "UpdatePipelineResponse":{ "type":"structure", "members":{ "PipelineArn":{ "shape":"PipelineArn", "documentation":"The Amazon Resource Name (ARN) of the updated pipeline.
" } } }, "UpdateTrainingJobRequest":{ "type":"structure", "required":["TrainingJobName"], "members":{ "TrainingJobName":{ "shape":"TrainingJobName", "documentation":"The name of a training job to update the Debugger profiling configuration.
" }, "ProfilerConfig":{ "shape":"ProfilerConfigForUpdate", "documentation":"Configuration information for Debugger system monitoring, framework profiling, and storage paths.
" }, "ProfilerRuleConfigurations":{ "shape":"ProfilerRuleConfigurations", "documentation":"Configuration information for Debugger rules for profiling system and framework metrics.
" } } }, "UpdateTrainingJobResponse":{ "type":"structure", "required":["TrainingJobArn"], "members":{ "TrainingJobArn":{ "shape":"TrainingJobArn", "documentation":"The Amazon Resource Name (ARN) of the training job.
" } } }, "UpdateTrialComponentRequest":{ "type":"structure", "required":["TrialComponentName"], "members":{ "TrialComponentName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component to update.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
The new status of the component.
" }, "StartTime":{ "shape":"Timestamp", "documentation":"When the component started.
" }, "EndTime":{ "shape":"Timestamp", "documentation":"When the component ended.
" }, "Parameters":{ "shape":"TrialComponentParameters", "documentation":"Replaces all of the component's hyperparameters with the specified hyperparameters.
" }, "ParametersToRemove":{ "shape":"ListTrialComponentKey256", "documentation":"The hyperparameters to remove from the component.
" }, "InputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"Replaces all of the component's input artifacts with the specified artifacts.
" }, "InputArtifactsToRemove":{ "shape":"ListTrialComponentKey256", "documentation":"The input artifacts to remove from the component.
" }, "OutputArtifacts":{ "shape":"TrialComponentArtifacts", "documentation":"Replaces all of the component's output artifacts with the specified artifacts.
" }, "OutputArtifactsToRemove":{ "shape":"ListTrialComponentKey256", "documentation":"The output artifacts to remove from the component.
" } } }, "UpdateTrialComponentResponse":{ "type":"structure", "members":{ "TrialComponentArn":{ "shape":"TrialComponentArn", "documentation":"The Amazon Resource Name (ARN) of the trial component.
" } } }, "UpdateTrialRequest":{ "type":"structure", "required":["TrialName"], "members":{ "TrialName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial to update.
" }, "DisplayName":{ "shape":"ExperimentEntityName", "documentation":"The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
The Amazon Resource Name (ARN) of the trial.
" } } }, "UpdateUserProfileRequest":{ "type":"structure", "required":[ "DomainId", "UserProfileName" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "UserSettings":{ "shape":"UserSettings", "documentation":"A collection of settings.
" } } }, "UpdateUserProfileResponse":{ "type":"structure", "members":{ "UserProfileArn":{ "shape":"UserProfileArn", "documentation":"The user profile Amazon Resource Name (ARN).
" } } }, "UpdateWorkforceRequest":{ "type":"structure", "required":["WorkforceName"], "members":{ "WorkforceName":{ "shape":"WorkforceName", "documentation":"The name of the private workforce that you want to update. You can find your workforce name by using the operation.
" }, "SourceIpConfig":{ "shape":"SourceIpConfig", "documentation":"A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
" }, "OidcConfig":{ "shape":"OidcConfig", "documentation":"Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
" } } }, "UpdateWorkforceResponse":{ "type":"structure", "required":["Workforce"], "members":{ "Workforce":{ "shape":"Workforce", "documentation":"A single private workforce. 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.
" } } }, "UpdateWorkteamRequest":{ "type":"structure", "required":["WorkteamName"], "members":{ "WorkteamName":{ "shape":"WorkteamName", "documentation":"The name of the work team to update.
" }, "MemberDefinitions":{ "shape":"MemberDefinitions", "documentation":"A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
An updated description for the work team.
" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"Configures SNS topic notifications for available or expiring work items
" } } }, "UpdateWorkteamResponse":{ "type":"structure", "required":["Workteam"], "members":{ "Workteam":{ "shape":"Workteam", "documentation":"A Workteam object that describes the updated work team.
The Amazon Resource Name (ARN) of the user's profile.
" }, "UserProfileName":{ "shape":"String", "documentation":"The name of the user's profile.
" }, "DomainId":{ "shape":"String", "documentation":"The domain associated with the user.
" } }, "documentation":"Information about the user who created or modified an experiment, trial, or trial component.
" }, "UserProfileArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*" }, "UserProfileDetails":{ "type":"structure", "members":{ "DomainId":{ "shape":"DomainId", "documentation":"The domain ID.
" }, "UserProfileName":{ "shape":"UserProfileName", "documentation":"The user profile name.
" }, "Status":{ "shape":"UserProfileStatus", "documentation":"The status.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The creation time.
" }, "LastModifiedTime":{ "shape":"LastModifiedTime", "documentation":"The last modified time.
" } }, "documentation":"The user profile details.
" }, "UserProfileList":{ "type":"list", "member":{"shape":"UserProfileDetails"} }, "UserProfileName":{ "type":"string", "max":63, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "UserProfileSortKey":{ "type":"string", "enum":[ "CreationTime", "LastModifiedTime" ] }, "UserProfileStatus":{ "type":"string", "enum":[ "Deleting", "Failed", "InService", "Pending", "Updating", "Update_Failed", "Delete_Failed" ] }, "UserSettings":{ "type":"structure", "members":{ "ExecutionRole":{ "shape":"RoleArn", "documentation":"The execution role for the user.
" }, "SecurityGroups":{ "shape":"SecurityGroupIds", "documentation":"The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
" }, "SharingSettings":{ "shape":"SharingSettings", "documentation":"The sharing settings.
" }, "JupyterServerAppSettings":{ "shape":"JupyterServerAppSettings", "documentation":"The Jupyter server's app settings.
" }, "KernelGatewayAppSettings":{ "shape":"KernelGatewayAppSettings", "documentation":"The kernel gateway app settings.
" }, "TensorBoardAppSettings":{ "shape":"TensorBoardAppSettings", "documentation":"The TensorBoard app settings.
" } }, "documentation":"A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.
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.)
Specifies a production variant property type for an Endpoint.
If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.
Subnets field."
},
"Subnets":{
"shape":"Subnets",
"documentation":"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.
" } }, "documentation":"Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" }, "VpcId":{ "type":"string", "max":32, "pattern":"[-0-9a-zA-Z]+" }, "VpcSecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":5, "min":1 }, "WaitIntervalInSeconds":{ "type":"integer", "max":3600, "min":0 }, "Workforce":{ "type":"structure", "required":[ "WorkforceName", "WorkforceArn" ], "members":{ "WorkforceName":{ "shape":"WorkforceName", "documentation":"The name of the private workforce.
" }, "WorkforceArn":{ "shape":"WorkforceArn", "documentation":"The Amazon Resource Name (ARN) of the private workforce.
" }, "LastUpdatedDate":{ "shape":"Timestamp", "documentation":"The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
" }, "SourceIpConfig":{ "shape":"SourceIpConfig", "documentation":"A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
" }, "SubDomain":{ "shape":"String", "documentation":"The subdomain for your OIDC Identity Provider.
" }, "CognitoConfig":{ "shape":"CognitoConfig", "documentation":"The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
" }, "OidcConfig":{ "shape":"OidcConfigForResponse", "documentation":"The configuration of an OIDC Identity Provider (IdP) private workforce.
" }, "CreateDate":{ "shape":"Timestamp", "documentation":"The date that the workforce is created.
" } }, "documentation":"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.
" }, "WorkforceArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*" }, "WorkforceName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9]([a-zA-Z0-9\\-]){0,62}$" }, "Workforces":{ "type":"list", "member":{"shape":"Workforce"} }, "Workteam":{ "type":"structure", "required":[ "WorkteamName", "MemberDefinitions", "WorkteamArn", "Description" ], "members":{ "WorkteamName":{ "shape":"WorkteamName", "documentation":"The name of the work team.
" }, "MemberDefinitions":{ "shape":"MemberDefinitions", "documentation":"A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.
The Amazon Resource Name (ARN) that identifies the work team.
" }, "WorkforceArn":{ "shape":"WorkforceArn", "documentation":"The Amazon Resource Name (ARN) of the workforce.
" }, "ProductListingIds":{ "shape":"ProductListings", "documentation":"The Amazon Marketplace identifier for a vendor's work team.
" }, "Description":{ "shape":"String200", "documentation":"A description of the work team.
" }, "SubDomain":{ "shape":"String", "documentation":"The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
" }, "CreateDate":{ "shape":"Timestamp", "documentation":"The date and time that the work team was created (timestamp).
" }, "LastUpdatedDate":{ "shape":"Timestamp", "documentation":"The date and time that the work team was last updated (timestamp).
" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"Configures SNS notifications of available or expiring work items for work teams.
" } }, "documentation":"Provides details about a labeling work team.
" }, "WorkteamArn":{ "type":"string", "max":256, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*" }, "WorkteamName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "Workteams":{ "type":"list", "member":{"shape":"Workteam"} } }, "documentation":"Provides APIs for creating and managing Amazon SageMaker resources.
Other Resources:
" }